is disabled. <burnicki@ntp.org>
* [Bug 3825] Don't touch HTML files unless building inside a BK repo.
Fix the script checkHtmlFileDates. <burnicki@ntp.org>
+* Update the copyright year. <stenn@ntp.org>
* Update ntp.conf documentation to add "delrestrict" and correct information
about KoD rate limiting. <hart@ntp.org>
* html/clockopt.html cleanup. <stenn@ntp.org>
+* util/lsf-times - added. <stenn@ntp.org>
* Add DSA, DSA-SHA, and SHA to tests/libntp/digests.c. <hart@ntp.org>
* Provide ntpd thread names to debugger on Windows. <hart@ntp.org>
* Remove dead code libntp/numtohost.c and its unit tests. <hart@ntp.org>
<h3>Copyright Notice</h3>
<img src="pic/sheepb.jpg" alt="jpg" align="left"> "Clone me," says Dolly sheepishly.
<p>Last update:
- <!-- #BeginDate format:En2m -->2-Mar-2023 05:21<!-- #EndDate -->
+ <!-- #BeginDate format:En2m -->7-Jan-2024 00:29<!-- #EndDate -->
UTC</p>
<br clear="left">
</p>
<pre>
***********************************************************************
* *
-* Copyright (c) Network Time Foundation 2011-2023 *
+* Copyright (c) Network Time Foundation 2011-2024 *
* *
* All Rights Reserved *
* *
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp.conf.texi)
#
-# It has been AutoGen-ed September 30, 2023 at 03:20:45 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:34:25 AM by AutoGen 5.18.16
# From the definitions ntp.conf.def
# and the template file agtexi-file.tpl
@end ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp.keys.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:37:41 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:34:27 AM by AutoGen 5.18.16
# From the definitions ntp.keys.def
# and the template file agtexi-file.tpl
@end ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpd.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:37:42 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:34:29 AM by AutoGen 5.18.16
# From the definitions ntpd-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp.conf 5man "30 Sep 2023" "4.2.8p17" "File Formats"
+.TH ntp.conf 5man "07 Jan 2024" "4.2.8p17" "File Formats"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed September 30, 2023 at 03:20:48 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:31 AM by AutoGen 5.18.16
.\" From the definitions ntp.conf.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The syntax checking is not picky; some combinations of
-.Dd September 30 2023
+.Dd January 7 2024
.Dt NTP_CONF 5mdoc File Formats
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
.\"
-.\" It has been AutoGen-ed September 30, 2023 at 03:20:43 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:20 AM by AutoGen 5.18.16
.\" From the definitions ntp.conf.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The syntax checking is not picky; some combinations of
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>NTP Configuration File User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntp_002econf-Description" rel="next" title="ntp.conf Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">NTP Configuration File User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002econf-Description" accesskey="n" rel="next">
ntp.conf 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>
+Next: <a href="#ntp_002econf-Description" accesskey="n" rel="next">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>
</div>
-<span id="NTP_0027s-Configuration-File-User-Manual"></span><h1 class="top">NTP’s Configuration File User Manual</h1>
+<h1 class="top" id="NTP_0027s-Configuration-File-User-Manual"><span>NTP’s Configuration File User Manual<a class="copiable-link" href="#NTP_0027s-Configuration-File-User-Manual"> ¶</a></span></h1>
<p>This document describes the configuration file for the NTP Project’s
-<code>ntpd</code> program.
+<code class="code">ntpd</code> program.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntp.conf</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntp.conf</code>.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntp_002econf-Description">1 Description</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Description" accesskey="1">ntp.conf Description</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Notes" accesskey="2">ntp.conf Notes</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="ntp_002econf-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntp_002econf-Description">
+<div class="nav-panel">
<p>
-Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Previous: <a href="#Top" accesskey="p" rel="prev">NTP’s Configuration File User Manual</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP’s Configuration File User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>The behavior of <code>ntpd</code> can be changed by a configuration file,
-by default <code>ntp.conf</code>.
+<p>The behavior of <code class="code">ntpd</code> can be changed by a configuration file,
+by default <code class="code">ntp.conf</code>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Notes" accesskey="1">Notes about ntp.conf</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#ntp_002econf-Notes" accesskey="1">Notes about ntp.conf</a></li>
+</ul>
<hr>
-<span id="ntp_002econf-Notes"></span><div class="header">
+<div class="section-level-extent" id="ntp_002econf-Notes">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002econf-Bugs" accesskey="p" rel="prev">ntp.conf Bugs</a>, Up: <a href="#ntp_002econf-Description" accesskey="u" rel="up">ntp.conf Description</a> </p>
+Up: <a href="#ntp_002econf-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Notes-about-ntp_002econf"></span><h3 class="section">1.1 Notes about ntp.conf</h3>
-<span id="index-ntp_002econf"></span>
-<span id="index-Network-Time-Protocol-_0028NTP_0029-daemon-configuration-file-format"></span>
+<h3 class="section" id="Notes-about-ntp_002econf"><span>1.1 Notes about ntp.conf<a class="copiable-link" href="#Notes-about-ntp_002econf"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntp_002econf"></a>
+<a class="index-entry-id" id="index-Network-Time-Protocol-_0028NTP_0029-daemon-configuration-file-format"></a>
<p>The
-<code>ntp.conf</code>
+<code class="code">ntp.conf</code>
configuration file is read at initial startup by the
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
daemon in order to specify the synchronization sources,
modes and other related information.
Usually, it is installed in the
-<samp>/etc</samp>
+<samp class="file">/etc</samp>
directory,
but could be installed elsewhere
(see the daemon’s
-<code>-c</code>
+<code class="code">-c</code>
command line option).
</p>
<p>The file format is similar to other
-<small>UNIX</small>
+<small class="sc">UNIX</small>
configuration files.
Comments begin with a
‘#’
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
+<samp class="file">/usr/share/doc/ntp</samp>)
contains an extended discussion of these options.
In addition to the discussion of general
‘Configuration Options’,
there are sections describing the following supported functionality
and the options used to control it:
-</p><ul>
-<li> <a href="#Authentication-Support">Authentication Support</a>
-</li><li> <a href="#Monitoring-Support">Monitoring Support</a>
-</li><li> <a href="#Access-Control-Support">Access Control Support</a>
-</li><li> <a href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
-</li><li> <a href="#Reference-Clock-Support">Reference Clock Support</a>
-</li><li> <a href="#Miscellaneous-Options">Miscellaneous Options</a>
+</p><ul class="itemize mark-bullet">
+<li><a class="ref" href="#Authentication-Support">Authentication Support</a>
+</li><li><a class="ref" href="#Monitoring-Support">Monitoring Support</a>
+</li><li><a class="ref" href="#Access-Control-Support">Access Control Support</a>
+</li><li><a class="ref" href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
+</li><li><a class="ref" href="#Reference-Clock-Support">Reference Clock Support</a>
+</li><li><a class="ref" href="#Miscellaneous-Options">Miscellaneous Options</a>
</li></ul>
<p>Following these is a section describing
-<a href="#Miscellaneous-Options">Miscellaneous Options</a>.
+<a class="ref" href="#Miscellaneous-Options">Miscellaneous Options</a>.
While there is a rich set of options available,
the only required option is one or more
-<code>pool</code>,
-<code>server</code>,
-<code>peer</code>,
-<code>broadcast</code>
+<code class="code">pool</code>,
+<code class="code">server</code>,
+<code class="code">peer</code>,
+<code class="code">broadcast</code>
or
-<code>manycastclient</code>
+<code class="code">manycastclient</code>
commands.
-</p><table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#Configuration-Support" accesskey="1">Configuration Support</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Authentication-Support" accesskey="2">Authentication Support</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Monitoring-Support" accesskey="3">Monitoring Support</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Access-Control-Support" accesskey="4">Access Control Support</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Automatic-NTP-Configuration-Options" accesskey="5">Automatic NTP Configuration Options</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Reference-Clock-Support" accesskey="6">Reference Clock Support</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Miscellaneous-Options" accesskey="7">Miscellaneous Options</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Files" accesskey="8">ntp.conf Files</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-See-Also" accesskey="9">ntp.conf See Also</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Bugs">ntp.conf Bugs</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• ntp.conf Notes</td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+</p><ul class="mini-toc">
+<li><a href="#Configuration-Support" accesskey="1">Configuration Support</a></li>
+<li><a href="#Authentication-Support" accesskey="2">Authentication Support</a></li>
+<li><a href="#Monitoring-Support" accesskey="3">Monitoring Support</a></li>
+<li><a href="#Access-Control-Support" accesskey="4">Access Control Support</a></li>
+<li><a href="#Automatic-NTP-Configuration-Options" accesskey="5">Automatic NTP Configuration Options</a></li>
+<li><a href="#Reference-Clock-Support" accesskey="6">Reference Clock Support</a></li>
+<li><a href="#Miscellaneous-Options" accesskey="7">Miscellaneous Options</a></li>
+<li><a href="#ntp_002econf-Files" accesskey="8">ntp.conf Files</a></li>
+<li><a href="#ntp_002econf-See-Also" accesskey="9">ntp.conf See Also</a></li>
+<li><a href="#ntp_002econf-Bugs">ntp.conf Bugs</a></li>
+<li>ntp.conf Notes</li>
+</ul>
<hr>
-<span id="Configuration-Support"></span><div class="header">
+<div class="subsection-level-extent" id="Configuration-Support">
+<div class="nav-panel">
<p>
-Next: <a href="#Authentication-Support" accesskey="n" rel="next">Authentication Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Authentication-Support" accesskey="n" rel="next">Authentication Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Configuration-Support-1"></span><h4 class="subsection">1.1.1 Configuration Support</h4>
+<h4 class="subsection" id="Configuration-Support-1"><span>1.1.1 Configuration Support<a class="copiable-link" href="#Configuration-Support-1"> ¶</a></span></h4>
<p>Following is a description of the configuration commands in
NTPv4.
These commands have the same basic functions as in NTPv3 and
persistent association with a remote server or peer or reference
clock, and auxiliary commands that specify environmental variables
that control various related operations.
-</p><span id="Configuration-Commands"></span><h4 class="subsubsection">1.1.1.1 Configuration Commands</h4>
+</p><ul class="mini-toc">
+<li><a href="#Configuration-Commands" accesskey="1">Configuration Commands</a></li>
+<li><a href="#Auxiliary-Commands" accesskey="2">Auxiliary Commands</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Configuration-Commands">
+<h4 class="subsubsection"><span>1.1.1.1 Configuration Commands<a class="copiable-link" href="#Configuration-Commands"> ¶</a></span></h4>
<p>The various modes are determined by the command keyword and the
type of the required IP address.
Addresses are classed by type as
is detected, support for the IPv6 address family is generated
in addition to the default support of the IPv4 address family.
In a few cases, including the
-<code>reslist</code>
+<code class="code">reslist</code>
billboard generated
by
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
or
-<code>ntpdc(1ntpdcmdoc)</code>,
+<code class="code">ntpdc(1ntpdcmdoc)</code>,
IPv6 addresses are automatically generated.
IPv6 addresses can be identified by the presence of colons
“:”
which are always IPv4.
</p>
<p>Note that in contexts where a host name is expected, a
-<code>-4</code>
+<code class="code">-4</code>
qualifier preceding
the host name forces DNS resolution to the IPv4 namespace,
while a
-<code>-6</code>
+<code class="code">-6</code>
qualifier forces DNS resolution to the IPv6 namespace.
See IPv6 references for the
equivalent classes for that address family.
-</p><dl compact="compact">
-<dt><code>pool</code> <kbd>address</kbd> <code>[<code>burst</code>]</code> <code>[<code>iburst</code>]</code> <code>[<code>version</code> <kbd>version</kbd>]</code> <code>[<code>prefer</code>]</code> <code>[<code>minpoll</code> <kbd>minpoll</kbd>]</code> <code>[<code>maxpoll</code> <kbd>maxpoll</kbd>]</code> <code>[<code>xmtnonce</code>]</code></dt>
-<dt><code>server</code> <kbd>address</kbd> <code>[<code>key</code> <kbd>key</kbd> <kbd>|</kbd> <code>autokey</code>]</code> <code>[<code>burst</code>]</code> <code>[<code>iburst</code>]</code> <code>[<code>version</code> <kbd>version</kbd>]</code> <code>[<code>prefer</code>]</code> <code>[<code>minpoll</code> <kbd>minpoll</kbd>]</code> <code>[<code>maxpoll</code> <kbd>maxpoll</kbd>]</code> <code>[<code>true</code>]</code> <code>[<code>xmtnonce</code>]</code></dt>
-<dt><code>peer</code> <kbd>address</kbd> <code>[<code>key</code> <kbd>key</kbd> <kbd>|</kbd> <code>autokey</code>]</code> <code>[<code>version</code> <kbd>version</kbd>]</code> <code>[<code>prefer</code>]</code> <code>[<code>minpoll</code> <kbd>minpoll</kbd>]</code> <code>[<code>maxpoll</code> <kbd>maxpoll</kbd>]</code> <code>[<code>true</code>]</code> <code>[<code>xleave</code>]</code></dt>
-<dt><code>broadcast</code> <kbd>address</kbd> <code>[<code>key</code> <kbd>key</kbd> <kbd>|</kbd> <code>autokey</code>]</code> <code>[<code>version</code> <kbd>version</kbd>]</code> <code>[<code>prefer</code>]</code> <code>[<code>minpoll</code> <kbd>minpoll</kbd>]</code> <code>[<code>ttl</code> <kbd>ttl</kbd>]</code> <code>[<code>xleave</code>]</code></dt>
-<dt><code>manycastclient</code> <kbd>address</kbd> <code>[<code>key</code> <kbd>key</kbd> <kbd>|</kbd> <code>autokey</code>]</code> <code>[<code>version</code> <kbd>version</kbd>]</code> <code>[<code>prefer</code>]</code> <code>[<code>minpoll</code> <kbd>minpoll</kbd>]</code> <code>[<code>maxpoll</code> <kbd>maxpoll</kbd>]</code> <code>[<code>ttl</code> <kbd>ttl</kbd>]</code></dt>
+</p><dl class="table">
+<dt><code class="code">pool</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">burst</code>]</code> <code class="code">[<code class="code">iburst</code>]</code> <code class="code">[<code class="code">version</code> <kbd class="kbd">version</kbd>]</code> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd>]</code> <code class="code">[<code class="code">maxpoll</code> <kbd class="kbd">maxpoll</kbd>]</code> <code class="code">[<code class="code">xmtnonce</code>]</code></dt>
+<dt><code class="code">server</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">key</code> <kbd class="kbd">key</kbd> <kbd class="kbd">|</kbd> <code class="code">autokey</code>]</code> <code class="code">[<code class="code">burst</code>]</code> <code class="code">[<code class="code">iburst</code>]</code> <code class="code">[<code class="code">version</code> <kbd class="kbd">version</kbd>]</code> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd>]</code> <code class="code">[<code class="code">maxpoll</code> <kbd class="kbd">maxpoll</kbd>]</code> <code class="code">[<code class="code">true</code>]</code> <code class="code">[<code class="code">xmtnonce</code>]</code></dt>
+<dt><code class="code">peer</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">key</code> <kbd class="kbd">key</kbd> <kbd class="kbd">|</kbd> <code class="code">autokey</code>]</code> <code class="code">[<code class="code">version</code> <kbd class="kbd">version</kbd>]</code> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd>]</code> <code class="code">[<code class="code">maxpoll</code> <kbd class="kbd">maxpoll</kbd>]</code> <code class="code">[<code class="code">true</code>]</code> <code class="code">[<code class="code">xleave</code>]</code></dt>
+<dt><code class="code">broadcast</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">key</code> <kbd class="kbd">key</kbd> <kbd class="kbd">|</kbd> <code class="code">autokey</code>]</code> <code class="code">[<code class="code">version</code> <kbd class="kbd">version</kbd>]</code> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd>]</code> <code class="code">[<code class="code">ttl</code> <kbd class="kbd">ttl</kbd>]</code> <code class="code">[<code class="code">xleave</code>]</code></dt>
+<dt><code class="code">manycastclient</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">key</code> <kbd class="kbd">key</kbd> <kbd class="kbd">|</kbd> <code class="code">autokey</code>]</code> <code class="code">[<code class="code">version</code> <kbd class="kbd">version</kbd>]</code> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd>]</code> <code class="code">[<code class="code">maxpoll</code> <kbd class="kbd">maxpoll</kbd>]</code> <code class="code">[<code class="code">ttl</code> <kbd class="kbd">ttl</kbd>]</code></dt>
</dl>
<p>These five commands specify the time server name or address to
be used and the mode in which to operate.
The
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
can be
either a DNS name or an IP address in dotted-quad notation.
Additional information on association behavior can be found in the
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
-</p><dl compact="compact">
-<dt><code>pool</code></dt>
+<samp class="file">/usr/share/doc/ntp</samp>).
+</p><dl class="table">
+<dt><code class="code">pool</code></dt>
<dd><p>For type s addresses, this command mobilizes a persistent
client mode association with a number of remote servers.
In this mode the local clock can synchronized to the
remote server, but the remote server can never be synchronized to
the local clock.
</p></dd>
-<dt><code>server</code></dt>
+<dt><code class="code">server</code></dt>
<dd><p>For type s and r addresses, this command mobilizes a persistent
client mode association with the specified remote server or local
radio clock.
remote server, but the remote server can never be synchronized to
the local clock.
This command should
-<em>not</em>
+<em class="emph">not</em>
be used for type
b or m addresses.
</p></dd>
-<dt><code>peer</code></dt>
+<dt><code class="code">peer</code></dt>
<dd><p>For type s addresses (only), this command mobilizes a
persistent symmetric-active mode association with the specified
remote peer.
This command should NOT be used for type
b, m or r addresses.
</p></dd>
-<dt><code>broadcast</code></dt>
+<dt><code class="code">broadcast</code></dt>
<dd><p>For type b and m addresses (only), this
command mobilizes a persistent broadcast mode association.
Multiple
subnet specified, but multicast messages go to all interfaces.
In broadcast mode the local server sends periodic broadcast
messages to a client population at the
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
specified, which is usually the broadcast address on (one of) the
local network(s) or a multicast address assigned to NTP.
The IANA
Ordinarily, this
specification applies only to the local server operating as a
sender; for operation as a broadcast client, see the
-<code>broadcastclient</code>
+<code class="code">broadcastclient</code>
or
-<code>multicastclient</code>
+<code class="code">multicastclient</code>
commands
below.
</p></dd>
-<dt><code>manycastclient</code></dt>
+<dt><code class="code">manycastclient</code></dt>
<dd><p>For type m addresses (only), this command mobilizes a
manycast client mode association for the multicast address
specified.
In this case a specific address must be supplied which
matches the address used on the
-<code>manycastserver</code>
+<code class="code">manycastserver</code>
command for
the designated manycast servers.
The NTP multicast address
these messages and causing a possibly massive implosion of replies
at the sender.
The
-<code>manycastserver</code>
+<code class="code">manycastserver</code>
command specifies that the local server
is to operate in client mode with the remote servers that are
discovered as the result of broadcast/multicast messages.
The
client broadcasts a request message to the group address associated
with the specified
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
and specifically enabled
servers respond to these messages.
The client selects the servers
providing the best time and continues as with the
-<code>server</code>
+<code class="code">server</code>
command.
The remaining servers are discarded as if never
heard.
</dl>
<p>Options:
-</p><dl compact="compact">
-<dt><code>autokey</code></dt>
+</p><dl class="table">
+<dt><code class="code">autokey</code></dt>
<dd><p>All packets sent to and received from the server or peer are to
include authentication fields encrypted using the autokey scheme
described in
‘Authentication Options’.
</p></dd>
-<dt><code>burst</code></dt>
+<dt><code class="code">burst</code></dt>
<dd><p>when the server is reachable, send a burst of six packets
instead of the usual one. The packet spacing is 2 s.
This is designed to improve timekeeping quality with the
-<code>server</code>
+<code class="code">server</code>
command and s addresses.
</p></dd>
-<dt><code>iburst</code></dt>
+<dt><code class="code">iburst</code></dt>
<dd><p>When the server is unreachable, send a burst of eight packets
instead of the usual one.
The packet spacing is 2 s.
This is designed to speed the initial synchronization
acquisition with the
-<code>server</code>
+<code class="code">server</code>
command and s addresses and when
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
is started with the
-<code>-q</code>
+<code class="code">-q</code>
option.
</p></dd>
-<dt><code>key</code> <kbd>key</kbd></dt>
+<dt><code class="code">key</code> <kbd class="kbd">key</kbd></dt>
<dd><p>All packets sent to and received from the server or peer are to
include authentication fields encrypted using the specified
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
identifier with values from 1 to 65535, inclusive.
The
default is to include no encryption field.
</p></dd>
-<dt><code>minpoll</code> <kbd>minpoll</kbd></dt>
-<dt><code>maxpoll</code> <kbd>maxpoll</kbd></dt>
+<dt><code class="code">minpoll</code> <kbd class="kbd">minpoll</kbd></dt>
+<dt><code class="code">maxpoll</code> <kbd class="kbd">maxpoll</kbd></dt>
<dd><p>These options specify the minimum and maximum poll intervals
for NTP messages, as a power of 2 in seconds
The maximum poll
interval defaults to 10 (1,024 s), but can be increased by the
-<code>maxpoll</code>
+<code class="code">maxpoll</code>
option to an upper limit of 17 (36.4 h).
The
minimum poll interval defaults to 6 (64 s), but can be decreased by
the
-<code>minpoll</code>
+<code class="code">minpoll</code>
option to a lower limit of 4 (16 s).
</p></dd>
-<dt><code>noselect</code></dt>
+<dt><code class="code">noselect</code></dt>
<dd><p>Marks the server as unused, except for display purposes.
The server is discarded by the selection algroithm.
</p></dd>
-<dt><code>preempt</code></dt>
+<dt><code class="code">preempt</code></dt>
<dd><p>Says the association can be preempted.
</p></dd>
-<dt><code>prefer</code></dt>
+<dt><code class="code">prefer</code></dt>
<dd><p>Marks the server as preferred.
All other things being equal,
this host will be chosen for synchronization among a set of
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
+<samp class="file">/usr/share/doc/ntp</samp>)
for further information.
</p></dd>
-<dt><code>true</code></dt>
+<dt><code class="code">true</code></dt>
<dd><p>Marks the server as a truechimer,
forcing the association to always survive the selection and clustering algorithms.
This option should almost certainly
-<em>only</em>
+<em class="emph">only</em>
be used while testing an association.
</p></dd>
-<dt><code>ttl</code> <kbd>ttl</kbd></dt>
+<dt><code class="code">ttl</code> <kbd class="kbd">ttl</kbd></dt>
<dd><p>This option is used only with broadcast server and manycast
client modes.
It specifies the time-to-live
-<kbd>ttl</kbd>
+<kbd class="kbd">ttl</kbd>
to
use on broadcast server and multicast server and the maximum
-<kbd>ttl</kbd>
+<kbd class="kbd">ttl</kbd>
for the expanding ring search with manycast
client packets.
Selection of the proper value, which defaults to
127, is something of a black art and should be coordinated with the
network administrator.
</p></dd>
-<dt><code>version</code> <kbd>version</kbd></dt>
+<dt><code class="code">version</code> <kbd class="kbd">version</kbd></dt>
<dd><p>Specifies the version number to be used for outgoing NTP
packets.
Versions 1-4 are the choices, with version 4 the
default.
</p></dd>
-<dt><code>xleave</code></dt>
+<dt><code class="code">xleave</code></dt>
<dd><p>Valid in
-<code>peer</code>
+<code class="code">peer</code>
and
-<code>broadcast</code>
+<code class="code">broadcast</code>
modes only, this flag enables interleave mode.
</p></dd>
-<dt><code>xmtnonce</code></dt>
+<dt><code class="code">xmtnonce</code></dt>
<dd><p>Valid only for
-<code>server</code>
+<code class="code">server</code>
and
-<code>pool</code>
+<code class="code">pool</code>
modes, this flag puts a random number in the packet’s transmit timestamp.
</p>
</dd>
</dl>
-<span id="Auxiliary-Commands"></span><h4 class="subsubsection">1.1.1.2 Auxiliary Commands</h4>
-<dl compact="compact">
-<dt><code>broadcastclient</code></dt>
+</div>
+<div class="subsubsection-level-extent" id="Auxiliary-Commands">
+<h4 class="subsubsection"><span>1.1.1.2 Auxiliary Commands<a class="copiable-link" href="#Auxiliary-Commands"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">broadcastclient</code></dt>
<dd><p>This command enables reception of broadcast server messages to
any local interface (type b) address.
Upon receiving a message for
authentication as described in
‘Authentication Options’.
</p></dd>
-<dt><code>manycastserver</code> <kbd>address</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">manycastserver</code> <kbd class="kbd">address</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>This command enables reception of manycast client messages to
the multicast group address(es) (type m) specified.
At least one
authentication as described in
‘Authentication Options’.
</p></dd>
-<dt><code>multicastclient</code> <kbd>address</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">multicastclient</code> <kbd class="kbd">address</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>This command enables reception of multicast server messages to
the multicast group address(es) (type m) specified.
Upon receiving
public-key authentication as described in
‘Authentication Options’.
</p></dd>
-<dt><code>mdnstries</code> <kbd>number</kbd></dt>
+<dt><code class="code">mdnstries</code> <kbd class="kbd">number</kbd></dt>
<dd><p>If we are participating in mDNS,
after we have synched for the first time
we attempt to register with the mDNS system.
If that registration attempt fails,
we try again at one minute intervals for up to
-<code>mdnstries</code>
+<code class="code">mdnstries</code>
times.
After all,
-<code>ntpd</code>
+<code class="code">ntpd</code>
may be starting before mDNS.
The default value for
-<code>mdnstries</code>
+<code class="code">mdnstries</code>
is 5.
</p></dd>
</dl>
<hr>
-<span id="Authentication-Support"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Authentication-Support">
+<div class="nav-panel">
<p>
-Next: <a href="#Monitoring-Support" accesskey="n" rel="next">Monitoring Support</a>, Previous: <a href="#Configuration-Support" accesskey="p" rel="prev">Configuration Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Monitoring-Support" accesskey="n" rel="next">Monitoring Support</a>, Previous: <a href="#Configuration-Support" accesskey="p" rel="prev">Configuration Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Authentication-Support-1"></span><h4 class="subsection">1.1.2 Authentication Support</h4>
+<h4 class="subsection" id="Authentication-Support-1"><span>1.1.2 Authentication Support<a class="copiable-link" href="#Authentication-Support-1"> ¶</a></span></h4>
<p>Authentication support allows the NTP client to verify that the
server is in fact known and trusted and not an intruder intending
accidentally or on purpose to masquerade as that server.
</p>
<p>Authentication is configured separately for each association
using the
-<code>key</code>
+<code class="code">key</code>
or
-<code>autokey</code>
+<code class="code">autokey</code>
subcommand on the
-<code>peer</code>,
-<code>server</code>,
-<code>broadcast</code>
+<code class="code">peer</code>,
+<code class="code">server</code>,
+<code class="code">broadcast</code>
and
-<code>manycastclient</code>
+<code class="code">manycastclient</code>
configuration commands as described in
‘Configuration Options’
page.
credentials and initialize the protocol
</p>
<p>The
-<code>auth</code>
+<code class="code">auth</code>
flag controls whether new associations or
remote configuration commands require cryptographic authentication.
This flag can be set or reset by the
-<code>enable</code>
+<code class="code">enable</code>
and
-<code>disable</code>
+<code class="code">disable</code>
commands and also by remote
configuration commands sent by a
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
program running on
another machine.
If this flag is enabled, which is the default
authenticated.
It should be understood
that operating with the
-<code>auth</code>
+<code class="code">auth</code>
flag disabled invites a significant vulnerability
where a rogue hacker can
masquerade as a falseticker and seriously
<p>An attractive alternative where multicast support is available
is manycast mode, in which clients periodically troll
for servers as described in the
-<a href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
+<a class="ref" href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
page.
Either symmetric key or public key
cryptographic authentication can be used in this mode.
cryptography are summarized below;
further details are in the briefings, papers
and reports at the NTP project page linked from
-<code>http://www.ntp.org/</code>.
-</p><span id="Symmetric_002dKey-Cryptography"></span><h4 class="subsubsection">1.1.2.1 Symmetric-Key Cryptography</h4>
+<code class="code">http://www.ntp.org/</code>.
+</p><ul class="mini-toc">
+<li><a href="#Symmetric_002dKey-Cryptography" accesskey="1">Symmetric-Key Cryptography</a></li>
+<li><a href="#Public-Key-Cryptography" accesskey="2">Public Key Cryptography</a></li>
+<li><a href="#Naming-and-Addressing" accesskey="3">Naming and Addressing</a></li>
+<li><a href="#Operation" accesskey="4">Operation</a></li>
+<li><a href="#Key-Management" accesskey="5">Key Management</a></li>
+<li><a href="#Authentication-Commands" accesskey="6">Authentication Commands</a></li>
+<li><a href="#Error-Codes" accesskey="7">Error Codes</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Symmetric_002dKey-Cryptography">
+<h4 class="subsubsection"><span>1.1.2.1 Symmetric-Key Cryptography<a class="copiable-link" href="#Symmetric_002dKey-Cryptography"> ¶</a></span></h4>
<p>The original RFC-1305 specification allows any one of possibly
65,535 keys, each distinguished by a 32-bit key identifier, to
authenticate an association.
Keys and
related information are specified in a key
file, usually called
-<samp>ntp.keys</samp>,
+<samp class="file">ntp.keys</samp>,
which must be distributed and stored using
secure means beyond the scope of the NTP protocol itself.
Besides the keys used
for ordinary NTP associations,
additional keys can be used as passwords for the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility programs.
</p>
<p>When
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
is first started, it reads the key file specified in the
-<code>keys</code>
+<code class="code">keys</code>
configuration command and installs the keys
in the key cache.
However,
individual keys must be activated with the
-<code>trusted</code>
+<code class="code">trusted</code>
command before use.
This
allows, for instance, the installation of possibly
several batches of keys and
then activating or deactivating each batch
remotely using
-<code>ntpdc(1ntpdcmdoc)</code>.
+<code class="code">ntpdc(1ntpdcmdoc)</code>.
This also provides a revocation capability that can be used
if a key becomes compromised.
The
-<code>requestkey</code>
+<code class="code">requestkey</code>
command selects the key used as the password for the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility, while the
-<code>controlkey</code>
+<code class="code">controlkey</code>
command selects the key used as the password for the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
utility.
-</p><span id="Public-Key-Cryptography"></span><h4 class="subsubsection">1.1.2.2 Public Key Cryptography</h4>
+</p></div>
+<div class="subsubsection-level-extent" id="Public-Key-Cryptography">
+<h4 class="subsubsection"><span>1.1.2.2 Public Key Cryptography<a class="copiable-link" href="#Public-Key-Cryptography"> ¶</a></span></h4>
<p>NTPv4 supports the original NTPv3 symmetric key scheme
described in RFC-1305 and in addition the Autokey protocol,
which is based on public key cryptography.
<p>The specific cryptographic environment used by Autokey servers
and clients is determined by a set of files
and soft links generated by the
-<code>ntp-keygen(1ntpkeygenmdoc)</code>
+<code class="code">ntp-keygen(1ntpkeygenmdoc)</code>
program.
This includes a required host key file,
required certificate file and optional sign key file,
There are several schemes
available in the OpenSSL software library, each identified
by a specific string such as
-<code>md5WithRSAEncryption</code>,
+<code class="code">md5WithRSAEncryption</code>,
which stands for the MD5 message digest with RSA
encryption scheme.
The current NTP distribution supports
engineered so that, even under anticipated failure conditions,
the NTP subnet will form such that every group host can find
a trail to at least one trusted host.
-</p><span id="Naming-and-Addressing"></span><h4 class="subsubsection">1.1.2.3 Naming and Addressing</h4>
+</p></div>
+<div class="subsubsection-level-extent" id="Naming-and-Addressing">
+<h4 class="subsubsection"><span>1.1.2.3 Naming and Addressing<a class="copiable-link" href="#Naming-and-Addressing"> ¶</a></span></h4>
<p>It is important to note that Autokey does not use DNS to
resolve addresses, since DNS can’t be completely trusted
until the name servers have synchronized clocks.
</p>
<p>By convention, the name of an Autokey host is the name returned
by the Unix
-<code>gethostname(2)</code>
+<code class="code">gethostname(2)</code>
system call or equivalent in other systems.
By the system design
model, there are no provisions to allow alternate names or aliases.
with network address translation schemes is not possible.
This reflects the intended robust security model where government
and corporate NTP servers are operated outside firewall perimeters.
-</p><span id="Operation"></span><h4 class="subsubsection">1.1.2.4 Operation</h4>
+</p></div>
+<div class="subsubsection-level-extent" id="Operation">
+<h4 class="subsubsection"><span>1.1.2.4 Operation<a class="copiable-link" href="#Operation"> ¶</a></span></h4>
<p>A specific combination of authentication scheme (none,
symmetric key, public key) and identity scheme is called
a cryptotype, although not all combinations are compatible.
of mobilization, either at configuration time or some time
later when a message of appropriate cryptotype arrives.
When mobilized by a
-<code>server</code>
+<code class="code">server</code>
or
-<code>peer</code>
+<code class="code">peer</code>
configuration command and no
-<code>key</code>
+<code class="code">key</code>
or
-<code>autokey</code>
+<code class="code">autokey</code>
subcommands are present, the association is not
authenticated; if the
-<code>key</code>
+<code class="code">key</code>
subcommand is present, the association is authenticated
using the symmetric key ID specified; if the
-<code>autokey</code>
+<code class="code">autokey</code>
subcommand is present, the association is authenticated
using Autokey.
</p>
Bob sends Cathy a thing called a crypto-NAK, which tells her
something broke.
She can see the evidence using the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
program.
</p>
<p>Denise has rolled her own host key and certificate.
But, wise security policy might preclude some cryptotype
combinations; for instance, running an identity scheme
with one server and no authentication with another might not be wise.
-</p><span id="Key-Management"></span><h4 class="subsubsection">1.1.2.5 Key Management</h4>
+</p></div>
+<div class="subsubsection-level-extent" id="Key-Management">
+<h4 class="subsubsection"><span>1.1.2.5 Key Management<a class="copiable-link" href="#Key-Management"> ¶</a></span></h4>
<p>The cryptographic values used by the Autokey protocol are
incorporated as a set of files generated by the
-<code>ntp-keygen(1ntpkeygenmdoc)</code>
+<code class="code">ntp-keygen(1ntpkeygenmdoc)</code>
utility program, including symmetric key, host key and
public certificate files, as well as sign key, identity parameters
and leapseconds files.
and certificates can be imported from public certificate
authorities.
Note that symmetric keys are necessary for the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility programs.
The remaining files are necessary only for the
Autokey protocol.
a subject key identifier or a issuer key identifier field;
however, an extended key usage field for a trusted host must
contain the value
-<code>trustRoot</code>;.
+<code class="code">trustRoot</code>;.
Other extension fields are ignored.
-</p><span id="Authentication-Commands"></span><h4 class="subsubsection">1.1.2.6 Authentication Commands</h4>
-<dl compact="compact">
-<dt><code>autokey</code> <code>[<kbd>logsec</kbd>]</code></dt>
+</p></div>
+<div class="subsubsection-level-extent" id="Authentication-Commands">
+<h4 class="subsubsection"><span>1.1.2.6 Authentication Commands<a class="copiable-link" href="#Authentication-Commands"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">autokey</code> <code class="code">[<kbd class="kbd">logsec</kbd>]</code></dt>
<dd><p>Specifies the interval between regenerations of the session key
list used with the Autokey protocol.
Note that the size of the key
with a single entry will be regenerated for every message
sent.
</p></dd>
-<dt><code>controlkey</code> <kbd>key</kbd></dt>
+<dt><code class="code">controlkey</code> <kbd class="kbd">key</kbd></dt>
<dd><p>Specifies the key identifier to use with the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
utility, which uses the standard
protocol defined in RFC-1305.
The
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
argument is
the key identifier for a trusted key, where the value can be in the
range 1 to 65,535, inclusive.
</p></dd>
-<dt><code>crypto</code> <code>[<code>cert</code> <kbd>file</kbd>]</code> <code>[<code>leap</code> <kbd>file</kbd>]</code> <code>[<code>randfile</code> <kbd>file</kbd>]</code> <code>[<code>host</code> <kbd>file</kbd>]</code> <code>[<code>gq</code> <kbd>file</kbd>]</code> <code>[<code>gqpar</code> <kbd>file</kbd>]</code> <code>[<code>iffpar</code> <kbd>file</kbd>]</code> <code>[<code>mvpar</code> <kbd>file</kbd>]</code> <code>[<code>pw</code> <kbd>password</kbd>]</code></dt>
+<dt><code class="code">crypto</code> <code class="code">[<code class="code">cert</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">leap</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">randfile</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">host</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">gq</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">gqpar</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">iffpar</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">mvpar</code> <kbd class="kbd">file</kbd>]</code> <code class="code">[<code class="code">pw</code> <kbd class="kbd">password</kbd>]</code></dt>
<dd><p>This command requires the OpenSSL library.
It activates public key
cryptography, selects the message digest and signature
Unless the complete path and name of the file are specified, the
location of a file is relative to the keys directory specified
in the
-<code>keysdir</code>
+<code class="code">keysdir</code>
command or default
-<samp>/usr/local/etc</samp>.
+<samp class="file">/usr/local/etc</samp>.
Following are the subcommands:
-</p><dl compact="compact">
-<dt><code>cert</code> <kbd>file</kbd></dt>
+</p><dl class="table">
+<dt><code class="code">cert</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the required host public certificate file.
This overrides the link
-<samp>ntpkey_cert_</samp><kbd>hostname</kbd>
+<samp class="file">ntpkey_cert_</samp><kbd class="kbd">hostname</kbd>
in the keys directory.
</p></dd>
-<dt><code>gqpar</code> <kbd>file</kbd></dt>
+<dt><code class="code">gqpar</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the optional GQ parameters file.
This
overrides the link
-<samp>ntpkey_gq_</samp><kbd>hostname</kbd>
+<samp class="file">ntpkey_gq_</samp><kbd class="kbd">hostname</kbd>
in the keys directory.
</p></dd>
-<dt><code>host</code> <kbd>file</kbd></dt>
+<dt><code class="code">host</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the required host key file.
This overrides
the link
-<samp>ntpkey_key_</samp><kbd>hostname</kbd>
+<samp class="file">ntpkey_key_</samp><kbd class="kbd">hostname</kbd>
in the keys directory.
</p></dd>
-<dt><code>iffpar</code> <kbd>file</kbd></dt>
+<dt><code class="code">iffpar</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the optional IFF parameters file.
This overrides the link
-<samp>ntpkey_iff_</samp><kbd>hostname</kbd>
+<samp class="file">ntpkey_iff_</samp><kbd class="kbd">hostname</kbd>
in the keys directory.
</p></dd>
-<dt><code>leap</code> <kbd>file</kbd></dt>
+<dt><code class="code">leap</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the optional leapsecond file.
This overrides the link
-<samp>ntpkey_leap</samp>
+<samp class="file">ntpkey_leap</samp>
in the keys directory.
</p></dd>
-<dt><code>mvpar</code> <kbd>file</kbd></dt>
+<dt><code class="code">mvpar</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the optional MV parameters file.
This overrides the link
-<samp>ntpkey_mv_</samp><kbd>hostname</kbd>
+<samp class="file">ntpkey_mv_</samp><kbd class="kbd">hostname</kbd>
in the keys directory.
</p></dd>
-<dt><code>pw</code> <kbd>password</kbd></dt>
+<dt><code class="code">pw</code> <kbd class="kbd">password</kbd></dt>
<dd><p>Specifies the password to decrypt files containing private keys and
identity parameters.
This is required only if these files have been
encrypted.
</p></dd>
-<dt><code>randfile</code> <kbd>file</kbd></dt>
+<dt><code class="code">randfile</code> <kbd class="kbd">file</kbd></dt>
<dd><p>Specifies the location of the random seed file used by the OpenSSL
library.
The defaults are described in the main text above.
</p></dd>
</dl>
</dd>
-<dt><code>keys</code> <kbd>keyfile</kbd></dt>
+<dt><code class="code">keys</code> <kbd class="kbd">keyfile</kbd></dt>
<dd><p>Specifies the complete path and location of the MD5 key file
containing the keys and key identifiers used by
-<code>ntpd(1ntpdmdoc)</code>,
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>,
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
when operating with symmetric key cryptography.
This is the same operation as the
-<code>-k</code>
+<code class="code">-k</code>
command line option.
</p></dd>
-<dt><code>keysdir</code> <kbd>path</kbd></dt>
+<dt><code class="code">keysdir</code> <kbd class="kbd">path</kbd></dt>
<dd><p>This command specifies the default directory path for
cryptographic keys, parameters and certificates.
The default is
-<samp>/usr/local/etc/</samp>.
+<samp class="file">/usr/local/etc/</samp>.
</p></dd>
-<dt><code>requestkey</code> <kbd>key</kbd></dt>
+<dt><code class="code">requestkey</code> <kbd class="kbd">key</kbd></dt>
<dd><p>Specifies the key identifier to use with the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility program, which uses a
proprietary protocol specific to this implementation of
-<code>ntpd(1ntpdmdoc)</code>.
+<code class="code">ntpd(1ntpdmdoc)</code>.
The
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
argument is a key identifier
for the trusted key, where the value can be in the range 1 to
65,535, inclusive.
</p></dd>
-<dt><code>revoke</code> <kbd>logsec</kbd></dt>
+<dt><code class="code">revoke</code> <kbd class="kbd">logsec</kbd></dt>
<dd><p>Specifies the interval between re-randomization of certain
cryptographic values used by the Autokey scheme, as a power of 2 in
seconds.
intervals above the specified interval, the values will be updated
for every message sent.
</p></dd>
-<dt><code>trustedkey</code> <kbd>key</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">trustedkey</code> <kbd class="kbd">key</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>Specifies the key identifiers which are trusted for the
purposes of authenticating peers with symmetric key cryptography,
as well as keys used by the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
programs.
The authentication procedures require that both the local
and remote servers share the same key and key identifier for this
purpose, although different keys can be used with different
servers.
The
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
arguments are 32-bit unsigned
integers with values from 1 to 65,535.
</p></dd>
</dl>
-<span id="Error-Codes"></span><h4 class="subsubsection">1.1.2.7 Error Codes</h4>
+</div>
+<div class="subsubsection-level-extent" id="Error-Codes">
+<h4 class="subsubsection"><span>1.1.2.7 Error Codes<a class="copiable-link" href="#Error-Codes"> ¶</a></span></h4>
<p>The following error codes are reported via the NTP control
and monitoring protocol trap mechanism.
-</p><dl compact="compact">
+</p><dl class="table">
<dt>101</dt>
<dd><p>(bad field format or length)
The packet has invalid version, length or format.
</p></dd>
</dl>
<hr>
-<span id="Monitoring-Support"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Monitoring-Support">
+<div class="nav-panel">
<p>
-Next: <a href="#Access-Control-Support" accesskey="n" rel="next">Access Control Support</a>, Previous: <a href="#Authentication-Support" accesskey="p" rel="prev">Authentication Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Access-Control-Support" accesskey="n" rel="next">Access Control Support</a>, Previous: <a href="#Authentication-Support" accesskey="p" rel="prev">Authentication Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Monitoring-Support-1"></span><h4 class="subsection">1.1.3 Monitoring Support</h4>
-<p><code>ntpd(1ntpdmdoc)</code>
+<h4 class="subsection" id="Monitoring-Support-1"><span>1.1.3 Monitoring Support<a class="copiable-link" href="#Monitoring-Support-1"> ¶</a></span></h4>
+<p><code class="code">ntpd(1ntpdmdoc)</code>
includes a comprehensive monitoring facility suitable
for continuous, long term recording of server and client
timekeeping performance.
See the
-<code>statistics</code>
+<code class="code">statistics</code>
command below
for a listing and example of each type of statistics currently
supported.
Statistic files are managed using file generation sets
and scripts in the
-<samp>./scripts</samp>
+<samp class="file">./scripts</samp>
directory of the source code distribution.
Using
these facilities and
-<small>UNIX</small>
-<code>cron(8)</code>
+<small class="sc">UNIX</small>
+<code class="code">cron(8)</code>
jobs, the data can be
automatically summarized and archived for retrospective analysis.
-</p><span id="Monitoring-Commands"></span><h4 class="subsubsection">1.1.3.1 Monitoring Commands</h4>
-<dl compact="compact">
-<dt><code>statistics</code> <kbd>name</kbd> <kbd>...</kbd></dt>
+</p><ul class="mini-toc">
+<li><a href="#Monitoring-Commands" accesskey="1">Monitoring Commands</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Monitoring-Commands">
+<h4 class="subsubsection"><span>1.1.3.1 Monitoring Commands<a class="copiable-link" href="#Monitoring-Commands"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">statistics</code> <kbd class="kbd">name</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>Enables writing of statistics records.
Currently, eight kinds of
-<kbd>name</kbd>
+<kbd class="kbd">name</kbd>
statistics are supported.
-</p><dl compact="compact">
-<dt><code>clockstats</code></dt>
+</p><dl class="table">
+<dt><code class="code">clockstats</code></dt>
<dd><p>Enables recording of clock driver statistics information.
Each update
received from a clock driver appends a line of the following form to
the file generation set named
-<code>clockstats</code>:
+<code class="code">clockstats</code>:
</p><pre class="verbatim">49213 525.624 127.127.4.1 93 226 00:08:29.606 D
</pre>
<p>The first two fields show the date (Modified Julian Day) and time
See information specific to each
clock for further details.
</p></dd>
-<dt><code>cryptostats</code></dt>
+<dt><code class="code">cryptostats</code></dt>
<dd><p>This option requires the OpenSSL cryptographic software library.
It
enables recording of cryptographic public key protocol information.
Each message received by the protocol module appends a line of the
following form to the file generation set named
-<code>cryptostats</code>:
+<code class="code">cryptostats</code>:
</p><pre class="verbatim">49213 525.624 127.127.4.1 message
</pre>
<p>The first two fields show the date (Modified Julian Day) and time
‘Authentication Options’
section for further information.
</p></dd>
-<dt><code>loopstats</code></dt>
+<dt><code class="code">loopstats</code></dt>
<dd><p>Enables recording of loop filter statistics information.
Each
update of the local clock outputs a line of the following form to
the file generation set named
-<code>loopstats</code>:
+<code class="code">loopstats</code>:
</p><pre class="verbatim">50935 75440.031 0.000006019 13.778190 0.000351733 0.0133806
</pre>
<p>The first two fields show the date (Modified Julian Day) and
PPM), RMS jitter (seconds), Allan deviation (PPM) and clock
discipline time constant.
</p></dd>
-<dt><code>peerstats</code></dt>
+<dt><code class="code">peerstats</code></dt>
<dd><p>Enables recording of peer statistics information.
This includes
statistics records of all peers of a NTP server and of special
Each valid update appends a
line of the following form to the current element of a file
generation set named
-<code>peerstats</code>:
+<code class="code">peerstats</code>:
</p><pre class="verbatim">48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674
</pre>
<p>The first two fields show the date (Modified Julian Day) and
The final four fields show the offset,
delay, dispersion and RMS jitter, all in seconds.
</p></dd>
-<dt><code>rawstats</code></dt>
+<dt><code class="code">rawstats</code></dt>
<dd><p>Enables recording of raw-timestamp statistics information.
This
includes statistics records of all peers of a NTP server and of
Each NTP message
received from a peer or clock driver appends a line of the
following form to the file generation set named
-<code>rawstats</code>:
+<code class="code">rawstats</code>:
</p><pre class="verbatim">50928 2132.543 128.4.1.1 128.4.1.20 3102453281.584327000 3102453281.58622800031 02453332.540806000 3102453332.541458000
</pre>
<p>The first two fields show the date (Modified Julian Day) and
values are as received and before processing by the various data
smoothing and mitigation algorithms.
</p></dd>
-<dt><code>sysstats</code></dt>
+<dt><code class="code">sysstats</code></dt>
<dd><p>Enables recording of ntpd statistics counters on a periodic basis.
Each
hour a line of the following form is appended to the file generation
set named
-<code>sysstats</code>:
+<code class="code">sysstats</code>:
</p><pre class="verbatim">50928 2132.543 36000 81965 0 9546 56 71793 512 540 10 147
</pre>
<p>The first two fields show the date (Modified Julian Day) and time
The remaining ten fields show
the statistics counter values accumulated since the last generated
line.
-</p><dl compact="compact">
-<dt>Time since restart <code>36000</code></dt>
+</p><dl class="table">
+<dt>Time since restart <code class="code">36000</code></dt>
<dd><p>Time in hours since the system was last rebooted.
</p></dd>
-<dt>Packets received <code>81965</code></dt>
+<dt>Packets received <code class="code">81965</code></dt>
<dd><p>Total number of packets received.
</p></dd>
-<dt>Packets processed <code>0</code></dt>
+<dt>Packets processed <code class="code">0</code></dt>
<dd><p>Number of packets received in response to previous packets sent
</p></dd>
-<dt>Current version <code>9546</code></dt>
+<dt>Current version <code class="code">9546</code></dt>
<dd><p>Number of packets matching the current NTP version.
</p></dd>
-<dt>Previous version <code>56</code></dt>
+<dt>Previous version <code class="code">56</code></dt>
<dd><p>Number of packets matching the previous NTP version.
</p></dd>
-<dt>Bad version <code>71793</code></dt>
+<dt>Bad version <code class="code">71793</code></dt>
<dd><p>Number of packets matching neither NTP version.
</p></dd>
-<dt>Access denied <code>512</code></dt>
+<dt>Access denied <code class="code">512</code></dt>
<dd><p>Number of packets denied access for any reason.
</p></dd>
-<dt>Bad length or format <code>540</code></dt>
+<dt>Bad length or format <code class="code">540</code></dt>
<dd><p>Number of packets with invalid length, format or port number.
</p></dd>
-<dt>Bad authentication <code>10</code></dt>
+<dt>Bad authentication <code class="code">10</code></dt>
<dd><p>Number of packets not verified as authentic.
</p></dd>
-<dt>Rate exceeded <code>147</code></dt>
+<dt>Rate exceeded <code class="code">147</code></dt>
<dd><p>Number of packets discarded due to rate limitation.
</p></dd>
</dl>
</dd>
-<dt><code>statsdir</code> <kbd>directory_path</kbd></dt>
+<dt><code class="code">statsdir</code> <kbd class="kbd">directory_path</kbd></dt>
<dd><p>Indicates the full path of a directory where statistics files
should be created (see below).
This keyword allows
the (otherwise constant)
-<code>filegen</code>
+<code class="code">filegen</code>
filename prefix to be modified for file generation sets, which
is useful for handling statistics logs.
</p></dd>
-<dt><code>filegen</code> <kbd>name</kbd> <code>[<code>file</code> <kbd>filename</kbd>]</code> <code>[<code>type</code> <kbd>typename</kbd>]</code> <code>[<code>link</code> | <code>nolink</code>]</code> <code>[<code>enable</code> | <code>disable</code>]</code></dt>
+<dt><code class="code">filegen</code> <kbd class="kbd">name</kbd> <code class="code">[<code class="code">file</code> <kbd class="kbd">filename</kbd>]</code> <code class="code">[<code class="code">type</code> <kbd class="kbd">typename</kbd>]</code> <code class="code">[<code class="code">link</code> | <code class="code">nolink</code>]</code> <code class="code">[<code class="code">enable</code> | <code class="code">disable</code>]</code></dt>
<dd><p>Configures setting of generation file set name.
Generation
file sets provide a means for handling files that are
produced.)
</p>
<p>Note that this command can be sent from the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
program running at a remote location.
-</p><dl compact="compact">
-<dt><code>name</code></dt>
+</p><dl class="table">
+<dt><code class="code">name</code></dt>
<dd><p>This is the type of the statistics records, as shown in the
-<code>statistics</code>
+<code class="code">statistics</code>
command.
</p></dd>
-<dt><code>file</code> <kbd>filename</kbd></dt>
+<dt><code class="code">file</code> <kbd class="kbd">filename</kbd></dt>
<dd><p>This is the file name for the statistics records.
Filenames of set
members are built from three concatenated elements
-<code>prefix</code>,
-<code>filename</code>
+<code class="code">prefix</code>,
+<code class="code">filename</code>
and
-<code>suffix</code>:
-</p><dl compact="compact">
-<dt><code>prefix</code></dt>
+<code class="code">suffix</code>:
+</p><dl class="table">
+<dt><code class="code">prefix</code></dt>
<dd><p>This is a constant filename path.
It is not subject to
modifications via the
-<kbd>filegen</kbd>
+<kbd class="kbd">filegen</kbd>
option.
It is defined by the
server, usually specified as a compile-time constant.
however, be configurable for individual file generation sets
via other commands.
For example, the prefix used with
-<kbd>loopstats</kbd>
+<kbd class="kbd">loopstats</kbd>
and
-<kbd>peerstats</kbd>
+<kbd class="kbd">peerstats</kbd>
generation can be configured using the
-<kbd>statsdir</kbd>
+<kbd class="kbd">statsdir</kbd>
option explained above.
</p></dd>
-<dt><code>filename</code></dt>
+<dt><code class="code">filename</code></dt>
<dd><p>This string is directly concatenated to the prefix mentioned
above (no intervening
‘/’).
This can be modified using
the file argument to the
-<kbd>filegen</kbd>
+<kbd class="kbd">filegen</kbd>
statement.
No
-<samp>..</samp>
+<samp class="file">..</samp>
elements are
allowed in this component to prevent filenames referring to
parts outside the filesystem hierarchy denoted by
-<kbd>prefix</kbd>.
+<kbd class="kbd">prefix</kbd>.
</p></dd>
-<dt><code>suffix</code></dt>
+<dt><code class="code">suffix</code></dt>
<dd><p>This part is reflects individual elements of a file set.
It is
generated according to the type of a file set.
</p></dd>
</dl>
</dd>
-<dt><code>type</code> <kbd>typename</kbd></dt>
+<dt><code class="code">type</code> <kbd class="kbd">typename</kbd></dt>
<dd><p>A file generation set is characterized by its type.
The following
types are supported:
-</p><dl compact="compact">
-<dt><code>none</code></dt>
+</p><dl class="table">
+<dt><code class="code">none</code></dt>
<dd><p>The file set is actually a single plain file.
</p></dd>
-<dt><code>pid</code></dt>
+<dt><code class="code">pid</code></dt>
<dd><p>One element of file set is used per incarnation of a ntpd
server.
This type does not perform any changes to file set
members during runtime, however it provides an easy way of
separating files belonging to different
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
server incarnations.
The set member filename is built by appending a
‘.’
to concatenated
-<kbd>prefix</kbd>
+<kbd class="kbd">prefix</kbd>
and
-<kbd>filename</kbd>
+<kbd class="kbd">filename</kbd>
strings, and
appending the decimal representation of the process ID of the
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
server process.
</p></dd>
-<dt><code>day</code></dt>
+<dt><code class="code">day</code></dt>
<dd><p>One file generation set element is created per day.
A day is
defined as the period between 00:00 and 24:00 UTC.
‘.’
and a day specification in
the form
-<code>YYYYMMdd</code>.
-<code>YYYY</code>
+<code class="code">YYYYMMdd</code>.
+<code class="code">YYYY</code>
is a 4-digit year number (e.g., 1992).
-<code>MM</code>
+<code class="code">MM</code>
is a two digit month number.
-<code>dd</code>
+<code class="code">dd</code>
is a two digit day number.
Thus, all information written at 10 December 1992 would end up
in a file named
-<kbd>prefix</kbd>
-<kbd>filename</kbd>.19921210.
+<kbd class="kbd">prefix</kbd>
+<kbd class="kbd">filename</kbd>.19921210.
</p></dd>
-<dt><code>week</code></dt>
+<dt><code class="code">week</code></dt>
<dd><p>Any file set member contains data related to a certain week of
a year.
The term week is defined by computing day-of-year
Elements of such a file generation set are
distinguished by appending the following suffix to the file set
filename base: A dot, a 4-digit year number, the letter
-<code>W</code>,
+<code class="code">W</code>,
and a 2-digit week number.
For example, information from January,
10th 1992 would end up in a file with suffix
.No . Ns Ar 1992W1 .
</p></dd>
-<dt><code>month</code></dt>
+<dt><code class="code">month</code></dt>
<dd><p>One generation file set element is generated per month.
The
file name suffix consists of a dot, a 4-digit year number, and
a 2-digit month.
</p></dd>
-<dt><code>year</code></dt>
+<dt><code class="code">year</code></dt>
<dd><p>One generation file element is generated per year.
The filename
suffix consists of a dot and a 4 digit year number.
</p></dd>
-<dt><code>age</code></dt>
+<dt><code class="code">age</code></dt>
<dd><p>This type of file generation sets changes to a new element of
the file set every 24 hours of server operation.
The filename
suffix consists of a dot, the letter
-<code>a</code>,
+<code class="code">a</code>,
and an 8-digit number.
This number is taken to be the number of seconds the server is
running at the start of the corresponding 24-hour period.
Information is only written to a file generation by specifying
-<code>enable</code>;
+<code class="code">enable</code>;
output is prevented by specifying
-<code>disable</code>.
+<code class="code">disable</code>.
</p></dd>
</dl>
</dd>
-<dt><code>link</code> | <code>nolink</code></dt>
+<dt><code class="code">link</code> | <code class="code">nolink</code></dt>
<dd><p>It is convenient to be able to access the current element of a file
generation set by a fixed name.
This feature is enabled by
specifying
-<code>link</code>
+<code class="code">link</code>
and disabled using
-<code>nolink</code>.
+<code class="code">nolink</code>.
If link is specified, a
hard link from the current file set element to a file without
suffix is created.
When there is already a file with this name and
the number of links of this file is one, it is renamed appending a
dot, the letter
-<code>C</code>,
+<code class="code">C</code>,
and the pid of the
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
server process.
When the
number of links is greater than one, the file is unlinked.
This
allows the current file to be accessed by a constant name.
</p></dd>
-<dt><code>enable</code> <code>|</code> <code>disable</code></dt>
+<dt><code class="code">enable</code> <code class="code">|</code> <code class="code">disable</code></dt>
<dd><p>Enables or disables the recording function.
</p></dd>
</dl>
</dd>
</dl>
<hr>
-<span id="Access-Control-Support"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Access-Control-Support">
+<div class="nav-panel">
<p>
-Next: <a href="#Automatic-NTP-Configuration-Options" accesskey="n" rel="next">Automatic NTP Configuration Options</a>, Previous: <a href="#Monitoring-Support" accesskey="p" rel="prev">Monitoring Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Automatic-NTP-Configuration-Options" accesskey="n" rel="next">Automatic NTP Configuration Options</a>, Previous: <a href="#Monitoring-Support" accesskey="p" rel="prev">Monitoring Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Access-Control-Support-1"></span><h4 class="subsection">1.1.4 Access Control Support</h4>
+<h4 class="subsection" id="Access-Control-Support-1"><span>1.1.4 Access Control Support<a class="copiable-link" href="#Access-Control-Support-1"> ¶</a></span></h4>
<p>The
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
daemon implements a general purpose address/mask based restriction
list.
The list contains address/match entries sorted first
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
</p>
<p>The restriction facility was implemented in conformance
with the access policies for the original NSFnet backbone
</p>
<p>Clients can be denied service because they are explicitly
included in the restrict list created by the
-<code>restrict</code>
+<code class="code">restrict</code>
command
or implicitly as the result of cryptographic or rate limit
violations.
When a client or network is denied access
for an indefinite period, the only way at present to remove
the restrictions is by restarting the server.
-</p><span id="The-Kiss_002dof_002dDeath-Packet"></span><h4 class="subsubsection">1.1.4.1 The Kiss-of-Death Packet</h4>
+</p><ul class="mini-toc">
+<li><a href="#The-Kiss_002dof_002dDeath-Packet" accesskey="1">The Kiss-of-Death Packet</a></li>
+<li><a href="#Access-Control-Commands" accesskey="2">Access Control Commands</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="The-Kiss_002dof_002dDeath-Packet">
+<h4 class="subsubsection"><span>1.1.4.1 The Kiss-of-Death Packet<a class="copiable-link" href="#The-Kiss_002dof_002dDeath-Packet"> ¶</a></span></h4>
<p>Ordinarily, packets denied service are simply dropped with no
further action except incrementing statistics counters.
Sometimes a
to zero and the reference identifier field set to a four-byte
ASCII code.
If the
-<code>noserve</code>
+<code class="code">noserve</code>
or
-<code>notrust</code>
+<code class="code">notrust</code>
flag of the matching restrict list entry is set,
the code is "DENY"; if the
-<code>limited</code>
+<code class="code">limited</code>
flag is set and the rate limit
is exceeded, the code is "RATE".
Finally, if a cryptographic violation occurs, the code is "CRYP".
This
happens automatically at the client when the association times out.
It will happen at the server only if the server operator cooperates.
-</p><span id="Access-Control-Commands"></span><h4 class="subsubsection">1.1.4.2 Access Control Commands</h4>
-<dl compact="compact">
-<dt><code>discard</code> <code>[<code>average</code> <kbd>avg</kbd>]</code> <code>[<code>minimum</code> <kbd>min</kbd>]</code> <code>[<code>monitor</code> <kbd>prob</kbd>]</code></dt>
+</p></div>
+<div class="subsubsection-level-extent" id="Access-Control-Commands">
+<h4 class="subsubsection"><span>1.1.4.2 Access Control Commands<a class="copiable-link" href="#Access-Control-Commands"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">discard</code> <code class="code">[<code class="code">average</code> <kbd class="kbd">avg</kbd>]</code> <code class="code">[<code class="code">minimum</code> <kbd class="kbd">min</kbd>]</code> <code class="code">[<code class="code">monitor</code> <kbd class="kbd">prob</kbd>]</code></dt>
<dd><p>Set the parameters of the
-<code>limited</code>
+<code class="code">limited</code>
facility which protects the server from
client abuse.
The
-<code>average</code>
+<code class="code">average</code>
subcommand specifies the minimum average packet
spacing in log2 seconds, defaulting to 3 (8s), while the
-<code>minimum</code>
+<code class="code">minimum</code>
subcommand specifies the minimum packet spacing
in seconds, defaulting to 2.
Packets that violate these minima are discarded
and a kiss-o’-death packet returned if enabled.
The
-<code>monitor</code>
+<code class="code">monitor</code>
subcommand indirectly specifies the probability of
replacing the oldest entry from the monitor (MRU)
list of recent requests used to enforce rate controls,
when that list is at its maximum size. The probability
of replacing the oldest entry is the age of that entry
in seconds divided by the
-<code>monitor</code>
+<code class="code">monitor</code>
value, default 3000. For example, if the oldest entry
in the MRU list represents a request 300 seconds ago,
by default the probability of replacing it with an
now is 10%. Conversely, if the oldest entry is more
than 3000 seconds old, the probability is 100%.
</p></dd>
-<dt><code>restrict</code> <kbd>address</kbd> <code>[<code>mask</code> <kbd>mask</kbd>]</code> <code>[<code>ippeerlimit</code> <kbd>int</kbd>]</code> <code>[<kbd>flag</kbd> <kbd>...</kbd>]</code></dt>
+<dt><code class="code">restrict</code> <kbd class="kbd">address</kbd> <code class="code">[<code class="code">mask</code> <kbd class="kbd">mask</kbd>]</code> <code class="code">[<code class="code">ippeerlimit</code> <kbd class="kbd">int</kbd>]</code> <code class="code">[<kbd class="kbd">flag</kbd> <kbd class="kbd">...</kbd>]</code></dt>
<dd><p>The
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
argument expressed in
numeric form is the address of a host or network.
Alternatively, the
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
argument can be a valid hostname. When a hostname
is provided, a restriction entry is created for each
address the hostname resolves to, and any provided
-<kbd>mask</kbd>
+<kbd class="kbd">mask</kbd>
is ignored and an individual host mask is
used for each entry.
The
-<kbd>mask</kbd>
+<kbd class="kbd">mask</kbd>
argument expressed in numeric form defaults to
all bits lit, meaning that the
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
is treated as the address of an individual host.
A default entry with address and mask all zeroes
is always included and is always the first entry in the list.
Note that text string
-<code>default</code>,
+<code class="code">default</code>,
with no mask option, may
be used to indicate the default entry.
The
-<code>ippeerlimit</code>
+<code class="code">ippeerlimit</code>
directive limits the number of peer requests for each IP to
-<kbd>int</kbd>,
+<kbd class="kbd">int</kbd>,
where a value of -1 means "unlimited", the current default.
A value of 0 means "none".
There would usually be at most 1 peering request per IP,
but if the remote peering requests are behind a proxy
there could well be more than 1 per IP.
In the current implementation,
-<code>flag</code>
+<code class="code">flag</code>
always
restricts access, i.e., an entry with no flags indicates that free
access to the server is to be given.
reconfiguration of the server.
One or more of the following flags
may be specified:
-</p><dl compact="compact">
-<dt><code>ignore</code></dt>
+</p><dl class="table">
+<dt><code class="code">ignore</code></dt>
<dd><p>Deny packets of all kinds, including
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
queries.
</p></dd>
-<dt><code>kod</code></dt>
+<dt><code class="code">kod</code></dt>
<dd><p>If this flag is set when a rate violation occurs, a kiss-o’-death
(KoD) packet is sometimes sent.
KoD packets are rate limited to no more than one per minimum
average interpacket spacing, set by
-<code>discard</code> <code>average</code>
+<code class="code">discard</code> <code class="code">average</code>
defaulting to 8s. Otherwise, no response is sent.
</p></dd>
-<dt><code>limited</code></dt>
+<dt><code class="code">limited</code></dt>
<dd><p>Deny service if the packet spacing violates the lower limits specified
in the
-<code>discard</code>
+<code class="code">discard</code>
command.
A history of clients is kept using the
monitoring capability of
-<code>ntpd(1ntpdmdoc)</code>.
+<code class="code">ntpd(1ntpdmdoc)</code>.
Thus, monitoring is always active as
long as there is a restriction entry with the
-<code>limited</code>
+<code class="code">limited</code>
flag.
</p></dd>
-<dt><code>lowpriotrap</code></dt>
+<dt><code class="code">lowpriotrap</code></dt>
<dd><p>Declare traps set by matching hosts to be low priority.
The
number of traps a server can maintain is limited (the current limit
modifies the assignment algorithm by allowing low priority traps to
be overridden by later requests for normal priority traps.
</p></dd>
-<dt><code>noepeer</code></dt>
+<dt><code class="code">noepeer</code></dt>
<dd><p>Deny ephemeral peer requests,
even if they come from an authenticated source.
Note that the ability to use a symmetric key for authentication may be restricted to
one or more IPs or subnets via the third field of the
-<samp>ntp.keys</samp>
+<samp class="file">ntp.keys</samp>
file.
This restriction is not enabled by default,
to maintain backward compatability.
Expect
-<code>noepeer</code>
+<code class="code">noepeer</code>
to become the default in ntp-4.4.
</p></dd>
-<dt><code>nomodify</code></dt>
+<dt><code class="code">nomodify</code></dt>
<dd><p>Deny
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
queries which attempt to modify the state of the
server (i.e., run time reconfiguration).
Queries which return
information are permitted.
</p></dd>
-<dt><code>noquery</code></dt>
+<dt><code class="code">noquery</code></dt>
<dd><p>Deny
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
queries.
Time service is not affected.
</p></dd>
-<dt><code>nopeer</code></dt>
+<dt><code class="code">nopeer</code></dt>
<dd><p>Deny unauthenticated packets which would result in mobilizing a new association.
This includes
broadcast and symmetric active packets
when a configured association does not exist.
It also includes
-<code>pool</code>
+<code class="code">pool</code>
associations, so if you want to use servers from a
-<code>pool</code>
+<code class="code">pool</code>
directive and also want to use
-<code>nopeer</code>
+<code class="code">nopeer</code>
by default, you’ll want a
-<code>restrict source ...</code>
+<code class="code">restrict source ...</code>
line as well that does
-<em>not</em>
+<em class="emph">not</em>
include the
-<code>nopeer</code>
+<code class="code">nopeer</code>
directive.
</p></dd>
-<dt><code>noserve</code></dt>
+<dt><code class="code">noserve</code></dt>
<dd><p>Deny all packets except
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
queries.
</p></dd>
-<dt><code>notrap</code></dt>
+<dt><code class="code">notrap</code></dt>
<dd><p>Decline to provide mode 6 control message trap service to matching
hosts.
The trap service is a subsystem of the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
control message
protocol which is intended for use by remote event logging programs.
</p></dd>
-<dt><code>notrust</code></dt>
+<dt><code class="code">notrust</code></dt>
<dd><p>Deny service unless the packet is cryptographically authenticated.
</p></dd>
-<dt><code>ntpport</code></dt>
+<dt><code class="code">ntpport</code></dt>
<dd><p>This is actually a match algorithm modifier, rather than a
restriction flag.
Its presence causes the restriction entry to be
UDP port (123).
There can be two restriction entries with the same IP address if
one specifies
-<code>ntpport</code>
+<code class="code">ntpport</code>
and the other does not.
The
-<code>ntpport</code>
+<code class="code">ntpport</code>
entry is considered more specific and
is sorted later in the list.
</p></dd>
-<dt><code>serverresponse fuzz</code></dt>
+<dt><code class="code">serverresponse fuzz</code></dt>
<dd><p>When reponding to server requests,
fuzz the low order bits of the
-<code>reftime</code>.
+<code class="code">reftime</code>.
</p></dd>
-<dt><code>version</code></dt>
+<dt><code class="code">version</code></dt>
<dd><p>Deny packets that do not match the current NTP version.
</p></dd>
</dl>
ntpport, for each of the local host’s interface addresses are
inserted into the table at startup to prevent ntpd
from attempting to synchronize to itself, such as with
-<code>manycastclient</code>
+<code class="code">manycastclient</code>
when
-<code>manycast</code>
+<code class="code">manycast</code>
is also specified with the same multicast address.
A default entry is also always present, though if it is
otherwise unconfigured; no flags are associated
with the default entry (i.e., everything besides your own
NTP server is unrestricted).
</p></dd>
-<dt><code>delrestrict</code> <code>[source]</code> <kbd>address</kbd></dt>
+<dt><code class="code">delrestrict</code> <code class="code">[source]</code> <kbd class="kbd">address</kbd></dt>
<dd><p>Remove a previously-set restriction. This is useful for
runtime configuration via
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
. If
-<code>source</code>
+<code class="code">source</code>
is specified, a dynamic restriction created from the
-<code>restrict</code> <code>source</code>
+<code class="code">restrict</code> <code class="code">source</code>
template at the time
an association was added is removed. Without
-<code>source</code>
+<code class="code">source</code>
a static restriction is removed.
</p></dd>
</dl>
<hr>
-<span id="Automatic-NTP-Configuration-Options"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Automatic-NTP-Configuration-Options">
+<div class="nav-panel">
<p>
-Next: <a href="#Reference-Clock-Support" accesskey="n" rel="next">Reference Clock Support</a>, Previous: <a href="#Access-Control-Support" accesskey="p" rel="prev">Access Control Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Reference-Clock-Support" accesskey="n" rel="next">Reference Clock Support</a>, Previous: <a href="#Access-Control-Support" accesskey="p" rel="prev">Access Control Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Automatic-NTP-Configuration-Options-1"></span><h4 class="subsection">1.1.5 Automatic NTP Configuration Options</h4>
-<span id="Manycasting"></span><h4 class="subsubsection">1.1.5.1 Manycasting</h4>
+<h4 class="subsection" id="Automatic-NTP-Configuration-Options-1"><span>1.1.5 Automatic NTP Configuration Options<a class="copiable-link" href="#Automatic-NTP-Configuration-Options-1"> ¶</a></span></h4>
+<ul class="mini-toc">
+<li><a href="#Manycasting" accesskey="1">Manycasting</a></li>
+<li><a href="#Manycast-Interactions-with-Autokey" accesskey="2">Manycast Interactions with Autokey</a></li>
+<li><a href="#Broadcast-Options" accesskey="3">Broadcast Options</a></li>
+<li><a href="#Manycast-Options" accesskey="4">Manycast Options</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Manycasting">
+<h4 class="subsubsection"><span>1.1.5.1 Manycasting<a class="copiable-link" href="#Manycasting"> ¶</a></span></h4>
<p>Manycasting is a automatic discovery and configuration paradigm
new to NTPv4.
It is intended as a means for a multicast client
large key sizes.
It is implemented using the Autokey protocol and
the OpenSSL cryptographic library available from
-<code>http://www.openssl.org/</code>.
+<code class="code">http://www.openssl.org/</code>.
The library can also be used with other NTPv4 modes
as well and is highly recommended, especially for broadcast modes.
</p>
<p>A persistent manycast client association is configured
using the
-<code>manycastclient</code>
+<code class="code">manycastclient</code>
command, which is similar to the
-<code>server</code>
+<code class="code">server</code>
command but with a multicast (IPv4 class
-<code>D</code>
+<code class="code">D</code>
or IPv6 prefix
-<code>FF</code>)
+<code class="code">FF</code>)
group address.
The IANA has designated IPv4 address 224.1.1.1
and IPv6 address FF05::101 (site local) for NTP.
for a future ephemeral unicast client/server association.
</p>
<p>Manycast servers configured with the
-<code>manycastserver</code>
+<code class="code">manycastserver</code>
command listen on the specified group address for manycast
client messages.
Note the distinction between manycast client,
and the effects of implosion due to near-simultaneous
arrival of manycast server messages.
The strategy is determined by the
-<code>manycastclient</code>,
-<code>tos</code>
+<code class="code">manycastclient</code>,
+<code class="code">tos</code>
and
-<code>ttl</code>
+<code class="code">ttl</code>
configuration commands.
The manycast poll interval is
normally eight times the system poll interval,
which starts out at the
-<code>minpoll</code>
+<code class="code">minpoll</code>
value specified in the
-<code>manycastclient</code>,
+<code class="code">manycastclient</code>,
command and, under normal circumstances, increments to the
-<code>maxpolll</code>
+<code class="code">maxpolll</code>
value specified in this command.
Initially, the TTL is
set at the minimum hops specified by the
-<code>ttl</code>
+<code class="code">ttl</code>
command.
At each retransmission the TTL is increased until reaching
the maximum hops specified by this command or a sufficient
<p>The quality and reliability of the suite of associations
discovered by the manycast client is determined by the NTP
mitigation algorithms and the
-<code>minclock</code>
+<code class="code">minclock</code>
and
-<code>minsane</code>
+<code class="code">minsane</code>
values specified in the
-<code>tos</code>
+<code class="code">tos</code>
configuration command.
At least
-<code>minsane</code>
+<code class="code">minsane</code>
candidate servers must be available and the mitigation
algorithms produce at least
-<code>minclock</code>
+<code class="code">minclock</code>
survivors in order to synchronize the clock.
Byzantine agreement principles require at least four
candidates in order to correctly discard a single falseticker.
For legacy purposes,
-<code>minsane</code>
+<code class="code">minsane</code>
defaults to 1 and
-<code>minclock</code>
+<code class="code">minclock</code>
defaults to 3.
For manycast service
-<code>minsane</code>
+<code class="code">minsane</code>
should be explicitly set to 4, assuming at least that
number of servers are available.
</p>
<p>If at least
-<code>minclock</code>
+<code class="code">minclock</code>
servers are found, the manycast poll interval is immediately
set to eight times
-<code>maxpoll</code>.
+<code class="code">maxpoll</code>.
If less than
-<code>minclock</code>
+<code class="code">minclock</code>
servers are found when the TTL has reached the maximum hops,
the manycast poll interval is doubled.
For each transmission
after that, the poll interval is doubled again until
reaching the maximum of eight times
-<code>maxpoll</code>.
+<code class="code">maxpoll</code>.
Further transmissions use the same poll interval and
TTL values.
Note that while all this is going on,
in the case of IPv6, the link/site scope prefix.
By default, the increment for TTL hops is 32 starting
from 31; however, the
-<code>ttl</code>
+<code class="code">ttl</code>
configuration command can be
used to modify the values to match the scope rules.
</p>
in TTL range, which is probably not the most common
objective in large networks.
The
-<code>tos</code>
+<code class="code">tos</code>
command can be used to modify this behavior.
Servers with stratum below
-<code>floor</code>
+<code class="code">floor</code>
or above
-<code>ceiling</code>
+<code class="code">ceiling</code>
specified in the
-<code>tos</code>
+<code class="code">tos</code>
command are strongly discouraged during the selection
process; however, these servers may be temporally
accepted if the number of servers within TTL range is
less than
-<code>minclock</code>.
+<code class="code">minclock</code>.
</p>
<p>The above actions occur for each manycast client message,
which repeats at the designated poll interval.
since that would result in a duplicate association.
If during a poll interval the number of client associations
falls below
-<code>minclock</code>,
+<code class="code">minclock</code>,
all manycast client prototype associations are reset
to the initial poll interval and TTL hops and operation
resumes from the beginning.
The result could well be an implosion, either minor or major,
depending on the number of servers in range.
The recommended value for
-<code>maxpoll</code>
+<code class="code">maxpoll</code>
is 12 (4,096 s).
</p>
<p>It is possible and frequently useful to configure a host
dependent clients.
With two exceptions, all servers
and clients have identical configuration files including both
-<code>multicastclient</code>
+<code class="code">multicastclient</code>
and
-<code>multicastserver</code>
+<code class="code">multicastserver</code>
commands using, for instance, multicast group address
239.1.1.1.
The only exception is that each primary server
</p>
<p>The remaining configuration files for all secondary
servers and clients have the same contents, except for the
-<code>tos</code>
+<code class="code">tos</code>
command, which is specific for each stratum level.
For stratum 1 and stratum 2 servers, that command is
not necessary.
For stratum 3 and above servers the
-<code>floor</code>
+<code class="code">floor</code>
value is set to the intended stratum number.
Thus, all stratum 3 configuration files are identical,
all stratum 4 files are identical and so forth.
re-associate accordingly.
</p>
<p>Some administrators prefer to avoid running
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
continuously and run either
-<code>sntp(1sntpmdoc)</code>
+<code class="code">sntp(1sntpmdoc)</code>
or
-<code>ntpd(1ntpdmdoc)</code>
-<code>-q</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
+<code class="code">-q</code>
as a cron job.
In either case the servers must be
configured in advance and the program fails if none are
available when the cron job runs.
A really slick
application of manycast is with
-<code>ntpd(1ntpdmdoc)</code>
-<code>-q</code>.
+<code class="code">ntpd(1ntpdmdoc)</code>
+<code class="code">-q</code>.
The program wakes up, scans the local landscape looking
for the usual suspects, selects the best from among
the rascals, sets the clock and then departs.
Servers do not have to be configured in advance and
all clients throughout the network can have the same
configuration file.
-</p><span id="Manycast-Interactions-with-Autokey"></span><h4 class="subsubsection">1.1.5.2 Manycast Interactions with Autokey</h4>
+</p></div>
+<div class="subsubsection-level-extent" id="Manycast-Interactions-with-Autokey">
+<h4 class="subsubsection"><span>1.1.5.2 Manycast Interactions with Autokey<a class="copiable-link" href="#Manycast-Interactions-with-Autokey"> ¶</a></span></h4>
<p>Each time a manycast client sends a client mode packet
to a multicast group address, all manycast servers
in scope generate a reply including the host name
scheme starts all over from the beginning and
the expanding ring shrinks to the minimum and increments
from there while collecting all servers in scope.
-</p><span id="Broadcast-Options"></span><h4 class="subsubsection">1.1.5.3 Broadcast Options</h4>
-<dl compact="compact">
-<dt><code>tos</code> <code>[<code>bcpollbstep</code> <kbd>gate</kbd>]</code></dt>
+</p></div>
+<div class="subsubsection-level-extent" id="Broadcast-Options">
+<h4 class="subsubsection"><span>1.1.5.3 Broadcast Options<a class="copiable-link" href="#Broadcast-Options"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">tos</code> <code class="code">[<code class="code">bcpollbstep</code> <kbd class="kbd">gate</kbd>]</code></dt>
<dd><p>This command provides a way to delay,
by the specified number of broadcast poll intervals,
believing backward time steps from a broadcast server.
to any number of poll intervals between 0 and 4.
</p></dd>
</dl>
-<span id="Manycast-Options"></span><h4 class="subsubsection">1.1.5.4 Manycast Options</h4>
-<dl compact="compact">
-<dt><code>tos</code> <code>[<code>ceiling</code> <kbd>ceiling</kbd> | <code>cohort</code> <code>{</code> <code>0</code> | <code>1</code> <code>}</code> | <code>floor</code> <kbd>floor</kbd> | <code>minclock</code> <kbd>minclock</kbd> | <code>minsane</code> <kbd>minsane</kbd>]</code></dt>
+</div>
+<div class="subsubsection-level-extent" id="Manycast-Options">
+<h4 class="subsubsection"><span>1.1.5.4 Manycast Options<a class="copiable-link" href="#Manycast-Options"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">tos</code> <code class="code">[<code class="code">ceiling</code> <kbd class="kbd">ceiling</kbd> | <code class="code">cohort</code> <code class="code">{</code> <code class="code">0</code> | <code class="code">1</code> <code class="code">}</code> | <code class="code">floor</code> <kbd class="kbd">floor</kbd> | <code class="code">minclock</code> <kbd class="kbd">minclock</kbd> | <code class="code">minsane</code> <kbd class="kbd">minsane</kbd>]</code></dt>
<dd><p>This command affects the clock selection and clustering
algorithms.
It can be used to select the quality and
and is most useful in manycast mode.
The variables operate
as follows:
-</p><dl compact="compact">
-<dt><code>ceiling</code> <kbd>ceiling</kbd></dt>
+</p><dl class="table">
+<dt><code class="code">ceiling</code> <kbd class="kbd">ceiling</kbd></dt>
<dd><p>Peers with strata above
-<code>ceiling</code>
+<code class="code">ceiling</code>
will be discarded if there are at least
-<code>minclock</code>
+<code class="code">minclock</code>
peers remaining.
This value defaults to 15, but can be changed
to any number from 1 to 15.
</p></dd>
-<dt><code>cohort</code> <code>{0 | 1}</code></dt>
+<dt><code class="code">cohort</code> <code class="code">{0 | 1}</code></dt>
<dd><p>This is a binary flag which enables (0) or disables (1)
manycast server replies to manycast clients with the same
stratum level.
are present.
The default is to enable these replies.
</p></dd>
-<dt><code>floor</code> <kbd>floor</kbd></dt>
+<dt><code class="code">floor</code> <kbd class="kbd">floor</kbd></dt>
<dd><p>Peers with strata below
-<code>floor</code>
+<code class="code">floor</code>
will be discarded if there are at least
-<code>minclock</code>
+<code class="code">minclock</code>
peers remaining.
This value defaults to 1, but can be changed
to any number from 1 to 15.
</p></dd>
-<dt><code>minclock</code> <kbd>minclock</kbd></dt>
+<dt><code class="code">minclock</code> <kbd class="kbd">minclock</kbd></dt>
<dd><p>The clustering algorithm repeatedly casts out outlier
associations until no more than
-<code>minclock</code>
+<code class="code">minclock</code>
associations remain.
This value defaults to 3,
but can be changed to any number from 1 to the number of
configured sources.
</p></dd>
-<dt><code>minsane</code> <kbd>minsane</kbd></dt>
+<dt><code class="code">minsane</code> <kbd class="kbd">minsane</kbd></dt>
<dd><p>This is the minimum number of candidates available
to the clock selection algorithm in order to produce
one or more truechimers for the clustering algorithm.
for legacy purposes.
However, according to principles of
Byzantine agreement,
-<code>minsane</code>
+<code class="code">minsane</code>
should be at least 4 in order to detect and discard
a single falseticker.
</p></dd>
</dl>
</dd>
-<dt><code>ttl</code> <kbd>hop</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">ttl</code> <kbd class="kbd">hop</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>This command specifies a list of TTL values in increasing
order, up to 8 values can be specified.
In manycast mode these values are used in turn
</p></dd>
</dl>
<hr>
-<span id="Reference-Clock-Support"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Reference-Clock-Support">
+<div class="nav-panel">
<p>
-Next: <a href="#Miscellaneous-Options" accesskey="n" rel="next">Miscellaneous Options</a>, Previous: <a href="#Automatic-NTP-Configuration-Options" accesskey="p" rel="prev">Automatic NTP Configuration Options</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#Miscellaneous-Options" accesskey="n" rel="next">Miscellaneous Options</a>, Previous: <a href="#Automatic-NTP-Configuration-Options" accesskey="p" rel="prev">Automatic NTP Configuration Options</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Reference-Clock-Support-1"></span><h4 class="subsection">1.1.6 Reference Clock Support</h4>
+<h4 class="subsection" id="Reference-Clock-Support-1"><span>1.1.6 Reference Clock Support<a class="copiable-link" href="#Reference-Clock-Support-1"> ¶</a></span></h4>
<p>The NTP Version 4 daemon supports some three dozen different radio,
satellite and modem reference clocks plus a special pseudo-clock
used for backup or when no other clock source is available.
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
Additional information can be found in the pages linked
there, including the
"Debugging Hints for Reference Clock Drivers"
pages
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
In addition, support for a PPS
signal is available as described in the
"Pulse-per-second (PPS) Signal Interfacing"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
Many
drivers support special line discipline/streams modules which can
significantly improve the accuracy using the driver.
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
</p>
<p>A reference clock will generally (though not always) be a radio
timecode receiver which is synchronized to a source of standard
hazardous.
</p>
<p>For the purposes of configuration,
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
treats
reference clocks in a manner analogous to normal NTP peers as much
as possible.
correct but invalid IP address, in order to distinguish them from
normal NTP peers.
Reference clock addresses are of the form
-<code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd>,
+<code class="code">127.127.</code><kbd class="kbd">t</kbd>.<kbd class="kbd">u</kbd>,
where
-<kbd>t</kbd>
+<kbd class="kbd">t</kbd>
is an integer
denoting the clock type and
-<kbd>u</kbd>
+<kbd class="kbd">u</kbd>
indicates the unit
number in the range 0-3.
While it may seem overkill, it is in fact
type, in which case the unit numbers must be unique.
</p>
<p>The
-<code>server</code>
+<code class="code">server</code>
command is used to configure a reference
clock, where the
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
argument in that command
is the clock address.
The
-<code>key</code>,
-<code>version</code>
+<code class="code">key</code>,
+<code class="code">version</code>
and
-<code>ttl</code>
+<code class="code">ttl</code>
options are not used for reference clock support.
The
-<code>mode</code>
+<code class="code">mode</code>
option is added for reference clock support, as
described below.
The
-<code>prefer</code>
+<code class="code">prefer</code>
option can be useful to
persuade the server to cherish a reference clock with somewhat more
enthusiasm than other reference clocks or peers.
"Mitigation Rules and the prefer Keyword"
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
+<samp class="file">/usr/share/doc/ntp</samp>)
page.
The
-<code>minpoll</code>
+<code class="code">minpoll</code>
and
-<code>maxpoll</code>
+<code class="code">maxpoll</code>
options have
meaning only for selected clock drivers.
See the individual clock
driver document pages for additional information.
</p>
<p>The
-<code>fudge</code>
+<code class="code">fudge</code>
command is used to provide additional
information for individual clock drivers and normally follows
immediately after the
-<code>server</code>
+<code class="code">server</code>
command.
The
-<kbd>address</kbd>
+<kbd class="kbd">address</kbd>
argument specifies the clock address.
The
-<code>refid</code>
+<code class="code">refid</code>
and
-<code>stratum</code>
+<code class="code">stratum</code>
options can be used to
override the defaults for the device.
There are two optional
device-dependent time offsets and four flags that can be included
in the
-<code>fudge</code>
+<code class="code">fudge</code>
command as well.
</p>
<p>The stratum number of a reference clock is by default zero.
Since the
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
daemon adds one to the stratum of each
peer, a primary server ordinarily displays an external stratum of
one.
In order to provide engineered backups, it is often useful to
specify the reference clock stratum as greater than zero.
The
-<code>stratum</code>
+<code class="code">stratum</code>
option is used for this purpose.
Also, in cases
involving both a reference clock and a pulse-per-second (PPS)
discipline signal, it is useful to specify the reference clock
identifier as other than the default, depending on the driver.
The
-<code>refid</code>
+<code class="code">refid</code>
option is used for this purpose.
Except where noted,
these options apply to all clock drivers.
-</p><span id="Reference-Clock-Commands"></span><h4 class="subsubsection">1.1.6.1 Reference Clock Commands</h4>
-<dl compact="compact">
-<dt><code>server</code> <code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd> <code>[<code>prefer</code>]</code> <code>[<code>mode</code> <kbd>int</kbd>]</code> <code>[<code>minpoll</code> <kbd>int</kbd>]</code> <code>[<code>maxpoll</code> <kbd>int</kbd>]</code></dt>
+</p><ul class="mini-toc">
+<li><a href="#Reference-Clock-Commands" accesskey="1">Reference Clock Commands</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Reference-Clock-Commands">
+<h4 class="subsubsection"><span>1.1.6.1 Reference Clock Commands<a class="copiable-link" href="#Reference-Clock-Commands"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">server</code> <code class="code">127.127.</code><kbd class="kbd">t</kbd>.<kbd class="kbd">u</kbd> <code class="code">[<code class="code">prefer</code>]</code> <code class="code">[<code class="code">mode</code> <kbd class="kbd">int</kbd>]</code> <code class="code">[<code class="code">minpoll</code> <kbd class="kbd">int</kbd>]</code> <code class="code">[<code class="code">maxpoll</code> <kbd class="kbd">int</kbd>]</code></dt>
<dd><p>This command can be used to configure reference clocks in
special ways.
The options are interpreted as follows:
-</p><dl compact="compact">
-<dt><code>prefer</code></dt>
+</p><dl class="table">
+<dt><code class="code">prefer</code></dt>
<dd><p>Marks the reference clock as preferred.
All other things being
equal, this host will be chosen for synchronization among a set of
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
+<samp class="file">/usr/share/doc/ntp</samp>)
for further information.
</p></dd>
-<dt><code>mode</code> <kbd>int</kbd></dt>
+<dt><code class="code">mode</code> <kbd class="kbd">int</kbd></dt>
<dd><p>Specifies a mode number which is interpreted in a
device-specific fashion.
For instance, it selects a dialing
parse
drivers.
</p></dd>
-<dt><code>minpoll</code> <kbd>int</kbd></dt>
-<dt><code>maxpoll</code> <kbd>int</kbd></dt>
+<dt><code class="code">minpoll</code> <kbd class="kbd">int</kbd></dt>
+<dt><code class="code">maxpoll</code> <kbd class="kbd">int</kbd></dt>
<dd><p>These options specify the minimum and maximum polling interval
for reference clock messages, as a power of 2 in seconds
For
most directly connected reference clocks, both
-<code>minpoll</code>
+<code class="code">minpoll</code>
and
-<code>maxpoll</code>
+<code class="code">maxpoll</code>
default to 6 (64 s).
For modem reference clocks,
-<code>minpoll</code>
+<code class="code">minpoll</code>
defaults to 10 (17.1 m) and
-<code>maxpoll</code>
+<code class="code">maxpoll</code>
defaults to 14 (4.5 h).
The allowable range is 4 (16 s) to 17 (36.4 h) inclusive.
</p></dd>
</dl>
</dd>
-<dt><code>fudge</code> <code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd> <code>[<code>time1</code> <kbd>sec</kbd>]</code> <code>[<code>time2</code> <kbd>sec</kbd>]</code> <code>[<code>stratum</code> <kbd>int</kbd>]</code> <code>[<code>refid</code> <kbd>string</kbd>]</code> <code>[<code>mode</code> <kbd>int</kbd>]</code> <code>[<code>flag1</code> <code>0</code> <code>|</code> <code>1</code>]</code> <code>[<code>flag2</code> <code>0</code> <code>|</code> <code>1</code>]</code> <code>[<code>flag3</code> <code>0</code> <code>|</code> <code>1</code>]</code> <code>[<code>flag4</code> <code>0</code> <code>|</code> <code>1</code>]</code></dt>
+<dt><code class="code">fudge</code> <code class="code">127.127.</code><kbd class="kbd">t</kbd>.<kbd class="kbd">u</kbd> <code class="code">[<code class="code">time1</code> <kbd class="kbd">sec</kbd>]</code> <code class="code">[<code class="code">time2</code> <kbd class="kbd">sec</kbd>]</code> <code class="code">[<code class="code">stratum</code> <kbd class="kbd">int</kbd>]</code> <code class="code">[<code class="code">refid</code> <kbd class="kbd">string</kbd>]</code> <code class="code">[<code class="code">mode</code> <kbd class="kbd">int</kbd>]</code> <code class="code">[<code class="code">flag1</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code>]</code> <code class="code">[<code class="code">flag2</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code>]</code> <code class="code">[<code class="code">flag3</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code>]</code> <code class="code">[<code class="code">flag4</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code>]</code></dt>
<dd><p>This command can be used to configure reference clocks in
special ways.
It must immediately follow the
-<code>server</code>
+<code class="code">server</code>
command which configures the driver.
Note that the same capability
is possible at run time using the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
program.
The options are interpreted as
follows:
-</p><dl compact="compact">
-<dt><code>time1</code> <kbd>sec</kbd></dt>
+</p><dl class="table">
+<dt><code class="code">time1</code> <kbd class="kbd">sec</kbd></dt>
<dd><p>Specifies a constant to be added to the time offset produced by
the driver, a fixed-point decimal number in seconds.
This is used
radio clock or PPS signal is supported, a special calibration
feature is available.
It takes the form of an argument to the
-<code>enable</code>
+<code class="code">enable</code>
command described in
-<a href="#Miscellaneous-Options">Miscellaneous Options</a>
+<a class="ref" href="#Miscellaneous-Options">Miscellaneous Options</a>
page and operates as described in the
"Reference Clock Drivers"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp class="file">/usr/share/doc/ntp</samp>).
</p></dd>
-<dt><code>time2</code> <kbd>secs</kbd></dt>
+<dt><code class="code">time2</code> <kbd class="kbd">secs</kbd></dt>
<dd><p>Specifies a fixed-point decimal number in seconds, which is
interpreted in a driver-dependent way.
See the descriptions of
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp> <samp>).</samp>
+<samp class="file">/usr/share/doc/ntp</samp> <samp class="file">).</samp>
</p></dd>
-<dt><code>stratum</code> <kbd>int</kbd></dt>
+<dt><code class="code">stratum</code> <kbd class="kbd">int</kbd></dt>
<dd><p>Specifies the stratum number assigned to the driver, an integer
between 0 and 15.
This number overrides the default stratum number
ordinarily assigned by the driver itself, usually zero.
</p></dd>
-<dt><code>refid</code> <kbd>string</kbd></dt>
+<dt><code class="code">refid</code> <kbd class="kbd">string</kbd></dt>
<dd><p>Specifies an ASCII string of from one to four characters which
defines the reference identifier used by the driver.
This string
overrides the default identifier ordinarily assigned by the driver
itself.
</p></dd>
-<dt><code>mode</code> <kbd>int</kbd></dt>
+<dt><code class="code">mode</code> <kbd class="kbd">int</kbd></dt>
<dd><p>Specifies a mode number which is interpreted in a
device-specific fashion.
For instance, it selects a dialing
parse
drivers.
</p></dd>
-<dt><code>flag1</code> <code>0</code> <code>|</code> <code>1</code></dt>
-<dt><code>flag2</code> <code>0</code> <code>|</code> <code>1</code></dt>
-<dt><code>flag3</code> <code>0</code> <code>|</code> <code>1</code></dt>
-<dt><code>flag4</code> <code>0</code> <code>|</code> <code>1</code></dt>
+<dt><code class="code">flag1</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code></dt>
+<dt><code class="code">flag2</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code></dt>
+<dt><code class="code">flag3</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code></dt>
+<dt><code class="code">flag4</code> <code class="code">0</code> <code class="code">|</code> <code class="code">1</code></dt>
<dd><p>These four flags are used for customizing the clock driver.
The
interpretation of these values, and whether they are used at all,
is a function of the particular clock driver.
However, by
convention
-<code>flag4</code>
+<code class="code">flag4</code>
is used to enable recording monitoring
data to the
-<code>clockstats</code>
+<code class="code">clockstats</code>
file configured with the
-<code>filegen</code>
+<code class="code">filegen</code>
command.
Further information on the
-<code>filegen</code>
+<code class="code">filegen</code>
command can be found in
‘Monitoring Options’.
</p></dd>
</dd>
</dl>
<hr>
-<span id="Miscellaneous-Options"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="Miscellaneous-Options">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002econf-Files" accesskey="n" rel="next">ntp.conf Files</a>, Previous: <a href="#Reference-Clock-Support" accesskey="p" rel="prev">Reference Clock Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#ntp_002econf-Files" accesskey="n" rel="next">ntp.conf Files</a>, Previous: <a href="#Reference-Clock-Support" accesskey="p" rel="prev">Reference Clock Support</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="Miscellaneous-Options-1"></span><h4 class="subsection">1.1.7 Miscellaneous Options</h4>
-<dl compact="compact">
-<dt><code>broadcastdelay</code> <kbd>seconds</kbd></dt>
+<h4 class="subsection" id="Miscellaneous-Options-1"><span>1.1.7 Miscellaneous Options<a class="copiable-link" href="#Miscellaneous-Options-1"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">broadcastdelay</code> <kbd class="kbd">seconds</kbd></dt>
<dd><p>The broadcast and multicast modes require a special calibration
to determine the network delay between the local and remote
servers.
The default
when this command is not used is 0.004 seconds.
</p></dd>
-<dt><code>driftfile</code> <kbd>driftfile</kbd></dt>
+<dt><code class="code">driftfile</code> <kbd class="kbd">driftfile</kbd></dt>
<dd><p>This command specifies the complete path and name of the file used to
record the frequency of the local clock oscillator.
This is the same
operation as the
-<code>-f</code>
+<code class="code">-f</code>
command line option.
If the file exists, it is read at
startup in order to set the initial frequency and then updated once per
the current drift value into a temporary file and then renaming
this file to replace the old version.
This implies that
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
must have write permission for the directory the
drift file is located in, and that file system links, symbolic or
otherwise, should be avoided.
</p></dd>
-<dt><code>dscp</code> <kbd>value</kbd></dt>
+<dt><code class="code">dscp</code> <kbd class="kbd">value</kbd></dt>
<dd><p>This option specifies the Differentiated Services Control Point (DSCP) value,
a 6-bit code.
The default value is 46, signifying Expedited Forwarding.
</p></dd>
-<dt><code>enable</code> <code>[<code>auth</code> | <code>bclient</code> | <code>calibrate</code> | <code>kernel</code> | <code>mode7</code> | <code>monitor</code> | <code>ntp</code> | <code>stats</code> | <code>peer_clear_digest_early</code> | <code>unpeer_crypto_early</code> | <code>unpeer_crypto_nak_early</code> | <code>unpeer_digest_early</code>]</code></dt>
-<dt><code>disable</code> <code>[<code>auth</code> | <code>bclient</code> | <code>calibrate</code> | <code>kernel</code> | <code>mode7</code> | <code>monitor</code> | <code>ntp</code> | <code>stats</code> | <code>peer_clear_digest_early</code> | <code>unpeer_crypto_early</code> | <code>unpeer_crypto_nak_early</code> | <code>unpeer_digest_early</code>]</code></dt>
+<dt><code class="code">enable</code> <code class="code">[<code class="code">auth</code> | <code class="code">bclient</code> | <code class="code">calibrate</code> | <code class="code">kernel</code> | <code class="code">mode7</code> | <code class="code">monitor</code> | <code class="code">ntp</code> | <code class="code">stats</code> | <code class="code">peer_clear_digest_early</code> | <code class="code">unpeer_crypto_early</code> | <code class="code">unpeer_crypto_nak_early</code> | <code class="code">unpeer_digest_early</code>]</code></dt>
+<dt><code class="code">disable</code> <code class="code">[<code class="code">auth</code> | <code class="code">bclient</code> | <code class="code">calibrate</code> | <code class="code">kernel</code> | <code class="code">mode7</code> | <code class="code">monitor</code> | <code class="code">ntp</code> | <code class="code">stats</code> | <code class="code">peer_clear_digest_early</code> | <code class="code">unpeer_crypto_early</code> | <code class="code">unpeer_crypto_nak_early</code> | <code class="code">unpeer_digest_early</code>]</code></dt>
<dd><p>Provides a way to enable or disable various server options.
Flags not mentioned are unaffected.
Note that all of these flags
can be controlled remotely using the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility program.
-</p><dl compact="compact">
-<dt><code>auth</code></dt>
+</p><dl class="table">
+<dt><code class="code">auth</code></dt>
<dd><p>Enables the server to synchronize with unconfigured peers only if the
peer has been correctly authenticated using either public key or
private key cryptography.
The default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>bclient</code></dt>
+<dt><code class="code">bclient</code></dt>
<dd><p>Enables the server to listen for a message from a broadcast or
multicast server, as in the
-<code>multicastclient</code>
+<code class="code">multicastclient</code>
command with default
address.
The default for this flag is
-<code>disable</code>.
+<code class="code">disable</code>.
</p></dd>
-<dt><code>calibrate</code></dt>
+<dt><code class="code">calibrate</code></dt>
<dd><p>Enables the calibrate feature for reference clocks.
The default for
this flag is
-<code>disable</code>.
+<code class="code">disable</code>.
</p></dd>
-<dt><code>kernel</code></dt>
+<dt><code class="code">kernel</code></dt>
<dd><p>Enables the kernel time discipline, if available.
The default for this
flag is
-<code>enable</code>
+<code class="code">enable</code>
if support is available, otherwise
-<code>disable</code>.
+<code class="code">disable</code>.
</p></dd>
-<dt><code>mode7</code></dt>
+<dt><code class="code">mode7</code></dt>
<dd><p>Enables processing of NTP mode 7 implementation-specific requests
which are used by the deprecated
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
program.
The default for this flag is disable.
This flag is excluded from runtime configuration using
-<code>ntpq(1ntpqmdoc)</code>.
+<code class="code">ntpq(1ntpqmdoc)</code>.
The
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
program provides the same capabilities as
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
using standard mode 6 requests.
</p></dd>
-<dt><code>monitor</code></dt>
+<dt><code class="code">monitor</code></dt>
<dd><p>Enables the monitoring facility.
See the
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
program
and the
-<code>monlist</code>
+<code class="code">monlist</code>
command or further information.
The
default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>ntp</code></dt>
+<dt><code class="code">ntp</code></dt>
<dd><p>Enables time and frequency discipline.
In effect, this switch opens and
closes the feedback loop, which is useful for testing.
The default for
this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>peer_clear_digest_early</code></dt>
+<dt><code class="code">peer_clear_digest_early</code></dt>
<dd><p>By default, if
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
is using autokey and it
receives a crypto-NAK packet that
passes the duplicate packet and origin timestamp checks
then you should consider
disabling this option.
You can check your
-<code>peerstats</code>
+<code class="code">peerstats</code>
file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>stats</code></dt>
+<dt><code class="code">stats</code></dt>
<dd><p>Enables the statistics facility.
See the
‘Monitoring Options’
section for further information.
The default for this flag is
-<code>disable</code>.
+<code class="code">disable</code>.
</p></dd>
-<dt><code>unpeer_crypto_early</code></dt>
+<dt><code class="code">unpeer_crypto_early</code></dt>
<dd><p>By default, if
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
receives an autokey packet that fails TEST9,
a crypto failure,
the association is immediately cleared.
tearing down the association until the reachability counter
becomes zero.
You can check your
-<code>peerstats</code>
+<code class="code">peerstats</code>
file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>unpeer_crypto_nak_early</code></dt>
+<dt><code class="code">unpeer_crypto_nak_early</code></dt>
<dd><p>By default, if
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
receives a crypto-NAK packet that
passes the duplicate packet and origin timestamp checks
the association is immediately cleared.
then you should consider
disabling this option.
You can check your
-<code>peerstats</code>
+<code class="code">peerstats</code>
file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
-<dt><code>unpeer_digest_early</code></dt>
+<dt><code class="code">unpeer_digest_early</code></dt>
<dd><p>By default, if
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
receives what should be an authenticated packet
that passes other packet sanity checks but
contains an invalid digest
then you should consider
disabling this option.
You can check your
-<code>peerstats</code>
+<code class="code">peerstats</code>
file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
+<code class="code">enable</code>.
</p></dd>
</dl>
</dd>
-<dt><code>includefile</code> <kbd>includefile</kbd></dt>
+<dt><code class="code">includefile</code> <kbd class="kbd">includefile</kbd></dt>
<dd><p>This command allows additional configuration commands
to be included from a separate file.
Include files may
include file, command processing resumes in the previous
configuration file.
This option is useful for sites that run
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
on multiple hosts, with (mostly) common options (e.g., a
restriction list).
</p></dd>
-<dt><code>interface</code> <code>[<code>listen</code> | <code>ignore</code> | <code>drop</code>]</code> <code>[<code>all</code> | <code>ipv4</code> | <code>ipv6</code> | <code>wildcard</code> <kbd>name</kbd> | <kbd>address</kbd> <code>[<code>/</code> <kbd>prefixlen</kbd>]</code>]</code></dt>
+<dt><code class="code">interface</code> <code class="code">[<code class="code">listen</code> | <code class="code">ignore</code> | <code class="code">drop</code>]</code> <code class="code">[<code class="code">all</code> | <code class="code">ipv4</code> | <code class="code">ipv6</code> | <code class="code">wildcard</code> <kbd class="kbd">name</kbd> | <kbd class="kbd">address</kbd> <code class="code">[<code class="code">/</code> <kbd class="kbd">prefixlen</kbd>]</code>]</code></dt>
<dd><p>The
-<code>interface</code>
+<code class="code">interface</code>
directive controls which network addresses
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
opens, and whether input is dropped without processing.
The first parameter determines the action for addresses
which match the second parameter.
or a specific interface name,
or an address.
In the address case,
-<kbd>prefixlen</kbd>
+<kbd class="kbd">prefixlen</kbd>
determines how many bits must match for this rule to apply.
-<code>ignore</code>
+<code class="code">ignore</code>
prevents opening matching addresses,
-<code>drop</code>
+<code class="code">drop</code>
causes
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
to open the address and drop all received packets without examination.
Multiple
-<code>interface</code>
+<code class="code">interface</code>
directives can be used.
The last rule which matches a particular address determines the action for it.
-<code>interface</code>
+<code class="code">interface</code>
directives are disabled if any
-<code>-I</code>,
-<code>--interface</code>,
-<code>-L</code>,
+<code class="code">-I</code>,
+<code class="code">--interface</code>,
+<code class="code">-L</code>,
or
-<code>--novirtualips</code>
+<code class="code">--novirtualips</code>
command-line options are specified in the configuration file,
all available network addresses are opened.
The
-<code>nic</code>
+<code class="code">nic</code>
directive is an alias for
-<code>interface</code>.
+<code class="code">interface</code>.
</p></dd>
-<dt><code>leapfile</code> <kbd>leapfile</kbd></dt>
+<dt><code class="code">leapfile</code> <kbd class="kbd">leapfile</kbd></dt>
<dd><p>This command loads the IERS leapseconds file and initializes the
leapsecond values for the next leapsecond event, leapfile expiration
time, and TAI offset.
The file can be obtained directly from the IERS at
-<code>https://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list</code>
+<code class="code">https://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list</code>
or
-<code>ftp://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list</code>.
+<code class="code">ftp://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list</code>.
The
-<code>leapfile</code>
+<code class="code">leapfile</code>
is scanned when
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
processes the
-<code>leapfile</code> <code>directive</code> <code>or</code> <code>when</code>
-<code>ntpd</code> <code>detects</code> <code>that</code> <code>the</code>
-<kbd>leapfile</kbd>
+<code class="code">leapfile</code> <code class="code">directive</code> <code class="code">or</code> <code class="code">when</code>
+<code class="code">ntpd</code> <code class="code">detects</code> <code class="code">that</code> <code class="code">the</code>
+<kbd class="kbd">leapfile</kbd>
has changed.
-<code>ntpd</code>
+<code class="code">ntpd</code>
checks once a day to see if the
-<kbd>leapfile</kbd>
+<kbd class="kbd">leapfile</kbd>
has changed.
The
-<code>update-leap(1update_leapmdoc)</code>
+<code class="code">update-leap(1update_leapmdoc)</code>
script can be run to see if the
-<kbd>leapfile</kbd>
+<kbd class="kbd">leapfile</kbd>
should be updated.
</p></dd>
-<dt><code>leapsmearinterval</code> <kbd>seconds</kbd></dt>
+<dt><code class="code">leapsmearinterval</code> <kbd class="kbd">seconds</kbd></dt>
<dd><p>This EXPERIMENTAL option is only available if
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
was built with the
-<code>--enable-leap-smear</code>
+<code class="code">--enable-leap-smear</code>
option to the
-<code>configure</code>
+<code class="code">configure</code>
script.
It specifies the interval over which a leap second correction will be applied.
Recommended values for this option are between
.Sy DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS!
See http://bugs.ntp.org/2855 for more information.
</p></dd>
-<dt><code>logconfig</code> <kbd>configkeyword</kbd></dt>
+<dt><code class="code">logconfig</code> <kbd class="kbd">configkeyword</kbd></dt>
<dd><p>This command controls the amount and type of output written to
the system
-<code>syslog(3)</code>
+<code class="code">syslog(3)</code>
facility or the alternate
-<code>logfile</code>
+<code class="code">logfile</code>
log file.
By default, all output is turned on.
All
-<kbd>configkeyword</kbd>
+<kbd class="kbd">configkeyword</kbd>
keywords can be prefixed with
‘=’,
‘+’
where
‘=’
sets the
-<code>syslog(3)</code>
+<code class="code">syslog(3)</code>
priority mask,
‘+’
adds and
‘-’
removes
messages.
-<code>syslog(3)</code>
+<code class="code">syslog(3)</code>
messages can be controlled in four
classes
-(<code>clock</code>, <code>peer</code>, <code>sys</code> and <code>sync</code>).
+(<code class="code">clock</code>, <code class="code">peer</code>, <code class="code">sys</code> and <code class="code">sync</code>).
Within these classes four types of messages can be
controlled: informational messages
-(<code>info</code>),
+(<code class="code">info</code>),
event messages
-(<code>events</code>),
+(<code class="code">events</code>),
statistics messages
-(<code>statistics</code>)
+(<code class="code">statistics</code>)
and
status messages
-(<code>status</code>).
+(<code class="code">status</code>).
</p>
<p>Configuration keywords are formed by concatenating the message class with
the event class.
The
-<code>all</code>
+<code class="code">all</code>
prefix can be used instead of a message class.
A
message class may also be followed by the
-<code>all</code>
+<code class="code">all</code>
keyword to enable/disable all
messages of the respective message class.
Thus, a minimal log configuration
</p><pre class="verbatim">logconfig =syncstatus +sysevents
</pre>
<p>This would just list the synchronizations state of
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
and the major system events.
For a simple reference server, the
following minimum message configuration could be useful:
All other events and messages about
peers, system events and so on is suppressed.
</p></dd>
-<dt><code>logfile</code> <kbd>logfile</kbd></dt>
+<dt><code class="code">logfile</code> <kbd class="kbd">logfile</kbd></dt>
<dd><p>This command specifies the location of an alternate log file to
be used instead of the default system
-<code>syslog(3)</code>
+<code class="code">syslog(3)</code>
facility.
This is the same operation as the
-<code>-l</code>
+<code class="code">-l</code>
command line option.
</p></dd>
-<dt><code>mru</code> <code>[<code>maxdepth</code> <kbd>count</kbd> | <code>maxmem</code> <kbd>kilobytes</kbd> | <code>mindepth</code> <kbd>count</kbd> | <code>maxage</code> <kbd>seconds</kbd> | <code>initialloc</code> <kbd>count</kbd> | <code>initmem</code> <kbd>kilobytes</kbd> | <code>incalloc</code> <kbd>count</kbd> | <code>incmem</code> <kbd>kilobytes</kbd>]</code></dt>
+<dt><code class="code">mru</code> <code class="code">[<code class="code">maxdepth</code> <kbd class="kbd">count</kbd> | <code class="code">maxmem</code> <kbd class="kbd">kilobytes</kbd> | <code class="code">mindepth</code> <kbd class="kbd">count</kbd> | <code class="code">maxage</code> <kbd class="kbd">seconds</kbd> | <code class="code">initialloc</code> <kbd class="kbd">count</kbd> | <code class="code">initmem</code> <kbd class="kbd">kilobytes</kbd> | <code class="code">incalloc</code> <kbd class="kbd">count</kbd> | <code class="code">incmem</code> <kbd class="kbd">kilobytes</kbd>]</code></dt>
<dd><p>Controls size limite of the monitoring facility’s Most Recently Used
(MRU) list
of client addresses, which is also used by the
rate control facility.
-</p><dl compact="compact">
-<dt><code>maxdepth</code> <kbd>count</kbd></dt>
-<dt><code>maxmem</code> <kbd>kilobytes</kbd></dt>
+</p><dl class="table">
+<dt><code class="code">maxdepth</code> <kbd class="kbd">count</kbd></dt>
+<dt><code class="code">maxmem</code> <kbd class="kbd">kilobytes</kbd></dt>
<dd><p>Equivalent upper limits on the size of the MRU list, in terms of entries or kilobytes.
The acutal limit will be up to
-<code>incalloc</code>
+<code class="code">incalloc</code>
entries or
-<code>incmem</code>
+<code class="code">incmem</code>
kilobytes larger.
As with all of the
-<code>mru</code>
+<code class="code">mru</code>
options offered in units of entries or kilobytes, if both
-<code>maxdepth</code>
+<code class="code">maxdepth</code>
and
-<code>maxmem</code> <code>are</code> <code>used,</code> <code>the</code> <code>last</code> <code>one</code> <code>used</code> <code>controls.</code>
+<code class="code">maxmem</code> <code class="code">are</code> <code class="code">used,</code> <code class="code">the</code> <code class="code">last</code> <code class="code">one</code> <code class="code">used</code> <code class="code">controls.</code>
The default is 1024 kilobytes.
</p></dd>
-<dt><code>mindepth</code> <kbd>count</kbd></dt>
+<dt><code class="code">mindepth</code> <kbd class="kbd">count</kbd></dt>
<dd><p>Lower limit on the MRU list size.
When the MRU list has fewer than
-<code>mindepth</code>
+<code class="code">mindepth</code>
entries, existing entries are never removed to make room for newer ones,
regardless of their age.
The default is 600 entries.
</p></dd>
-<dt><code>maxage</code> <kbd>seconds</kbd></dt>
+<dt><code class="code">maxage</code> <kbd class="kbd">seconds</kbd></dt>
<dd><p>Once the MRU list has
-<code>mindepth</code>
+<code class="code">mindepth</code>
entries and an additional client is to ba added to the list,
if the oldest entry was updated more than
-<code>maxage</code>
+<code class="code">maxage</code>
seconds ago, that entry is removed and its storage is reused.
If the oldest entry was updated more recently the MRU list is grown,
subject to
-<code>maxdepth</code> <code>/</code> <code>moxmem</code>.
+<code class="code">maxdepth</code> <code class="code">/</code> <code class="code">moxmem</code>.
The default is 64 seconds.
</p></dd>
-<dt><code>initalloc</code> <kbd>count</kbd></dt>
-<dt><code>initmem</code> <kbd>kilobytes</kbd></dt>
+<dt><code class="code">initalloc</code> <kbd class="kbd">count</kbd></dt>
+<dt><code class="code">initmem</code> <kbd class="kbd">kilobytes</kbd></dt>
<dd><p>Initial memory allocation at the time the monitoringfacility is first enabled,
in terms of the number of entries or kilobytes.
The default is 4 kilobytes.
</p></dd>
-<dt><code>incalloc</code> <kbd>count</kbd></dt>
-<dt><code>incmem</code> <kbd>kilobytes</kbd></dt>
+<dt><code class="code">incalloc</code> <kbd class="kbd">count</kbd></dt>
+<dt><code class="code">incmem</code> <kbd class="kbd">kilobytes</kbd></dt>
<dd><p>Size of additional memory allocations when growing the MRU list, in entries or kilobytes.
The default is 4 kilobytes.
</p></dd>
</dl>
</dd>
-<dt><code>nonvolatile</code> <kbd>threshold</kbd></dt>
+<dt><code class="code">nonvolatile</code> <kbd class="kbd">threshold</kbd></dt>
<dd><p>Specify the
-<kbd>threshold</kbd>
+<kbd class="kbd">threshold</kbd>
delta in seconds before an hourly change to the
-<code>driftfile</code>
+<code class="code">driftfile</code>
(frequency file) will be written, with a default value of 1e-7 (0.1 PPM).
The frequency file is inspected each hour.
If the difference between the current frequency and the last value written
exceeds the threshold, the file is written and the
-<code>threshold</code>
+<code class="code">threshold</code>
becomes the new threshold value.
If the threshold is not exceeeded, it is reduced by half.
This is intended to reduce the number of file writes
for embedded systems with nonvolatile memory.
</p></dd>
-<dt><code>phone</code> <kbd>dial</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">phone</code> <kbd class="kbd">dial</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>This command is used in conjunction with
the ACTS modem driver (type 18)
or the JJY driver (type 40, mode 100 - 180).
The Hayes command ATDT is normally prepended to the number.
The number can contain other modem control codes as well.
</p></dd>
-<dt><code>pollskewlist</code> <code>[<kbd>poll</kbd> <kbd>early</kbd> <kbd>late</kbd>]</code> <kbd>...</kbd> <code>[<code>default</code> <kbd>early</kbd> <kbd>late</kbd>]</code></dt>
+<dt><code class="code">pollskewlist</code> <code class="code">[<kbd class="kbd">poll</kbd> <kbd class="kbd">early</kbd> <kbd class="kbd">late</kbd>]</code> <kbd class="kbd">...</kbd> <code class="code">[<code class="code">default</code> <kbd class="kbd">early</kbd> <kbd class="kbd">late</kbd>]</code></dt>
<dd><p>Enable skewing of our poll requests to our servers.
-<kbd>poll</kbd>
+<kbd class="kbd">poll</kbd>
is a number between 3 and 17 inclusive, identifying a specific poll interval.
A poll interval is 2^n seconds in duration,
so a poll value of 3 corresponds to 8 seconds
specifies how late the poll may be delayed.
With no arguments, internally specified default values are chosen.
</p></dd>
-<dt><code>reset</code> <code>[<code>allpeers</code>]</code> <code>[<code>auth</code>]</code> <code>[<code>ctl</code>]</code> <code>[<code>io</code>]</code> <code>[<code>mem</code>]</code> <code>[<code>sys</code>]</code> <code>[<code>timer</code>]</code></dt>
+<dt><code class="code">reset</code> <code class="code">[<code class="code">allpeers</code>]</code> <code class="code">[<code class="code">auth</code>]</code> <code class="code">[<code class="code">ctl</code>]</code> <code class="code">[<code class="code">io</code>]</code> <code class="code">[<code class="code">mem</code>]</code> <code class="code">[<code class="code">sys</code>]</code> <code class="code">[<code class="code">timer</code>]</code></dt>
<dd><p>Reset one or more groups of counters maintained by
-<code>ntpd</code>
+<code class="code">ntpd</code>
and exposed by
-<code>ntpq</code>
+<code class="code">ntpq</code>
and
-<code>ntpdc</code>.
+<code class="code">ntpdc</code>.
</p></dd>
-<dt><code>rlimit</code> <code>[<code>memlock</code> <kbd>Nmegabytes</kbd> | <code>stacksize</code> <kbd>N4kPages</kbd> <code>filenum</code> <kbd>Nfiledescriptors</kbd>]</code></dt>
-<dd><dl compact="compact">
-<dt><code>memlock</code> <kbd>Nmegabytes</kbd></dt>
+<dt><code class="code">rlimit</code> <code class="code">[<code class="code">memlock</code> <kbd class="kbd">Nmegabytes</kbd> | <code class="code">stacksize</code> <kbd class="kbd">N4kPages</kbd> <code class="code">filenum</code> <kbd class="kbd">Nfiledescriptors</kbd>]</code></dt>
+<dd><dl class="table">
+<dt><code class="code">memlock</code> <kbd class="kbd">Nmegabytes</kbd></dt>
<dd><p>Specify the number of megabytes of memory that should be
allocated and locked.
Probably only available under Linux, this option may be useful
when dropping root (the
-<code>-i</code>
+<code class="code">-i</code>
option).
The default is 32 megabytes on non-Linux machines, and -1 under Linux.
-1 means "do not lock the process into memory".
0 means "lock whatever memory the process wants into memory".
</p></dd>
-<dt><code>stacksize</code> <kbd>N4kPages</kbd></dt>
+<dt><code class="code">stacksize</code> <kbd class="kbd">N4kPages</kbd></dt>
<dd><p>Specifies the maximum size of the process stack on systems with the
-<code>mlockall()</code>
+<code class="code">mlockall()</code>
function.
Defaults to 50 4k pages (200 4k pages in OpenBSD).
</p></dd>
-<dt><code>filenum</code> <kbd>Nfiledescriptors</kbd></dt>
+<dt><code class="code">filenum</code> <kbd class="kbd">Nfiledescriptors</kbd></dt>
<dd><p>Specifies the maximum number of file descriptors ntpd may have open at once.
Defaults to the system default.
</p></dd>
</dl>
</dd>
-<dt><code>saveconfigdir</code> <kbd>directory_path</kbd></dt>
+<dt><code class="code">saveconfigdir</code> <kbd class="kbd">directory_path</kbd></dt>
<dd><p>Specify the directory in which to write configuration snapshots
requested with
.Cm ntpq ’s
-<code>saveconfig</code>
+<code class="code">saveconfig</code>
command.
If
-<code>saveconfigdir</code>
+<code class="code">saveconfigdir</code>
does not appear in the configuration file,
-<code>saveconfig</code>
+<code class="code">saveconfig</code>
requests are rejected by
-<code>ntpd</code>.
+<code class="code">ntpd</code>.
</p></dd>
-<dt><code>saveconfig</code> <kbd>filename</kbd></dt>
+<dt><code class="code">saveconfig</code> <kbd class="kbd">filename</kbd></dt>
<dd><p>Write the current configuration, including any runtime
modifications given with
-<code>:config</code>
+<code class="code">:config</code>
or
-<code>config-from-file</code>
+<code class="code">config-from-file</code>
to the
-<code>ntpd</code>
+<code class="code">ntpd</code>
host’s
-<kbd>filename</kbd>
+<kbd class="kbd">filename</kbd>
in the
-<code>saveconfigdir</code>.
+<code class="code">saveconfigdir</code>.
This command will be rejected unless the
-<code>saveconfigdir</code>
+<code class="code">saveconfigdir</code>
directive appears in
.Cm ntpd ’s
configuration file.
-<kbd>filename</kbd>
+<kbd class="kbd">filename</kbd>
can use
-<code>strftime(3)</code>
+<code class="code">strftime(3)</code>
format directives to substitute the current date and time,
for example,
-<code>saveconfig\ ntp-%Y%m%d-%H%M%S.conf</code>.
+<code class="code">saveconfig\ ntp-%Y%m%d-%H%M%S.conf</code>.
The filename used is stored in the system variable
-<code>savedconfig</code>.
+<code class="code">savedconfig</code>.
Authentication is required.
</p></dd>
-<dt><code>setvar</code> <kbd>variable</kbd> <code>[<code>default</code>]</code></dt>
+<dt><code class="code">setvar</code> <kbd class="kbd">variable</kbd> <code class="code">[<code class="code">default</code>]</code></dt>
<dd><p>This command adds an additional system variable.
These
variables can be used to distribute additional information such as
the access policy.
If the variable of the form
-<code>name</code><code>=</code><kbd>value</kbd>
+<code class="code">name</code><code class="code">=</code><kbd class="kbd">value</kbd>
is followed by the
-<code>default</code>
+<code class="code">default</code>
keyword, the
variable will be listed as part of the default system variables
-(<code>rv</code> command)).
+(<code class="code">rv</code> command)).
These additional variables serve
informational purposes only.
They are not related to the protocol
other that they can be listed.
The known protocol variables will
always override any variables defined via the
-<code>setvar</code>
+<code class="code">setvar</code>
mechanism.
There are three special variables that contain the names
of all variable of the same group.
The
-<code>sys_var_list</code>
+<code class="code">sys_var_list</code>
holds
the names of all system variables.
The
-<code>peer_var_list</code>
+<code class="code">peer_var_list</code>
holds
the names of all peer variables and the
-<code>clock_var_list</code>
+<code class="code">clock_var_list</code>
holds the names of the reference clock variables.
</p></dd>
-<dt><code>sysinfo</code></dt>
+<dt><code class="code">sysinfo</code></dt>
<dd><p>Display operational summary.
</p></dd>
-<dt><code>sysstats</code></dt>
+<dt><code class="code">sysstats</code></dt>
<dd><p>Show statistics counters maintained in the protocol module.
</p></dd>
-<dt><code>tinker</code> <code>[<code>allan</code> <kbd>allan</kbd> | <code>dispersion</code> <kbd>dispersion</kbd> | <code>freq</code> <kbd>freq</kbd> | <code>huffpuff</code> <kbd>huffpuff</kbd> | <code>panic</code> <kbd>panic</kbd> | <code>step</code> <kbd>step</kbd> | <code>stepback</code> <kbd>stepback</kbd> | <code>stepfwd</code> <kbd>stepfwd</kbd> | <code>stepout</code> <kbd>stepout</kbd>]</code></dt>
+<dt><code class="code">tinker</code> <code class="code">[<code class="code">allan</code> <kbd class="kbd">allan</kbd> | <code class="code">dispersion</code> <kbd class="kbd">dispersion</kbd> | <code class="code">freq</code> <kbd class="kbd">freq</kbd> | <code class="code">huffpuff</code> <kbd class="kbd">huffpuff</kbd> | <code class="code">panic</code> <kbd class="kbd">panic</kbd> | <code class="code">step</code> <kbd class="kbd">step</kbd> | <code class="code">stepback</code> <kbd class="kbd">stepback</kbd> | <code class="code">stepfwd</code> <kbd class="kbd">stepfwd</kbd> | <code class="code">stepout</code> <kbd class="kbd">stepout</kbd>]</code></dt>
<dd><p>This command can be used to alter several system variables in
very exceptional circumstances.
It should occur in the
no help from the support group.
</p>
<p>The variables operate as follows:
-</p><dl compact="compact">
-<dt><code>allan</code> <kbd>allan</kbd></dt>
+</p><dl class="table">
+<dt><code class="code">allan</code> <kbd class="kbd">allan</kbd></dt>
<dd><p>The argument becomes the new value for the minimum Allan
intercept, which is a parameter of the PLL/FLL clock discipline
algorithm.
The value in log2 seconds defaults to 7 (1024 s), which is also the lower
limit.
</p></dd>
-<dt><code>dispersion</code> <kbd>dispersion</kbd></dt>
+<dt><code class="code">dispersion</code> <kbd class="kbd">dispersion</kbd></dt>
<dd><p>The argument becomes the new value for the dispersion increase rate,
normally .000015 s/s.
</p></dd>
-<dt><code>freq</code> <kbd>freq</kbd></dt>
+<dt><code class="code">freq</code> <kbd class="kbd">freq</kbd></dt>
<dd><p>The argument becomes the initial value of the frequency offset in
parts-per-million.
This overrides the value in the frequency file, if
present, and avoids the initial training state if it is not.
</p></dd>
-<dt><code>huffpuff</code> <kbd>huffpuff</kbd></dt>
+<dt><code class="code">huffpuff</code> <kbd class="kbd">huffpuff</kbd></dt>
<dd><p>The argument becomes the new value for the experimental
huff-n’-puff filter span, which determines the most recent interval
the algorithm will search for a minimum delay.
is no default, since the filter is not enabled unless this command
is given.
</p></dd>
-<dt><code>panic</code> <kbd>panic</kbd></dt>
+<dt><code class="code">panic</code> <kbd class="kbd">panic</kbd></dt>
<dd><p>The argument is the panic threshold, normally 1000 s.
If set to zero,
the panic sanity check is disabled and a clock offset of any value will
be accepted.
</p></dd>
-<dt><code>step</code> <kbd>step</kbd></dt>
+<dt><code class="code">step</code> <kbd class="kbd">step</kbd></dt>
<dd><p>The argument is the step threshold, which by default is 0.128 s.
It can
be set to any positive number in seconds.
disabled if the step threshold is set to zero or greater than the
default.
</p></dd>
-<dt><code>stepback</code> <kbd>stepback</kbd></dt>
+<dt><code class="code">stepback</code> <kbd class="kbd">stepback</kbd></dt>
<dd><p>The argument is the step threshold for the backward direction,
which by default is 0.128 s.
It can
each direction of step threshold are either
set to zero or greater than .5 second.
</p></dd>
-<dt><code>stepfwd</code> <kbd>stepfwd</kbd></dt>
+<dt><code class="code">stepfwd</code> <kbd class="kbd">stepfwd</kbd></dt>
<dd><p>As for stepback, but for the forward direction.
</p></dd>
-<dt><code>stepout</code> <kbd>stepout</kbd></dt>
+<dt><code class="code">stepout</code> <kbd class="kbd">stepout</kbd></dt>
<dd><p>The argument is the stepout timeout, which by default is 900 s.
It can
be set to any positive number in seconds.
</p></dd>
</dl>
</dd>
-<dt><code>writevar</code> <kbd>assocID\ name</kbd> <kbd>=</kbd> <kbd>value</kbd> <kbd>[,...]</kbd></dt>
+<dt><code class="code">writevar</code> <kbd class="kbd">assocID\ name</kbd> <kbd class="kbd">=</kbd> <kbd class="kbd">value</kbd> <kbd class="kbd">[,...]</kbd></dt>
<dd><p>Write (create or update) the specified variables.
If the
-<code>assocID</code>
+<code class="code">assocID</code>
is zero, the variablea re from the
system variables
name space, otherwise they are from the
peer variables
name space.
The
-<code>assocID</code>
+<code class="code">assocID</code>
is required, as the same name can occur in both name spaces.
</p></dd>
-<dt><code>trap</code> <kbd>host_address</kbd> <code>[<code>port</code> <kbd>port_number</kbd>]</code> <code>[<code>interface</code> <kbd>interface_address</kbd>]</code></dt>
+<dt><code class="code">trap</code> <kbd class="kbd">host_address</kbd> <code class="code">[<code class="code">port</code> <kbd class="kbd">port_number</kbd>]</code> <code class="code">[<code class="code">interface</code> <kbd class="kbd">interface_address</kbd>]</code></dt>
<dd><p>This command configures a trap receiver at the given host
address and port number for sending messages with the specified
local interface address.
Note that on a multihomed host the
interface used may vary from time to time with routing changes.
</p></dd>
-<dt><code>ttl</code> <kbd>hop</kbd> <kbd>...</kbd></dt>
+<dt><code class="code">ttl</code> <kbd class="kbd">hop</kbd> <kbd class="kbd">...</kbd></dt>
<dd><p>This command specifies a list of TTL values in increasing order.
Up to 8 values can be specified.
In
-<code>manycast</code>
+<code class="code">manycast</code>
mode these values are used in-turn in an expanding-ring search.
The default is eight multiples of 32 starting at 31.
</p>
trap receiver will ensure that no messages are lost when the server
is started.
</p></dd>
-<dt><code>hop</code> <kbd>...</kbd></dt>
+<dt><code class="code">hop</code> <kbd class="kbd">...</kbd></dt>
<dd><p>This command specifies a list of TTL values in increasing order, up to 8
values can be specified.
In manycast mode these values are used in turn in
</p></dd>
</dl>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.conf</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntp.conf</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Files" accesskey="1">ntp.conf Files</a></td><td> </td><td align="left" valign="top">Files
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-See-Also" accesskey="2">ntp.conf See Also</a></td><td> </td><td align="left" valign="top">See Also
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Bugs" accesskey="3">ntp.conf Bugs</a></td><td> </td><td align="left" valign="top">Bugs
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002econf-Notes" accesskey="4">ntp.conf Notes</a></td><td> </td><td align="left" valign="top">Notes
-</td></tr>
-</table>
<hr>
-<span id="ntp_002econf-Files"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002econf-Files">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002econf-See-Also" accesskey="n" rel="next">ntp.conf See Also</a>, Previous: <a href="#Miscellaneous-Options" accesskey="p" rel="prev">Miscellaneous Options</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#ntp_002econf-See-Also" accesskey="n" rel="next">ntp.conf See Also</a>, Previous: <a href="#Miscellaneous-Options" accesskey="p" rel="prev">Miscellaneous Options</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="ntp_002econf-Files-1"></span><h4 class="subsection">1.1.8 ntp.conf Files</h4>
-<dl compact="compact">
-<dt><samp>/etc/ntp.conf</samp></dt>
+<h4 class="subsection" id="ntp_002econf-Files-1"><span>1.1.8 ntp.conf Files<a class="copiable-link" href="#ntp_002econf-Files-1"> ¶</a></span></h4>
+<dl class="table">
+<dt><samp class="file">/etc/ntp.conf</samp></dt>
<dd><p>the default name of the configuration file
</p></dd>
-<dt><samp>ntp.keys</samp></dt>
+<dt><samp class="file">ntp.keys</samp></dt>
<dd><p>private MD5 keys
</p></dd>
-<dt><samp>ntpkey</samp></dt>
+<dt><samp class="file">ntpkey</samp></dt>
<dd><p>RSA private key
</p></dd>
-<dt><samp>ntpkey_</samp><kbd>host</kbd></dt>
+<dt><samp class="file">ntpkey_</samp><kbd class="kbd">host</kbd></dt>
<dd><p>RSA public key
</p></dd>
-<dt><samp>ntp_dh</samp></dt>
+<dt><samp class="file">ntp_dh</samp></dt>
<dd><p>Diffie-Hellman agreement parameters
</p></dd>
</dl>
<hr>
-<span id="ntp_002econf-See-Also"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002econf-See-Also">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002econf-Bugs" accesskey="n" rel="next">ntp.conf Bugs</a>, Previous: <a href="#ntp_002econf-Files" accesskey="p" rel="prev">ntp.conf Files</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: <a href="#ntp_002econf-Bugs" accesskey="n" rel="next">ntp.conf Bugs</a>, Previous: <a href="#ntp_002econf-Files" accesskey="p" rel="prev">ntp.conf Files</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="ntp_002econf-See-Also-1"></span><h4 class="subsection">1.1.9 ntp.conf See Also</h4>
-<p><code>ntpd(1ntpdmdoc)</code>,
-<code>ntpdc(1ntpdcmdoc)</code>,
-<code>ntpq(1ntpqmdoc)</code>
+<h4 class="subsection" id="ntp_002econf-See-Also-1"><span>1.1.9 ntp.conf See Also<a class="copiable-link" href="#ntp_002econf-See-Also-1"> ¶</a></span></h4>
+<p><code class="code">ntpd(1ntpdmdoc)</code>,
+<code class="code">ntpdc(1ntpdcmdoc)</code>,
+<code class="code">ntpq(1ntpqmdoc)</code>
</p>
<p>In addition to the manual pages provided,
comprehensive documentation is available on the world wide web
at
-<code>http://www.ntp.org/</code>.
+<code class="code">http://www.ntp.org/</code>.
A snapshot of this documentation is available in HTML format in
-<samp>/usr/share/doc/ntp</samp>.
+<samp class="file">/usr/share/doc/ntp</samp>.
<br>
</p>
<br>
-<p>David L. Mills, <em>Network Time Protocol (Version 4)</em>, RFC5905
+<p>David L. Mills, <em class="emph">Network Time Protocol (Version 4)</em>, RFC5905
</p><hr>
-<span id="ntp_002econf-Bugs"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002econf-Bugs">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002econf-See-Also" accesskey="p" rel="prev">ntp.conf See Also</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">ntp.conf Notes</a> </p>
+Next: ntp.conf Notes, Previous: <a href="#ntp_002econf-See-Also" accesskey="p" rel="prev">ntp.conf See Also</a>, Up: <a href="#ntp_002econf-Notes" accesskey="u" rel="up">Notes about ntp.conf</a> </p>
</div>
-<span id="ntp_002econf-Bugs-1"></span><h4 class="subsection">1.1.10 ntp.conf Bugs</h4>
+<h4 class="subsection" id="ntp_002econf-Bugs-1"><span>1.1.10 ntp.conf Bugs<a class="copiable-link" href="#ntp_002econf-Bugs-1"> ¶</a></span></h4>
<p>The syntax checking is not picky; some combinations of
ridiculous and even hilarious options and modes may not be
detected.
</p>
<p>The
-<samp>ntpkey_</samp><kbd>host</kbd>
+<samp class="file">ntpkey_</samp><kbd class="kbd">host</kbd>
files are really digital
certificates.
These should be obtained via secure directory
services when they become universally available.
</p><hr>
-<div class="header">
-<p>
- </p>
</div>
-<span id="ntp_002econf-Notes-1"></span><h4 class="subsection">1.1.11 ntp.conf Notes</h4>
+<div class="subsection-level-extent">
+<div class="nav-panel">
+</div>
+<h4 class="subsection" id="ntp_002econf-Notes-1"><span>1.1.11 ntp.conf Notes<a class="copiable-link" href="#ntp_002econf-Notes-1"> ¶</a></span></h4>
<p>This document was derived from FreeBSD.
-</p><hr>
+</p></div>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp.conf 5 "30 Sep 2023" "4.2.8p17" "File Formats"
+.TH ntp.conf 5 "07 Jan 2024" "4.2.8p17" "File Formats"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed September 30, 2023 at 03:20:48 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:31 AM by AutoGen 5.18.16
.\" From the definitions ntp.conf.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The syntax checking is not picky; some combinations of
-.Dd September 30 2023
+.Dd January 7 2024
.Dt NTP_CONF 5 File Formats
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
.\"
-.\" It has been AutoGen-ed September 30, 2023 at 03:20:43 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:20 AM by AutoGen 5.18.16
.\" From the definitions ntp.conf.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The syntax checking is not picky; some combinations of
-.TH ntp.keys 5man "06 Jun 2023" "4.2.8p17" "File Formats"
+.TH ntp.keys 5man "07 Jan 2024" "4.2.8p17" "File Formats"
.\"
.\" EDIT THIS FILE WITH CAUTION (ntp.man)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:47 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:33 AM by AutoGen 5.18.16
.\" From the definitions ntp.keys.def
.\" and the template file agman-file.tpl
.Sh NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_KEYS 5mdoc File Formats
-.Os FreeBSD 12.1-RELEASE_SI
+.Os FreeBSD 11.2-RELEASE_SI
.\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:34 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:22 AM by AutoGen 5.18.16
.\" From the definitions ntp.keys.def
.\" and the template file agmdoc-file.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>NTP Symmetric Key</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntp_002ekeys-Description" rel="next" title="ntp.keys Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">NTP Symmetric Key</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002ekeys-Description" accesskey="n" rel="next">
ntp.keys 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>
+Next: <a href="#ntp_002ekeys-Description" accesskey="n" rel="next">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>
</div>
-<span id="NTP_0027s-Symmetric-Key-File-User-Manual"></span><h1 class="top">NTP’s Symmetric Key File User Manual</h1>
+<h1 class="top" id="NTP_0027s-Symmetric-Key-File-User-Manual"><span>NTP’s Symmetric Key File User Manual<a class="copiable-link" href="#NTP_0027s-Symmetric-Key-File-User-Manual"> ¶</a></span></h1>
<p>This document describes the symmetric key file for the NTP Project’s
-<code>ntpd</code> program.
+<code class="code">ntpd</code> program.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntp.keys</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntp.keys</code>.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntp_002ekeys-Description">1 Description</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Description" accesskey="1">ntp.keys Description</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="2">ntp.keys Notes</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="ntp_002ekeys-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntp_002ekeys-Description">
+<div class="nav-panel">
<p>
-Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Previous: <a href="#Top" accesskey="p" rel="prev">NTP’s Symmetric Key File User Manual</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP’s Symmetric Key File User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>The name and location of the symmetric key file for <code>ntpd</code> can
-be specified in a configuration file, by default <code>/etc/ntp.keys</code>.
+<p>The name and location of the symmetric key file for <code class="code">ntpd</code> can
+be specified in a configuration file, by default <code class="code">/etc/ntp.keys</code>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="1">Notes about ntp.keys</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#ntp_002ekeys-Notes" accesskey="1">Notes about ntp.keys</a></li>
+</ul>
<hr>
-<span id="ntp_002ekeys-Notes"></span><div class="header">
+<div class="section-level-extent" id="ntp_002ekeys-Notes">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002ekeys-See-Also" accesskey="p" rel="prev">ntp.keys See Also</a>, Up: <a href="#ntp_002ekeys-Description" accesskey="u" rel="up">ntp.keys Description</a> </p>
+Up: <a href="#ntp_002ekeys-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Notes-about-ntp_002ekeys"></span><h3 class="section">1.1 Notes about ntp.keys</h3>
-<span id="index-ntp_002ekeys"></span>
-<span id="index-NTP-symmetric-key-file-format"></span>
+<h3 class="section" id="Notes-about-ntp_002ekeys"><span>1.1 Notes about ntp.keys<a class="copiable-link" href="#Notes-about-ntp_002ekeys"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntp_002ekeys"></a>
+<a class="index-entry-id" id="index-NTP-symmetric-key-file-format"></a>
For a description of the use of this type of file, see the
"Authentication Support"
section of the
-<code>ntp.conf(5)</code>
+<code class="code">ntp.conf(5)</code>
page.
</p>
-<p><code>ntpd(8)</code>
+<p><code class="code">ntpd(8)</code>
reads its keys from a file specified using the
-<code>-k</code>
+<code class="code">-k</code>
command line option or the
-<code>keys</code>
+<code class="code">keys</code>
statement in the configuration file.
While key number 0 is fixed by the NTP standard
(as 56 zero bits)
Key entries use a fixed format of the form
</p>
<div class="example">
-<pre class="example"><kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> <kbd>opt_IP_list</kbd>
+<pre class="example-preformatted"><kbd class="kbd">keyno</kbd> <kbd class="kbd">type</kbd> <kbd class="kbd">key</kbd> <kbd class="kbd">opt_IP_list</kbd>
</pre></div>
<p>where
-<kbd>keyno</kbd>
+<kbd class="kbd">keyno</kbd>
is a positive integer (between 1 and 65535),
-<kbd>type</kbd>
+<kbd class="kbd">type</kbd>
is the message digest algorithm,
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
is the key itself, and
-<kbd>opt_IP_list</kbd>
+<kbd class="kbd">opt_IP_list</kbd>
is an optional comma-separated list of IPs
where the
-<kbd>keyno</kbd>
+<kbd class="kbd">keyno</kbd>
should be trusted.
that are allowed to serve time.
Each IP in
-<kbd>opt_IP_list</kbd>
+<kbd class="kbd">opt_IP_list</kbd>
may contain an optional
-<code>/subnetbits</code>
+<code class="code">/subnetbits</code>
specification which identifies the number of bits for
the desired subnet of trust.
If
-<kbd>opt_IP_list</kbd>
+<kbd class="kbd">opt_IP_list</kbd>
is empty,
any properly-authenticated message will be
accepted.
</p>
<p>The
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
may be given in a format
controlled by the
-<kbd>type</kbd>
+<kbd class="kbd">type</kbd>
field.
The
-<kbd>type</kbd>
-<code>MD5</code>
+<kbd class="kbd">type</kbd>
+<code class="code">MD5</code>
is always supported.
If
-<code>ntpd</code>
+<code class="code">ntpd</code>
was built with the OpenSSL library
then any digest library supported by that library may be specified.
However, if compliance with FIPS 140-2 is required the
-<kbd>type</kbd>
+<kbd class="kbd">type</kbd>
must be either
-<code>SHA</code>
+<code class="code">SHA</code>
or
-<code>SHA1</code>.
+<code class="code">SHA1</code>.
</p>
<p>What follows are some key types, and corresponding formats:
</p>
-<dl compact="compact">
-<dt><code>MD5</code></dt>
+<dl class="table">
+<dt><code class="code">MD5</code></dt>
<dd><p>The key is 1 to 16 printable characters terminated by
an EOL,
whitespace,
or
a
-<code>#</code>
+<code class="code">#</code>
(which is the "start of comment" character).
</p>
</dd>
-<dt><code>SHA</code></dt>
-<dt><code>SHA1</code></dt>
-<dt><code>RMD160</code></dt>
+<dt><code class="code">SHA</code></dt>
+<dt><code class="code">SHA1</code></dt>
+<dt><code class="code">RMD160</code></dt>
<dd><p>The key is a hex-encoded ASCII string of 40 characters,
which is truncated as necessary.
</p></dd>
</dl>
<p>Note that the keys used by the
-<code>ntpq(8)</code>
+<code class="code">ntpq(8)</code>
and
-<code>ntpdc(8)</code>
+<code class="code">ntpdc(8)</code>
programs are checked against passwords
requested by the programs and entered by hand,
so it is generally appropriate to specify these keys in ASCII format.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.keys</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntp.keys</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Files" accesskey="1">ntp.keys Files</a></td><td> </td><td align="left" valign="top">Files
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-See-Also" accesskey="2">ntp.keys See Also</a></td><td> </td><td align="left" valign="top">See Also
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="3">ntp.keys Notes</a></td><td> </td><td align="left" valign="top">Notes
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#ntp_002ekeys-Files" accesskey="1">ntp.keys Files</a></li>
+<li><a href="#ntp_002ekeys-See-Also" accesskey="2">ntp.keys See Also</a></li>
+<li>ntp.keys Notes</li>
+</ul>
<hr>
-<span id="ntp_002ekeys-Files"></span><div class="header">
+<div class="subsection-level-extent" id="ntp_002ekeys-Files">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002ekeys-See-Also" accesskey="n" rel="next">ntp.keys See Also</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">ntp.keys Notes</a> </p>
+Next: <a href="#ntp_002ekeys-See-Also" accesskey="n" rel="next">ntp.keys See Also</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">Notes about ntp.keys</a> </p>
</div>
-<span id="ntp_002ekeys-Files-1"></span><h4 class="subsection">1.1.1 ntp.keys Files</h4>
-<dl compact="compact">
-<dt><samp>/etc/ntp.keys</samp></dt>
+<h4 class="subsection" id="ntp_002ekeys-Files-1"><span>1.1.1 ntp.keys Files<a class="copiable-link" href="#ntp_002ekeys-Files-1"> ¶</a></span></h4>
+<dl class="table">
+<dt><samp class="file">/etc/ntp.keys</samp></dt>
<dd><p>the default name of the configuration file
</p></dd>
</dl>
<hr>
-<span id="ntp_002ekeys-See-Also"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002ekeys-See-Also">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002ekeys-Files" accesskey="p" rel="prev">ntp.keys Files</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">ntp.keys Notes</a> </p>
+Next: ntp.keys Notes, Previous: <a href="#ntp_002ekeys-Files" accesskey="p" rel="prev">ntp.keys Files</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">Notes about ntp.keys</a> </p>
</div>
-<span id="ntp_002ekeys-See-Also-1"></span><h4 class="subsection">1.1.2 ntp.keys See Also</h4>
-<p><code>ntp.conf(5)</code>,
-<code>ntpd(1ntpdmdoc)</code>,
-<code>ntpdate(1ntpdatemdoc)</code>,
-<code>ntpdc(1ntpdcmdoc)</code>,
-<code>sntp(1sntpmdoc)</code>
+<h4 class="subsection" id="ntp_002ekeys-See-Also-1"><span>1.1.2 ntp.keys See Also<a class="copiable-link" href="#ntp_002ekeys-See-Also-1"> ¶</a></span></h4>
+<p><code class="code">ntp.conf(5)</code>,
+<code class="code">ntpd(1ntpdmdoc)</code>,
+<code class="code">ntpdate(1ntpdatemdoc)</code>,
+<code class="code">ntpdc(1ntpdcmdoc)</code>,
+<code class="code">sntp(1sntpmdoc)</code>
</p><hr>
-<div class="header">
-<p>
- </p>
</div>
-<span id="ntp_002ekeys-Notes-1"></span><h4 class="subsection">1.1.3 ntp.keys Notes</h4>
+<div class="subsection-level-extent">
+<div class="nav-panel">
+</div>
+<h4 class="subsection" id="ntp_002ekeys-Notes-1"><span>1.1.3 ntp.keys Notes<a class="copiable-link" href="#ntp_002ekeys-Notes-1"> ¶</a></span></h4>
<p>This document was derived from FreeBSD.
-</p><hr>
+</p></div>
+</div>
+</div>
+</div>
-.TH ntp.keys 5 "06 Jun 2023" "4.2.8p17" "File Formats"
+.TH ntp.keys 5 "07 Jan 2024" "4.2.8p17" "File Formats"
.\"
.\" EDIT THIS FILE WITH CAUTION (ntp.man)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:47 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:33 AM by AutoGen 5.18.16
.\" From the definitions ntp.keys.def
.\" and the template file agman-file.tpl
.Sh NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_KEYS 5 File Formats
-.Os FreeBSD 12.1-RELEASE_SI
+.Os FreeBSD 11.2-RELEASE_SI
.\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:34 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:22 AM by AutoGen 5.18.16
.\" From the definitions ntp.keys.def
.\" and the template file agmdoc-file.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
/*
* EDIT THIS FILE WITH CAUTION (ntpd-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:36:50 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:33:48 AM by AutoGen 5.18.16
* From the definitions ntpd-opts.def
* and the template file options
*
* The ntpd program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const ntpd_opt_strs[3133] =
/* 0 */ "ntpd 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via ntpdOptions.pzCopyright */
puts(_("ntpd 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (ntpd-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:36:50 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:33:48 AM by AutoGen 5.18.16
* From the definitions ntpd-opts.def
* and the template file options
*
* The ntpd program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpd 1ntpdman "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpd 1ntpdman "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:49 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:34 AM by AutoGen 5.18.16
.\" From the definitions ntpd-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPD 1ntpdmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpd-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:36 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:23 AM by AutoGen 5.18.16
.\" From the definitions ntpd-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ntpd: Network Time Protocol (NTP) Daemon User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntpd-Description" rel="next" title="ntpd Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">ntpd: Network Time Protocol (NTP) Daemon User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Description" accesskey="n" rel="next">
ntpd 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>
+Next: <a href="#ntpd-Description" accesskey="n" rel="next">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>
</div>
-<span id="ntpd_003a-Network-Time-Protocol-_0028NTP_0029-Daemon-User-Manual"></span><h1 class="top">ntpd: Network Time Protocol (NTP) Daemon User Manual</h1>
+<h1 class="top" id="ntpd_003a-Network-Time-Protocol-_0028NTP_0029-Daemon-User-Manual"><span>ntpd: Network Time Protocol (NTP) Daemon User Manual<a class="copiable-link" href="#ntpd_003a-Network-Time-Protocol-_0028NTP_0029-Daemon-User-Manual"> ¶</a></span></h1>
-<p>The <code>ntpd</code> program is an operating system daemon that synchronizes the
+<p>The <code class="code">ntpd</code> program is an operating system daemon that synchronizes the
system clock to remote NTP time servers or local reference clocks.
It is a complete implementation of NTP version 4 defined by RFC-5905, but
also retains compatible with version 3 defined by RFC-1305 and versions
symmetric and broadcast modes, and with both symmetric-key and public-key
cryptography.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntpd</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntpd</code>.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntpd-Description">1 Description</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpd-Description" accesskey="1">ntpd Description</a></td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-Invocation" accesskey="2">ntpd Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntpd
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="3">Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="ntpd-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntpd-Description">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Invocation" accesskey="n" rel="next">ntpd Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Up: <a href="#Top" accesskey="u" rel="up">ntpd: Network Time Protocol (NTP) Daemon User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>The <code>ntpd</code> program ordinarily requires
+<p>The <code class="code">ntpd</code> program ordinarily requires
a configuration file described at ‘ntp.conf’.
This configuration file contains configuration commands described on
the pages listed above.
This makes it possible to deploy a fleet of workstations without
specifying configuration details specific to the local environment.
</p>
-<p>The <code>ntpd</code> program normally operates continuously while adjusting the
+<p>The <code class="code">ntpd</code> program normally operates continuously while adjusting the
system time and frequency, but in some cases this might not be
practical.
-With the <code>-q</code> option <code>ntpd</code> operates as in continuous mode, but
+With the <code class="code">-q</code> option <code class="code">ntpd</code> operates as in continuous mode, but
exits just after setting the clock for the first time.
-Most applications will probably want to specify the <code>iburst</code>
-option with the <code>server</code> command.
+Most applications will probably want to specify the <code class="code">iburst</code>
+option with the <code class="code">server</code> command.
With this option an initial volley of messages is exchanged to
groom the data and set the clock in about ten seconds’ time.
If nothing is heard after a few minutes’ time,
the daemon times out and exits without setting the clock.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpd-Invocation" accesskey="1">Invoking ntpd</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="2">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#ntpd-Invocation" accesskey="1">Invoking ntpd</a></li>
+<li><a href="#Usage" accesskey="2">Usage</a></li>
+</ul>
<hr>
-<span id="ntpd-Invocation"></span><div class="header">
+<div class="section-level-extent" id="ntpd-Invocation">
+<div class="nav-panel">
<p>
-Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#ntpd-Description" accesskey="p" rel="prev">ntpd Description</a>, Up: <a href="#ntpd-Description" accesskey="u" rel="up">ntpd Description</a> </p>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#ntpd-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Invoking-ntpd"></span><h3 class="section">1.1 Invoking ntpd</h3>
-<span id="index-ntpd"></span>
-<span id="index-NTP-daemon-program"></span>
+<h3 class="section" id="Invoking-ntpd"><span>1.1 Invoking ntpd<a class="copiable-link" href="#Invoking-ntpd"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntpd"></a>
+<a class="index-entry-id" id="index-NTP-daemon-program"></a>
<p>The
-<code>ntpd</code>
+<code class="code">ntpd</code>
utility is an operating system daemon which sets
and maintains the system time of day in synchronism with Internet
standard time servers.
and 2, as defined by RFC-1059 and RFC-1119, respectively.
</p>
<p>The
-<code>ntpd</code>
+<code class="code">ntpd</code>
utility does most computations in 64-bit floating point
arithmetic and does relatively clumsy 64-bit fixed point operations
only when necessary to preserve the ultimate precision, about 232
with future gigahertz CPU clocks and gigabit LANs.
</p>
<p>Ordinarily,
-<code>ntpd</code>
+<code class="code">ntpd</code>
reads the
-<code>ntp.conf(5)</code>
+<code class="code">ntp.conf(5)</code>
configuration file at startup time in order to determine the
synchronization sources and operating modes.
It is also possible to
listening to broadcasts at run time.
</p>
<p>If NetInfo support is built into
-<code>ntpd</code>
+<code class="code">ntpd</code>
then
-<code>ntpd</code>
+<code class="code">ntpd</code>
will attempt to read its configuration from the
NetInfo if the default
-<code>ntp.conf(5)</code>
+<code class="code">ntp.conf(5)</code>
file cannot be read and no file is
specified by the
-<code>-c</code>
+<code class="code">-c</code>
option.
</p>
<p>Various internal
-<code>ntpd</code>
+<code class="code">ntpd</code>
variables can be displayed and
configuration options altered while the
-<code>ntpd</code>
+<code class="code">ntpd</code>
is running
using the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility programs.
</p>
<p>When
-<code>ntpd</code>
+<code class="code">ntpd</code>
starts it looks at the value of
-<code>umask(2)</code>,
+<code class="code">umask(2)</code>,
and if zero
-<code>ntpd</code>
+<code class="code">ntpd</code>
will set the
-<code>umask(2)</code>
+<code class="code">umask(2)</code>
to 022.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpd</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntpd</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpd-usage" accesskey="1">ntpd usage</a></td><td> </td><td align="left" valign="top">ntpd help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-ipv4" accesskey="2">ntpd ipv4</a></td><td> </td><td align="left" valign="top">ipv4 option (-4)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-ipv6" accesskey="3">ntpd ipv6</a></td><td> </td><td align="left" valign="top">ipv6 option (-6)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-authreq" accesskey="4">ntpd authreq</a></td><td> </td><td align="left" valign="top">authreq option (-a)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-authnoreq" accesskey="5">ntpd authnoreq</a></td><td> </td><td align="left" valign="top">authnoreq option (-A)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-configfile" accesskey="6">ntpd configfile</a></td><td> </td><td align="left" valign="top">configfile option (-c)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-driftfile" accesskey="7">ntpd driftfile</a></td><td> </td><td align="left" valign="top">driftfile option (-f)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-panicgate" accesskey="8">ntpd panicgate</a></td><td> </td><td align="left" valign="top">panicgate option (-g)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-force_002dstep_002donce" accesskey="9">ntpd force-step-once</a></td><td> </td><td align="left" valign="top">force-step-once option (-G)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-jaildir">ntpd jaildir</a></td><td> </td><td align="left" valign="top">jaildir option (-i)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-interface">ntpd interface</a></td><td> </td><td align="left" valign="top">interface option (-I)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-keyfile">ntpd keyfile</a></td><td> </td><td align="left" valign="top">keyfile option (-k)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-logfile">ntpd logfile</a></td><td> </td><td align="left" valign="top">logfile option (-l)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-novirtualips">ntpd novirtualips</a></td><td> </td><td align="left" valign="top">novirtualips option (-L)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-modifymmtimer">ntpd modifymmtimer</a></td><td> </td><td align="left" valign="top">modifymmtimer option (-M)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-nice">ntpd nice</a></td><td> </td><td align="left" valign="top">nice option (-N)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-pidfile">ntpd pidfile</a></td><td> </td><td align="left" valign="top">pidfile option (-p)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-priority">ntpd priority</a></td><td> </td><td align="left" valign="top">priority option (-P)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-quit">ntpd quit</a></td><td> </td><td align="left" valign="top">quit option (-q)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-propagationdelay">ntpd propagationdelay</a></td><td> </td><td align="left" valign="top">propagationdelay option (-r)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-saveconfigquit">ntpd saveconfigquit</a></td><td> </td><td align="left" valign="top">saveconfigquit option
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-statsdir">ntpd statsdir</a></td><td> </td><td align="left" valign="top">statsdir option (-s)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-trustedkey">ntpd trustedkey</a></td><td> </td><td align="left" valign="top">trustedkey option (-t)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-user">ntpd user</a></td><td> </td><td align="left" valign="top">user option (-u)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-updateinterval">ntpd updateinterval</a></td><td> </td><td align="left" valign="top">updateinterval option (-U)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-wait_002dsync">ntpd wait-sync</a></td><td> </td><td align="left" valign="top">wait-sync option (-w)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-slew">ntpd slew</a></td><td> </td><td align="left" valign="top">slew option (-x)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-usepcc">ntpd usepcc</a></td><td> </td><td align="left" valign="top">usepcc option
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-pccfreq">ntpd pccfreq</a></td><td> </td><td align="left" valign="top">pccfreq option
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-mdns">ntpd mdns</a></td><td> </td><td align="left" valign="top">mdns option (-m)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-config">ntpd config</a></td><td> </td><td align="left" valign="top">presetting/configuring ntpd
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-exit-status">ntpd exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-Usage">ntpd Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-Files">ntpd Files</a></td><td> </td><td align="left" valign="top">Files
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-See-Also">ntpd See Also</a></td><td> </td><td align="left" valign="top">See Also
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-Bugs">ntpd Bugs</a></td><td> </td><td align="left" valign="top">Bugs
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpd-Notes">ntpd Notes</a></td><td> </td><td align="left" valign="top">Notes
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#ntpd-usage" accesskey="1">ntpd help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#ntpd-ipv4" accesskey="2">ipv4 option (-4)</a></li>
+<li><a href="#ntpd-ipv6" accesskey="3">ipv6 option (-6)</a></li>
+<li><a href="#ntpd-authreq" accesskey="4">authreq option (-a)</a></li>
+<li><a href="#ntpd-authnoreq" accesskey="5">authnoreq option (-A)</a></li>
+<li><a href="#ntpd-configfile" accesskey="6">configfile option (-c)</a></li>
+<li><a href="#ntpd-driftfile" accesskey="7">driftfile option (-f)</a></li>
+<li><a href="#ntpd-panicgate" accesskey="8">panicgate option (-g)</a></li>
+<li><a href="#ntpd-force_002dstep_002donce" accesskey="9">force-step-once option (-G)</a></li>
+<li><a href="#ntpd-jaildir">jaildir option (-i)</a></li>
+<li><a href="#ntpd-interface">interface option (-I)</a></li>
+<li><a href="#ntpd-keyfile">keyfile option (-k)</a></li>
+<li><a href="#ntpd-logfile">logfile option (-l)</a></li>
+<li><a href="#ntpd-novirtualips">novirtualips option (-L)</a></li>
+<li><a href="#ntpd-modifymmtimer">modifymmtimer option (-M)</a></li>
+<li><a href="#ntpd-nice">nice option (-N)</a></li>
+<li><a href="#ntpd-pidfile">pidfile option (-p)</a></li>
+<li><a href="#ntpd-priority">priority option (-P)</a></li>
+<li><a href="#ntpd-quit">quit option (-q)</a></li>
+<li><a href="#ntpd-propagationdelay">propagationdelay option (-r)</a></li>
+<li><a href="#ntpd-saveconfigquit">saveconfigquit option</a></li>
+<li><a href="#ntpd-statsdir">statsdir option (-s)</a></li>
+<li><a href="#ntpd-trustedkey">trustedkey option (-t)</a></li>
+<li><a href="#ntpd-user">user option (-u)</a></li>
+<li><a href="#ntpd-updateinterval">updateinterval option (-U)</a></li>
+<li><a href="#ntpd-wait_002dsync">wait-sync option (-w)</a></li>
+<li><a href="#ntpd-slew">slew option (-x)</a></li>
+<li><a href="#ntpd-usepcc">usepcc option</a></li>
+<li><a href="#ntpd-pccfreq">pccfreq option</a></li>
+<li><a href="#ntpd-mdns">mdns option (-m)</a></li>
+<li><a href="#ntpd-config">presetting/configuring ntpd</a></li>
+<li><a href="#ntpd-exit-status">ntpd exit status</a></li>
+<li><a href="#ntpd-Usage">ntpd Usage</a></li>
+<li><a href="#ntpd-Files">ntpd Files</a></li>
+<li><a href="#ntpd-See-Also">ntpd See Also</a></li>
+<li><a href="#ntpd-Bugs">ntpd Bugs</a></li>
+<li><a href="#ntpd-Notes">ntpd Notes</a></li>
+</ul>
<hr>
-<span id="ntpd-usage"></span><div class="header">
+<div class="subsection-level-extent" id="ntpd-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-ipv4" accesskey="n" rel="next">ntpd ipv4</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-ipv4" accesskey="n" rel="next">ipv4 option (-4)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1.1 ntpd help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntpd-help"></span>
+<h4 class="subsection" id="ntpd-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1.1 ntpd help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntpd-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd-help"></a>
<p>This is the automatically generated usage text for ntpd.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntpd - NTP daemon program - Ver. 4.2.8p17
+<pre class="example-preformatted">ntpd - NTP daemon program - Ver. 4.2.8p17
Usage: ntpd [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \
[ <server1> ... <serverN> ]
Flg Arg Option-Name Description
</pre></div>
<hr>
-<span id="ntpd-ipv4"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-ipv4">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-ipv6" accesskey="n" rel="next">ntpd ipv6</a>, Previous: <a href="#ntpd-usage" accesskey="p" rel="prev">ntpd usage</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-ipv6" accesskey="n" rel="next">ipv6 option (-6)</a>, Previous: <a href="#ntpd-usage" accesskey="p" rel="prev">ntpd help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<span id="index-ntpd_002dipv4"></span>
+<h4 class="subsection" id="ipv4-option-_0028_002d4_0029"><span>1.1.2 ipv4 option (-4)<a class="copiable-link" href="#ipv4-option-_0028_002d4_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dipv4"></a>
<p>This is the “force ipv4 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv6.
</li></ul>
<p>Force DNS resolution of following host names on the command line
to the IPv4 namespace.
</p><hr>
-<span id="ntpd-ipv6"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-ipv6">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-authreq" accesskey="n" rel="next">ntpd authreq</a>, Previous: <a href="#ntpd-ipv4" accesskey="p" rel="prev">ntpd ipv4</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-authreq" accesskey="n" rel="next">authreq option (-a)</a>, Previous: <a href="#ntpd-ipv4" accesskey="p" rel="prev">ipv4 option (-4)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ipv6-option-_0028_002d6_0029"></span><h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<span id="index-ntpd_002dipv6"></span>
+<h4 class="subsection" id="ipv6-option-_0028_002d6_0029"><span>1.1.3 ipv6 option (-6)<a class="copiable-link" href="#ipv6-option-_0028_002d6_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dipv6"></a>
<p>This is the “force ipv6 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv4.
</li></ul>
<p>Force DNS resolution of following host names on the command line
to the IPv6 namespace.
</p><hr>
-<span id="ntpd-authreq"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-authreq">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-authnoreq" accesskey="n" rel="next">ntpd authnoreq</a>, Previous: <a href="#ntpd-ipv6" accesskey="p" rel="prev">ntpd ipv6</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-authnoreq" accesskey="n" rel="next">authnoreq option (-A)</a>, Previous: <a href="#ntpd-ipv6" accesskey="p" rel="prev">ipv6 option (-6)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="authreq-option-_0028_002da_0029"></span><h4 class="subsection">1.1.4 authreq option (-a)</h4>
-<span id="index-ntpd_002dauthreq"></span>
+<h4 class="subsection" id="authreq-option-_0028_002da_0029"><span>1.1.4 authreq option (-a)<a class="copiable-link" href="#authreq-option-_0028_002da_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dauthreq"></a>
<p>This is the “require crypto authentication” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
authnoreq.
</li></ul>
multicast client and symmetric passive associations.
This is the default.
</p><hr>
-<span id="ntpd-authnoreq"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-authnoreq">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-configfile" accesskey="n" rel="next">ntpd configfile</a>, Previous: <a href="#ntpd-authreq" accesskey="p" rel="prev">ntpd authreq</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-configfile" accesskey="n" rel="next">configfile option (-c)</a>, Previous: <a href="#ntpd-authreq" accesskey="p" rel="prev">authreq option (-a)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="authnoreq-option-_0028_002dA_0029"></span><h4 class="subsection">1.1.5 authnoreq option (-A)</h4>
-<span id="index-ntpd_002dauthnoreq"></span>
+<h4 class="subsection" id="authnoreq-option-_0028_002dA_0029"><span>1.1.5 authnoreq option (-A)<a class="copiable-link" href="#authnoreq-option-_0028_002dA_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dauthnoreq"></a>
<p>This is the “do not require crypto authentication” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
authreq.
</li></ul>
multicast client and symmetric passive associations.
This is almost never a good idea.
</p><hr>
-<span id="ntpd-configfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-configfile">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-driftfile" accesskey="n" rel="next">ntpd driftfile</a>, Previous: <a href="#ntpd-authnoreq" accesskey="p" rel="prev">ntpd authnoreq</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-driftfile" accesskey="n" rel="next">driftfile option (-f)</a>, Previous: <a href="#ntpd-authnoreq" accesskey="p" rel="prev">authnoreq option (-A)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="configfile-option-_0028_002dc_0029"></span><h4 class="subsection">1.1.6 configfile option (-c)</h4>
-<span id="index-ntpd_002dconfigfile"></span>
+<h4 class="subsection" id="configfile-option-_0028_002dc_0029"><span>1.1.6 configfile option (-c)<a class="copiable-link" href="#configfile-option-_0028_002dc_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dconfigfile"></a>
<p>This is the “configuration file name” option.
This option takes a string argument.
The name and path of the configuration file,
-<samp>/etc/ntp.conf</samp>
+<samp class="file">/etc/ntp.conf</samp>
by default.
</p><hr>
-<span id="ntpd-driftfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-driftfile">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-panicgate" accesskey="n" rel="next">ntpd panicgate</a>, Previous: <a href="#ntpd-configfile" accesskey="p" rel="prev">ntpd configfile</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-panicgate" accesskey="n" rel="next">panicgate option (-g)</a>, Previous: <a href="#ntpd-configfile" accesskey="p" rel="prev">configfile option (-c)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="driftfile-option-_0028_002df_0029"></span><h4 class="subsection">1.1.7 driftfile option (-f)</h4>
-<span id="index-ntpd_002ddriftfile"></span>
+<h4 class="subsection" id="driftfile-option-_0028_002df_0029"><span>1.1.7 driftfile option (-f)<a class="copiable-link" href="#driftfile-option-_0028_002df_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002ddriftfile"></a>
<p>This is the “frequency drift file name” option.
This option takes a string argument.
The name and path of the frequency file,
-<samp>/etc/ntp.drift</samp>
+<samp class="file">/etc/ntp.drift</samp>
by default.
This is the same operation as the
-<code>driftfile</code> <kbd>driftfile</kbd>
+<code class="code">driftfile</code> <kbd class="kbd">driftfile</kbd>
configuration specification in the
-<samp>/etc/ntp.conf</samp>
+<samp class="file">/etc/ntp.conf</samp>
file.
</p><hr>
-<span id="ntpd-panicgate"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-panicgate">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-force_002dstep_002donce" accesskey="n" rel="next">ntpd force-step-once</a>, Previous: <a href="#ntpd-driftfile" accesskey="p" rel="prev">ntpd driftfile</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-force_002dstep_002donce" accesskey="n" rel="next">force-step-once option (-G)</a>, Previous: <a href="#ntpd-driftfile" accesskey="p" rel="prev">driftfile option (-f)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="panicgate-option-_0028_002dg_0029"></span><h4 class="subsection">1.1.8 panicgate option (-g)</h4>
-<span id="index-ntpd_002dpanicgate"></span>
+<h4 class="subsection" id="panicgate-option-_0028_002dg_0029"><span>1.1.8 panicgate option (-g)<a class="copiable-link" href="#panicgate-option-_0028_002dg_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dpanicgate"></a>
<p>This is the “allow the first adjustment to be big” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>Normally,
-<code>ntpd</code>
+<code class="code">ntpd</code>
exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
-<code>ntpd</code>
+<code class="code">ntpd</code>
will exit with a message to the system log. This option can be used with the
-<code>-q</code>
+<code class="code">-q</code>
and
-<code>-x</code>
+<code class="code">-x</code>
options.
See the
-<code>tinker</code>
+<code class="code">tinker</code>
configuration file directive for other options.
</p><hr>
-<span id="ntpd-force_002dstep_002donce"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-force_002dstep_002donce">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-jaildir" accesskey="n" rel="next">ntpd jaildir</a>, Previous: <a href="#ntpd-panicgate" accesskey="p" rel="prev">ntpd panicgate</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-jaildir" accesskey="n" rel="next">jaildir option (-i)</a>, Previous: <a href="#ntpd-panicgate" accesskey="p" rel="prev">panicgate option (-g)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="force_002dstep_002donce-option-_0028_002dG_0029"></span><h4 class="subsection">1.1.9 force-step-once option (-G)</h4>
-<span id="index-ntpd_002dforce_002dstep_002donce"></span>
+<h4 class="subsection" id="force_002dstep_002donce-option-_0028_002dG_0029"><span>1.1.9 force-step-once option (-G)<a class="copiable-link" href="#force_002dstep_002donce-option-_0028_002dG_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dforce_002dstep_002donce"></a>
<p>This is the “step any initial offset correction.” option.
Normally,
-<code>ntpd</code>
+<code class="code">ntpd</code>
steps the time if the time offset exceeds the step threshold,
which is 128 ms by default, and otherwise slews the time.
This option forces the initial offset correction to be stepped,
However, this may also cause the time to be stepped back
so this option must not be used if
applications requiring monotonic time are running.
-See the <code>tinker</code> configuration file directive for other options.
+See the <code class="code">tinker</code> configuration file directive for other options.
</p><hr>
-<span id="ntpd-jaildir"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-jaildir">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-interface" accesskey="n" rel="next">ntpd interface</a>, Previous: <a href="#ntpd-force_002dstep_002donce" accesskey="p" rel="prev">ntpd force-step-once</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-interface" accesskey="n" rel="next">interface option (-I)</a>, Previous: <a href="#ntpd-force_002dstep_002donce" accesskey="p" rel="prev">force-step-once option (-G)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="jaildir-option-_0028_002di_0029"></span><h4 class="subsection">1.1.10 jaildir option (-i)</h4>
-<span id="index-ntpd_002djaildir"></span>
+<h4 class="subsection" id="jaildir-option-_0028_002di_0029"><span>1.1.10 jaildir option (-i)<a class="copiable-link" href="#jaildir-option-_0028_002di_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002djaildir"></a>
<p>This is the “jail directory” option.
This option takes a string argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">HAVE_DROPROOT</code> during the compilation.
</li></ul>
<p>Chroot the server to the directory
-<kbd>jaildir</kbd>
+<kbd class="kbd">jaildir</kbd>
.
This option also implies that the server attempts to drop root privileges at startup.
You may need to also specify a
-<code>-u</code>
+<code class="code">-u</code>
option.
This option is only available if the OS supports adjusting the clock
without full root privileges.
This option is supported under NetBSD (configure with
-<code>--enable-clockctl</code>) or Linux (configure with
-<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>).
+<code class="code">--enable-clockctl</code>) or Linux (configure with
+<code class="code">--enable-linuxcaps</code>) or Solaris (configure with <code class="code">--enable-solarisprivs</code>).
</p><hr>
-<span id="ntpd-interface"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-interface">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-keyfile" accesskey="n" rel="next">ntpd keyfile</a>, Previous: <a href="#ntpd-jaildir" accesskey="p" rel="prev">ntpd jaildir</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-keyfile" accesskey="n" rel="next">keyfile option (-k)</a>, Previous: <a href="#ntpd-jaildir" accesskey="p" rel="prev">jaildir option (-i)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="interface-option-_0028_002dI_0029"></span><h4 class="subsection">1.1.11 interface option (-I)</h4>
-<span id="index-ntpd_002dinterface"></span>
+<h4 class="subsection" id="interface-option-_0028_002dI_0029"><span>1.1.11 interface option (-I)<a class="copiable-link" href="#interface-option-_0028_002dI_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dinterface"></a>
<p>This is the “listen on an interface name or address” option.
-This option takes a string argument <samp>iface</samp>.
+This option takes a string argument <samp class="file">iface</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>Open the network address given, or all the addresses associated with the
given interface name. This option may appear multiple times. This option
also implies not opening other addresses, except wildcard and localhost.
This option is deprecated. Please consider using the configuration file
-<code>interface</code> command, which is more versatile.
+<code class="code">interface</code> command, which is more versatile.
</p><hr>
-<span id="ntpd-keyfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-keyfile">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-logfile" accesskey="n" rel="next">ntpd logfile</a>, Previous: <a href="#ntpd-interface" accesskey="p" rel="prev">ntpd interface</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-logfile" accesskey="n" rel="next">logfile option (-l)</a>, Previous: <a href="#ntpd-interface" accesskey="p" rel="prev">interface option (-I)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="keyfile-option-_0028_002dk_0029"></span><h4 class="subsection">1.1.12 keyfile option (-k)</h4>
-<span id="index-ntpd_002dkeyfile"></span>
+<h4 class="subsection" id="keyfile-option-_0028_002dk_0029"><span>1.1.12 keyfile option (-k)<a class="copiable-link" href="#keyfile-option-_0028_002dk_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dkeyfile"></a>
<p>This is the “path to symmetric keys” option.
This option takes a string argument.
Specify the name and path of the symmetric key file.
-<samp>/etc/ntp.keys</samp>
+<samp class="file">/etc/ntp.keys</samp>
is the default.
This is the same operation as the
-<code>keys</code> <kbd>keyfile</kbd>
+<code class="code">keys</code> <kbd class="kbd">keyfile</kbd>
configuration file directive.
</p><hr>
-<span id="ntpd-logfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-logfile">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-novirtualips" accesskey="n" rel="next">ntpd novirtualips</a>, Previous: <a href="#ntpd-keyfile" accesskey="p" rel="prev">ntpd keyfile</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-novirtualips" accesskey="n" rel="next">novirtualips option (-L)</a>, Previous: <a href="#ntpd-keyfile" accesskey="p" rel="prev">keyfile option (-k)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="logfile-option-_0028_002dl_0029"></span><h4 class="subsection">1.1.13 logfile option (-l)</h4>
-<span id="index-ntpd_002dlogfile"></span>
+<h4 class="subsection" id="logfile-option-_0028_002dl_0029"><span>1.1.13 logfile option (-l)<a class="copiable-link" href="#logfile-option-_0028_002dl_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dlogfile"></a>
<p>This is the “path to the log file” option.
This option takes a string argument.
Specify the name and path of the log file.
The default is the system log file.
This is the same operation as the
-<code>logfile</code> <kbd>logfile</kbd>
+<code class="code">logfile</code> <kbd class="kbd">logfile</kbd>
configuration file directive.
</p><hr>
-<span id="ntpd-novirtualips"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-novirtualips">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-modifymmtimer" accesskey="n" rel="next">ntpd modifymmtimer</a>, Previous: <a href="#ntpd-logfile" accesskey="p" rel="prev">ntpd logfile</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-modifymmtimer" accesskey="n" rel="next">modifymmtimer option (-M)</a>, Previous: <a href="#ntpd-logfile" accesskey="p" rel="prev">logfile option (-l)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="novirtualips-option-_0028_002dL_0029"></span><h4 class="subsection">1.1.14 novirtualips option (-L)</h4>
-<span id="index-ntpd_002dnovirtualips"></span>
+<h4 class="subsection" id="novirtualips-option-_0028_002dL_0029"><span>1.1.14 novirtualips option (-L)<a class="copiable-link" href="#novirtualips-option-_0028_002dL_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dnovirtualips"></a>
<p>This is the “do not listen to virtual interfaces” option.
Do not listen to virtual interfaces, defined as those with
names containing a colon. This option is deprecated. Please
-consider using the configuration file <code>interface</code> command, which
+consider using the configuration file <code class="code">interface</code> command, which
is more versatile.
</p><hr>
-<span id="ntpd-modifymmtimer"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-modifymmtimer">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-nice" accesskey="n" rel="next">ntpd nice</a>, Previous: <a href="#ntpd-novirtualips" accesskey="p" rel="prev">ntpd novirtualips</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-nice" accesskey="n" rel="next">nice option (-N)</a>, Previous: <a href="#ntpd-novirtualips" accesskey="p" rel="prev">novirtualips option (-L)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="modifymmtimer-option-_0028_002dM_0029"></span><h4 class="subsection">1.1.15 modifymmtimer option (-M)</h4>
-<span id="index-ntpd_002dmodifymmtimer"></span>
+<h4 class="subsection" id="modifymmtimer-option-_0028_002dM_0029"><span>1.1.15 modifymmtimer option (-M)<a class="copiable-link" href="#modifymmtimer-option-_0028_002dM_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dmodifymmtimer"></a>
<p>This is the “modify multimedia timer (windows only)” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">SYS_WINNT</code> during the compilation.
</li></ul>
<p>Set the Windows Multimedia Timer to highest resolution. This
ensures the resolution does not change while ntpd is running,
avoiding timekeeping glitches associated with changes.
</p><hr>
-<span id="ntpd-nice"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-nice">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-pidfile" accesskey="n" rel="next">ntpd pidfile</a>, Previous: <a href="#ntpd-modifymmtimer" accesskey="p" rel="prev">ntpd modifymmtimer</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-pidfile" accesskey="n" rel="next">pidfile option (-p)</a>, Previous: <a href="#ntpd-modifymmtimer" accesskey="p" rel="prev">modifymmtimer option (-M)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="nice-option-_0028_002dN_0029"></span><h4 class="subsection">1.1.16 nice option (-N)</h4>
-<span id="index-ntpd_002dnice"></span>
+<h4 class="subsection" id="nice-option-_0028_002dN_0029"><span>1.1.16 nice option (-N)<a class="copiable-link" href="#nice-option-_0028_002dN_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dnice"></a>
<p>This is the “run at high priority” option.
To the extent permitted by the operating system, run
-<code>ntpd</code>
+<code class="code">ntpd</code>
at the highest priority.
</p><hr>
-<span id="ntpd-pidfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-pidfile">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-priority" accesskey="n" rel="next">ntpd priority</a>, Previous: <a href="#ntpd-nice" accesskey="p" rel="prev">ntpd nice</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-priority" accesskey="n" rel="next">priority option (-P)</a>, Previous: <a href="#ntpd-nice" accesskey="p" rel="prev">nice option (-N)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="pidfile-option-_0028_002dp_0029"></span><h4 class="subsection">1.1.17 pidfile option (-p)</h4>
-<span id="index-ntpd_002dpidfile"></span>
+<h4 class="subsection" id="pidfile-option-_0028_002dp_0029"><span>1.1.17 pidfile option (-p)<a class="copiable-link" href="#pidfile-option-_0028_002dp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dpidfile"></a>
<p>This is the “path to the pid file” option.
This option takes a string argument.
Specify the name and path of the file used to record
-<code>ntpd</code>’s
+<code class="code">ntpd</code>’s
process ID.
This is the same operation as the
-<code>pidfile</code> <kbd>pidfile</kbd>
+<code class="code">pidfile</code> <kbd class="kbd">pidfile</kbd>
configuration file directive.
</p><hr>
-<span id="ntpd-priority"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-priority">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-quit" accesskey="n" rel="next">ntpd quit</a>, Previous: <a href="#ntpd-pidfile" accesskey="p" rel="prev">ntpd pidfile</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-quit" accesskey="n" rel="next">quit option (-q)</a>, Previous: <a href="#ntpd-pidfile" accesskey="p" rel="prev">pidfile option (-p)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="priority-option-_0028_002dP_0029"></span><h4 class="subsection">1.1.18 priority option (-P)</h4>
-<span id="index-ntpd_002dpriority"></span>
+<h4 class="subsection" id="priority-option-_0028_002dP_0029"><span>1.1.18 priority option (-P)<a class="copiable-link" href="#priority-option-_0028_002dP_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dpriority"></a>
<p>This is the “process priority” option.
This option takes a number argument.
To the extent permitted by the operating system, run
-<code>ntpd</code>
+<code class="code">ntpd</code>
at the specified
-<code>sched_setscheduler(SCHED_FIFO)</code>
+<code class="code">sched_setscheduler(SCHED_FIFO)</code>
priority.
</p><hr>
-<span id="ntpd-quit"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-quit">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-propagationdelay" accesskey="n" rel="next">ntpd propagationdelay</a>, Previous: <a href="#ntpd-priority" accesskey="p" rel="prev">ntpd priority</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-propagationdelay" accesskey="n" rel="next">propagationdelay option (-r)</a>, Previous: <a href="#ntpd-priority" accesskey="p" rel="prev">priority option (-P)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="quit-option-_0028_002dq_0029"></span><h4 class="subsection">1.1.19 quit option (-q)</h4>
-<span id="index-ntpd_002dquit"></span>
+<h4 class="subsection" id="quit-option-_0028_002dq_0029"><span>1.1.19 quit option (-q)<a class="copiable-link" href="#quit-option-_0028_002dq_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dquit"></a>
<p>This is the “set the time and quit” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
saveconfigquit, wait-sync.
</li></ul>
-<p><code>ntpd</code>
+<p><code class="code">ntpd</code>
will not daemonize and will exit after the clock is first
synchronized. This behavior mimics that of the
-<code>ntpdate</code>
+<code class="code">ntpdate</code>
program, which will soon be replaced with a shell script.
The
-<code>-g</code>
+<code class="code">-g</code>
and
-<code>-x</code>
+<code class="code">-x</code>
options can be used with this option.
Note: The kernel time discipline is disabled with this option.
</p><hr>
-<span id="ntpd-propagationdelay"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-propagationdelay">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-saveconfigquit" accesskey="n" rel="next">ntpd saveconfigquit</a>, Previous: <a href="#ntpd-quit" accesskey="p" rel="prev">ntpd quit</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-saveconfigquit" accesskey="n" rel="next">saveconfigquit option</a>, Previous: <a href="#ntpd-quit" accesskey="p" rel="prev">quit option (-q)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="propagationdelay-option-_0028_002dr_0029"></span><h4 class="subsection">1.1.20 propagationdelay option (-r)</h4>
-<span id="index-ntpd_002dpropagationdelay"></span>
+<h4 class="subsection" id="propagationdelay-option-_0028_002dr_0029"><span>1.1.20 propagationdelay option (-r)<a class="copiable-link" href="#propagationdelay-option-_0028_002dr_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dpropagationdelay"></a>
<p>This is the “broadcast/propagation delay” option.
This option takes a string argument.
Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol.
</p><hr>
-<span id="ntpd-saveconfigquit"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-saveconfigquit">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-statsdir" accesskey="n" rel="next">ntpd statsdir</a>, Previous: <a href="#ntpd-propagationdelay" accesskey="p" rel="prev">ntpd propagationdelay</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-statsdir" accesskey="n" rel="next">statsdir option (-s)</a>, Previous: <a href="#ntpd-propagationdelay" accesskey="p" rel="prev">propagationdelay option (-r)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="saveconfigquit-option"></span><h4 class="subsection">1.1.21 saveconfigquit option</h4>
-<span id="index-ntpd_002dsaveconfigquit"></span>
+<h4 class="subsection" id="saveconfigquit-option"><span>1.1.21 saveconfigquit option<a class="copiable-link" href="#saveconfigquit-option"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dsaveconfigquit"></a>
<p>This is the “save parsed configuration and quit” option.
This option takes a string argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>SAVECONFIG</code> during the compilation.
-</li><li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">SAVECONFIG</code> during the compilation.
+</li><li>must not appear in combination with any of the following options:
quit, wait-sync.
</li></ul>
-<p>Cause <code>ntpd</code> to parse its startup configuration file and save an
+<p>Cause <code class="code">ntpd</code> to parse its startup configuration file and save an
equivalent to the given filename and exit. This option was
designed for automated testing.
</p><hr>
-<span id="ntpd-statsdir"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-statsdir">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-trustedkey" accesskey="n" rel="next">ntpd trustedkey</a>, Previous: <a href="#ntpd-saveconfigquit" accesskey="p" rel="prev">ntpd saveconfigquit</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-trustedkey" accesskey="n" rel="next">trustedkey option (-t)</a>, Previous: <a href="#ntpd-saveconfigquit" accesskey="p" rel="prev">saveconfigquit option</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="statsdir-option-_0028_002ds_0029"></span><h4 class="subsection">1.1.22 statsdir option (-s)</h4>
-<span id="index-ntpd_002dstatsdir"></span>
+<h4 class="subsection" id="statsdir-option-_0028_002ds_0029"><span>1.1.22 statsdir option (-s)<a class="copiable-link" href="#statsdir-option-_0028_002ds_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dstatsdir"></a>
<p>This is the “statistics file location” option.
This option takes a string argument.
Specify the directory path for files created by the statistics facility.
This is the same operation as the
-<code>statsdir</code> <kbd>statsdir</kbd>
+<code class="code">statsdir</code> <kbd class="kbd">statsdir</kbd>
configuration file directive.
</p><hr>
-<span id="ntpd-trustedkey"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-trustedkey">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-user" accesskey="n" rel="next">ntpd user</a>, Previous: <a href="#ntpd-statsdir" accesskey="p" rel="prev">ntpd statsdir</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-user" accesskey="n" rel="next">user option (-u)</a>, Previous: <a href="#ntpd-statsdir" accesskey="p" rel="prev">statsdir option (-s)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="trustedkey-option-_0028_002dt_0029"></span><h4 class="subsection">1.1.23 trustedkey option (-t)</h4>
-<span id="index-ntpd_002dtrustedkey"></span>
+<h4 class="subsection" id="trustedkey-option-_0028_002dt_0029"><span>1.1.23 trustedkey option (-t)<a class="copiable-link" href="#trustedkey-option-_0028_002dt_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dtrustedkey"></a>
<p>This is the “trusted key number” option.
-This option takes a string argument <samp>tkey</samp>.
+This option takes a string argument <samp class="file">tkey</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>Add the specified key number to the trusted key list.
</p><hr>
-<span id="ntpd-user"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-user">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-updateinterval" accesskey="n" rel="next">ntpd updateinterval</a>, Previous: <a href="#ntpd-trustedkey" accesskey="p" rel="prev">ntpd trustedkey</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-updateinterval" accesskey="n" rel="next">updateinterval option (-U)</a>, Previous: <a href="#ntpd-trustedkey" accesskey="p" rel="prev">trustedkey option (-t)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="user-option-_0028_002du_0029"></span><h4 class="subsection">1.1.24 user option (-u)</h4>
-<span id="index-ntpd_002duser"></span>
+<h4 class="subsection" id="user-option-_0028_002du_0029"><span>1.1.24 user option (-u)<a class="copiable-link" href="#user-option-_0028_002du_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002duser"></a>
<p>This is the “run as userid (or userid:groupid)” option.
This option takes a string argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">HAVE_DROPROOT</code> during the compilation.
</li></ul>
<p>Specify a user, and optionally a group, to switch to.
This option is only available if the OS supports adjusting the clock
without full root privileges.
This option is supported under NetBSD (configure with
-<code>--enable-clockctl</code>) or Linux (configure with
-<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>).
+<code class="code">--enable-clockctl</code>) or Linux (configure with
+<code class="code">--enable-linuxcaps</code>) or Solaris (configure with <code class="code">--enable-solarisprivs</code>).
</p><hr>
-<span id="ntpd-updateinterval"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-updateinterval">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-wait_002dsync" accesskey="n" rel="next">ntpd wait-sync</a>, Previous: <a href="#ntpd-user" accesskey="p" rel="prev">ntpd user</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-wait_002dsync" accesskey="n" rel="next">wait-sync option (-w)</a>, Previous: <a href="#ntpd-user" accesskey="p" rel="prev">user option (-u)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="updateinterval-option-_0028_002dU_0029"></span><h4 class="subsection">1.1.25 updateinterval option (-U)</h4>
-<span id="index-ntpd_002dupdateinterval"></span>
+<h4 class="subsection" id="updateinterval-option-_0028_002dU_0029"><span>1.1.25 updateinterval option (-U)<a class="copiable-link" href="#updateinterval-option-_0028_002dU_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dupdateinterval"></a>
<p>This is the “interval in seconds between scans for new or dropped interfaces” option.
This option takes a number argument.
has been detected by the system.
Use 0 to disable scanning. 60 seconds is the minimum time between scans.
</p><hr>
-<span id="ntpd-wait_002dsync"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-wait_002dsync">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-slew" accesskey="n" rel="next">ntpd slew</a>, Previous: <a href="#ntpd-updateinterval" accesskey="p" rel="prev">ntpd updateinterval</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-slew" accesskey="n" rel="next">slew option (-x)</a>, Previous: <a href="#ntpd-updateinterval" accesskey="p" rel="prev">updateinterval option (-U)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="wait_002dsync-option-_0028_002dw_0029"></span><h4 class="subsection">1.1.26 wait-sync option (-w)</h4>
-<span id="index-ntpd_002dwait_002dsync"></span>
+<h4 class="subsection" id="wait_002dsync-option-_0028_002dw_0029"><span>1.1.26 wait-sync option (-w)<a class="copiable-link" href="#wait_002dsync-option-_0028_002dw_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dwait_002dsync"></a>
<p>This is the “seconds to wait for first clock sync” option.
This option takes a number argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>HAVE_WORKING_FORK</code> during the compilation.
-</li><li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">HAVE_WORKING_FORK</code> during the compilation.
+</li><li>must not appear in combination with any of the following options:
nofork, quit, saveconfigquit.
</li></ul>
-<p>If greater than zero, alters <code>ntpd</code>’s behavior when forking to
+<p>If greater than zero, alters <code class="code">ntpd</code>’s behavior when forking to
daemonize. Instead of exiting with status 0 immediately after
the fork, the parent waits up to the specified number of
seconds for the child to first synchronize the clock. The exit
status is zero (success) if the clock was synchronized,
-otherwise it is <code>ETIMEDOUT</code>.
-This provides the option for a script starting <code>ntpd</code> to easily
+otherwise it is <code class="code">ETIMEDOUT</code>.
+This provides the option for a script starting <code class="code">ntpd</code> to easily
wait for the first set of the clock before proceeding.
</p><hr>
-<span id="ntpd-slew"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-slew">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-usepcc" accesskey="n" rel="next">ntpd usepcc</a>, Previous: <a href="#ntpd-wait_002dsync" accesskey="p" rel="prev">ntpd wait-sync</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-usepcc" accesskey="n" rel="next">usepcc option</a>, Previous: <a href="#ntpd-wait_002dsync" accesskey="p" rel="prev">wait-sync option (-w)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="slew-option-_0028_002dx_0029"></span><h4 class="subsection">1.1.27 slew option (-x)</h4>
-<span id="index-ntpd_002dslew"></span>
+<h4 class="subsection" id="slew-option-_0028_002dx_0029"><span>1.1.27 slew option (-x)<a class="copiable-link" href="#slew-option-_0028_002dx_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dslew"></a>
<p>This is the “slew up to 600 seconds” option.
Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold.
Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s.
Thus, an adjustment as much as 600 s will take almost 14 days to complete.
This option can be used with the
-<code>-g</code>
+<code class="code">-g</code>
and
-<code>-q</code>
+<code class="code">-q</code>
options.
See the
-<code>tinker</code>
+<code class="code">tinker</code>
configuration file directive for other options.
Note: The kernel time discipline is disabled with this option.
</p><hr>
-<span id="ntpd-usepcc"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-usepcc">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-pccfreq" accesskey="n" rel="next">ntpd pccfreq</a>, Previous: <a href="#ntpd-slew" accesskey="p" rel="prev">ntpd slew</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-pccfreq" accesskey="n" rel="next">pccfreq option</a>, Previous: <a href="#ntpd-slew" accesskey="p" rel="prev">slew option (-x)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="usepcc-option"></span><h4 class="subsection">1.1.28 usepcc option</h4>
-<span id="index-ntpd_002dusepcc"></span>
+<h4 class="subsection" id="usepcc-option"><span>1.1.28 usepcc option<a class="copiable-link" href="#usepcc-option"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dusepcc"></a>
<p>This is the “use cpu cycle counter (windows only)” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">SYS_WINNT</code> during the compilation.
</li></ul>
-<p>Attempt to substitute the CPU counter for <code>QueryPerformanceCounter</code>.
-The CPU counter and <code>QueryPerformanceCounter</code> are compared, and if
+<p>Attempt to substitute the CPU counter for <code class="code">QueryPerformanceCounter</code>.
+The CPU counter and <code class="code">QueryPerformanceCounter</code> are compared, and if
they have the same frequency, the CPU counter (RDTSC on x86) is
used directly, saving the overhead of a system call.
</p><hr>
-<span id="ntpd-pccfreq"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-pccfreq">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-mdns" accesskey="n" rel="next">ntpd mdns</a>, Previous: <a href="#ntpd-usepcc" accesskey="p" rel="prev">ntpd usepcc</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-mdns" accesskey="n" rel="next">mdns option (-m)</a>, Previous: <a href="#ntpd-usepcc" accesskey="p" rel="prev">usepcc option</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="pccfreq-option"></span><h4 class="subsection">1.1.29 pccfreq option</h4>
-<span id="index-ntpd_002dpccfreq"></span>
+<h4 class="subsection" id="pccfreq-option"><span>1.1.29 pccfreq option<a class="copiable-link" href="#pccfreq-option"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dpccfreq"></a>
<p>This is the “force cpu cycle counter use (windows only)” option.
This option takes a string argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">SYS_WINNT</code> during the compilation.
</li></ul>
-<p>Force substitution the CPU counter for <code>QueryPerformanceCounter</code>.
+<p>Force substitution the CPU counter for <code class="code">QueryPerformanceCounter</code>.
The CPU counter (RDTSC on x86) is used unconditionally with the
given frequency (in Hz).
</p><hr>
-<span id="ntpd-mdns"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-mdns">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-config" accesskey="n" rel="next">ntpd config</a>, Previous: <a href="#ntpd-pccfreq" accesskey="p" rel="prev">ntpd pccfreq</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-config" accesskey="n" rel="next">presetting/configuring ntpd</a>, Previous: <a href="#ntpd-pccfreq" accesskey="p" rel="prev">pccfreq option</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="mdns-option-_0028_002dm_0029"></span><h4 class="subsection">1.1.30 mdns option (-m)</h4>
-<span id="index-ntpd_002dmdns"></span>
+<h4 class="subsection" id="mdns-option-_0028_002dm_0029"><span>1.1.30 mdns option (-m)<a class="copiable-link" href="#mdns-option-_0028_002dm_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpd_002dmdns"></a>
<p>This is the “register with mdns as a ntp server” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>HAVE_DNSREGISTRATION</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">HAVE_DNSREGISTRATION</code> during the compilation.
</li></ul>
<p>Registers as an NTP server with the local mDNS server which allows
</p>
<hr>
-<span id="ntpd-config"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-config">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-exit-status" accesskey="n" rel="next">ntpd exit status</a>, Previous: <a href="#ntpd-mdns" accesskey="p" rel="prev">ntpd mdns</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-exit-status" accesskey="n" rel="next">ntpd exit status</a>, Previous: <a href="#ntpd-mdns" accesskey="p" rel="prev">mdns option (-m)</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="presetting_002fconfiguring-ntpd"></span><h4 class="subsection">1.1.31 presetting/configuring ntpd</h4>
+<h4 class="subsection" id="presetting_002fconfiguring-ntpd"><span>1.1.31 presetting/configuring ntpd<a class="copiable-link" href="#presetting_002fconfiguring-ntpd"> ¶</a></span></h4>
-<p>Any option that is not marked as <i>not presettable</i> may be preset by
-loading values from environment variables named <code>NTPD</code> and <code>NTPD_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
+<p>Any option that is not marked as <i class="i">not presettable</i> may be preset by
+loading values from environment variables named <code class="code">NTPD</code> and <code class="code">NTPD_<OPTION_NAME></code>. <code class="code"><OPTION_NAME></code> must be one of
the options listed above in upper case and segmented with underscores.
-The <code>NTPD</code> variable will be tokenized and parsed like
+The <code class="code">NTPD</code> variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
</p>
<p>The command line options relating to configuration and/or usage help are:
</p>
-<span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
+<h4 class="subsubheading" id="version-_0028_002d_0029"><span>version (-)<a class="copiable-link" href="#version-_0028_002d_0029"> ¶</a></span></h4>
<p>Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing information may be selected with an option argument.
Only the first letter of the argument is examined:
</p>
-<dl compact="compact">
-<dt>‘<samp>version</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">version</samp>’</dt>
<dd><p>Only print the version. This is the default.
</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
+<dt>‘<samp class="samp">copyright</samp>’</dt>
<dd><p>Name the copyright usage licensing terms.
</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>Print the full copyright usage licensing terms.
</p></dd>
</dl>
<hr>
-<span id="ntpd-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-exit-status">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Usage" accesskey="n" rel="next">ntpd Usage</a>, Previous: <a href="#ntpd-config" accesskey="p" rel="prev">ntpd config</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-Usage" accesskey="n" rel="next">ntpd Usage</a>, Previous: <a href="#ntpd-config" accesskey="p" rel="prev">presetting/configuring ntpd</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-exit-status-1"></span><h4 class="subsection">1.1.32 ntpd exit status</h4>
+<h4 class="subsection" id="ntpd-exit-status-1"><span>1.1.32 ntpd exit status<a class="copiable-link" href="#ntpd-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
</dl>
<hr>
-<span id="ntpd-Usage"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-Usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Files" accesskey="n" rel="next">ntpd Files</a>, Previous: <a href="#ntpd-exit-status" accesskey="p" rel="prev">ntpd exit status</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-Files" accesskey="n" rel="next">ntpd Files</a>, Previous: <a href="#ntpd-exit-status" accesskey="p" rel="prev">ntpd exit status</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-Usage-1"></span><h4 class="subsection">1.1.33 ntpd Usage</h4>
+<h4 class="subsection" id="ntpd-Usage-1"><span>1.1.33 ntpd Usage<a class="copiable-link" href="#ntpd-Usage-1"> ¶</a></span></h4>
<hr>
-<span id="ntpd-Files"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-Files">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-See-Also" accesskey="n" rel="next">ntpd See Also</a>, Previous: <a href="#ntpd-Usage" accesskey="p" rel="prev">ntpd Usage</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-See-Also" accesskey="n" rel="next">ntpd See Also</a>, Previous: <a href="#ntpd-Usage" accesskey="p" rel="prev">ntpd Usage</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-Files-1"></span><h4 class="subsection">1.1.34 ntpd Files</h4>
+<h4 class="subsection" id="ntpd-Files-1"><span>1.1.34 ntpd Files<a class="copiable-link" href="#ntpd-Files-1"> ¶</a></span></h4>
<hr>
-<span id="ntpd-See-Also"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-See-Also">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Bugs" accesskey="n" rel="next">ntpd Bugs</a>, Previous: <a href="#ntpd-Files" accesskey="p" rel="prev">ntpd Files</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-Bugs" accesskey="n" rel="next">ntpd Bugs</a>, Previous: <a href="#ntpd-Files" accesskey="p" rel="prev">ntpd Files</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-See-Also-1"></span><h4 class="subsection">1.1.35 ntpd See Also</h4>
+<h4 class="subsection" id="ntpd-See-Also-1"><span>1.1.35 ntpd See Also<a class="copiable-link" href="#ntpd-See-Also-1"> ¶</a></span></h4>
<hr>
-<span id="ntpd-Bugs"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-Bugs">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpd-Notes" accesskey="n" rel="next">ntpd Notes</a>, Previous: <a href="#ntpd-See-Also" accesskey="p" rel="prev">ntpd See Also</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Next: <a href="#ntpd-Notes" accesskey="n" rel="next">ntpd Notes</a>, Previous: <a href="#ntpd-See-Also" accesskey="p" rel="prev">ntpd See Also</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-Bugs-1"></span><h4 class="subsection">1.1.36 ntpd Bugs</h4>
+<h4 class="subsection" id="ntpd-Bugs-1"><span>1.1.36 ntpd Bugs<a class="copiable-link" href="#ntpd-Bugs-1"> ¶</a></span></h4>
<hr>
-<span id="ntpd-Notes"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpd-Notes">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntpd-Bugs" accesskey="p" rel="prev">ntpd Bugs</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">ntpd Invocation</a> </p>
+Previous: <a href="#ntpd-Bugs" accesskey="p" rel="prev">ntpd Bugs</a>, Up: <a href="#ntpd-Invocation" accesskey="u" rel="up">Invoking ntpd</a> </p>
</div>
-<span id="ntpd-Notes-1"></span><h4 class="subsection">1.1.37 ntpd Notes</h4>
+<h4 class="subsection" id="ntpd-Notes-1"><span>1.1.37 ntpd Notes<a class="copiable-link" href="#ntpd-Notes-1"> ¶</a></span></h4>
<hr>
-<span id="Usage"></span><div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntpd-Invocation" accesskey="p" rel="prev">ntpd Invocation</a>, Up: <a href="#ntpd-Description" accesskey="u" rel="up">ntpd Description</a> </p>
+Previous: <a href="#ntpd-Invocation" accesskey="p" rel="prev">Invoking ntpd</a>, Up: <a href="#ntpd-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Usage-1"></span><h3 class="section">1.2 Usage</h3>
+<h3 class="section" id="Usage-1"><span>1.2 Usage<a class="copiable-link" href="#Usage-1"> ¶</a></span></h3>
-<table>
+<table class="multitable">
<thead><tr><th width="23%">What</th><th width="23%">Default</th><th width="5%">Flag</th><th width="15%">Option</th></tr></thead>
-<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>
-<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>
-<tr><td width="23%">leapseconds file</td><td width="23%">none</td><td width="5%"></td><td width="15%"><code>leapfile</code></td></tr>
-<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>
-<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>
-<tr><td width="23%">include file</td><td width="23%">none</td><td width="5%">none</td><td width="15%"><code>includefile</code></td></tr>
-<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>
-<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>
+<tbody><tr><td width="23%">configuration file</td><td width="23%"><code class="code">/etc/ntp.conf</code></td><td width="5%"><code class="code">-c</code></td><td width="15%"><code class="code">conffile</code></td></tr>
+<tr><td width="23%">frequency file</td><td width="23%">none</td><td width="5%"><code class="code">-f</code></td><td width="15%"><code class="code">driftfile</code></td></tr>
+<tr><td width="23%">leapseconds file</td><td width="23%">none</td><td width="5%"></td><td width="15%"><code class="code">leapfile</code></td></tr>
+<tr><td width="23%">process ID file</td><td width="23%">none</td><td width="5%"><code class="code">-p</code></td><td width="15%"><code class="code">pidfile</code></td></tr>
+<tr><td width="23%">log file</td><td width="23%">system log</td><td width="5%"><code class="code">-l</code></td><td width="15%"><code class="code">logfile</code></td></tr>
+<tr><td width="23%">include file</td><td width="23%">none</td><td width="5%">none</td><td width="15%"><code class="code">includefile</code></td></tr>
+<tr><td width="23%">statistics path</td><td width="23%"><code class="code">/var/NTP</code></td><td width="5%"><code class="code">-s</code></td><td width="15%"><code class="code">statsdir</code></td></tr>
+<tr><td width="23%">keys path</td><td width="23%"><code class="code">/usr/local/etc</code></td><td width="5%"><code class="code">-k</code></td><td width="15%"><code class="code">keysdir</code></td></tr>
+</tbody>
</table>
-<hr>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpd @NTPD_MS@ "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpd @NTPD_MS@ "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:49 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:34 AM by AutoGen 5.18.16
.\" From the definitions ntpd-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPD @NTPD_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpd-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:36 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:23 AM by AutoGen 5.18.16
.\" From the definitions ntpd-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpdc.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:37:59 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:34:42 AM by AutoGen 5.18.16
# From the definitions ntpdc-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
/*
* EDIT THIS FILE WITH CAUTION (ntpdc-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:37:53 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:35:52 AM by AutoGen 5.18.16
* From the definitions ntpdc-opts.def
* and the template file options
*
* The ntpdc program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const ntpdc_opt_strs[2005] =
/* 0 */ "ntpdc 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via ntpdcOptions.pzCopyright */
puts(_("ntpdc 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (ntpdc-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:37:52 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:35:51 AM by AutoGen 5.18.16
* From the definitions ntpdc-opts.def
* and the template file options
*
* The ntpdc program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpdc 1ntpdcman "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpdc 1ntpdcman "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:01 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:44 AM by AutoGen 5.18.16
.\" From the definitions ntpdc-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH AUTHORS
The formatting directives in this document came from FreeBSD.
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPDC 1ntpdcmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpdc-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:57 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:40 AM by AutoGen 5.18.16
.\" From the definitions ntpdc-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh AUTHORS
The formatting directives in this document came from FreeBSD.
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ntpdc: NTPD Control User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntpdc-Description" rel="next" title="ntpdc Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">ntpdc: NTPD Control User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-Description" accesskey="n" rel="next">
ntpdc 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>
+Next: <a href="#ntpdc-Description" accesskey="n" rel="next">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>
</div>
-<span id="ntpdc_003a-NTPD-Control-User-Manual"></span><h1 class="top">ntpdc: NTPD Control User Manual</h1>
+<h1 class="top" id="ntpdc_003a-NTPD-Control-User-Manual"><span>ntpdc: NTPD Control User Manual<a class="copiable-link" href="#ntpdc_003a-NTPD-Control-User-Manual"> ¶</a></span></h1>
-<p>This document describes the use of the NTP Project’s <code>ntpdc</code> program,
+<p>This document describes the use of the NTP Project’s <code class="code">ntpdc</code> program,
that can be used to query a Network Time Protocol (NTP) server and
display the time offset of the system clock relative to the server
clock. Run as root, it can correct the system clock to this offset as
well. It can be run as an interactive command or from a cron job.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntpdc</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntpdc</code>.
</p>
<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
IETF specification.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntpdc-Description">1 Description</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpdc-Description" accesskey="1">ntpdc Description</a></td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-Invocation" accesskey="2">ntpdc Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntpdc
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="3">Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="ntpdc-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntpdc-Description">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-Invocation" accesskey="n" rel="next">ntpdc Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Up: <a href="#Top" accesskey="u" rel="up">ntpdc: NTPD Control User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>By default, <code>ntpdc</code> writes the local data and time (i.e., not UTC) to the
+<p>By default, <code class="code">ntpdc</code> writes the local data and time (i.e., not UTC) to the
standard output in the format:
</p>
<div class="example">
-<pre class="example">1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+<pre class="example-preformatted">1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
</pre></div>
<p>where
the +4.567 +/- 0.089 secs indicates the time offset and
error bound of the system clock relative to the server clock.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpdc-Invocation" accesskey="1">Invoking ntpdc</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="2">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#ntpdc-Invocation" accesskey="1">Invoking ntpdc</a></li>
+<li><a href="#Usage" accesskey="2">Usage</a></li>
+</ul>
<hr>
-<span id="ntpdc-Invocation"></span><div class="header">
+<div class="section-level-extent" id="ntpdc-Invocation">
+<div class="nav-panel">
<p>
-Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#ntpdc-Description" accesskey="p" rel="prev">ntpdc Description</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">ntpdc Description</a> </p>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Invoking-ntpdc"></span><h3 class="section">1.1 Invoking ntpdc</h3>
-<span id="index-ntpdc"></span>
-<span id="index-vendor_002dspecific-NTPD-control-program"></span>
+<h3 class="section" id="Invoking-ntpdc"><span>1.1 Invoking ntpdc<a class="copiable-link" href="#Invoking-ntpdc"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntpdc"></a>
+<a class="index-entry-id" id="index-vendor_002dspecific-NTPD-control-program"></a>
-<p><code>ntpdc</code>
+<p><code class="code">ntpdc</code>
is deprecated.
Please use
-<code>ntpq(1ntpqmdoc)</code> instead - it can do everything
-<code>ntpdc</code>
+<code class="code">ntpq(1ntpqmdoc)</code> instead - it can do everything
+<code class="code">ntpdc</code>
used to do, and it does so using a much more sane interface.
</p>
-<p><code>ntpdc</code>
+<p><code class="code">ntpdc</code>
is a utility program used to query
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
about its
current state and to request changes in that state.
It uses NTP mode 7 control message formats described in the source code.
arguments.
Extensive state and statistics information is available
through the
-<code>ntpdc</code>
+<code class="code">ntpdc</code>
interface.
In addition, nearly all the
configuration options which can be specified at startup using
ntpd’s configuration file may also be specified at run time using
-<code>ntpdc</code>
+<code class="code">ntpdc</code>
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpdc</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntpdc</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpdc-usage" accesskey="1">ntpdc usage</a></td><td> </td><td align="left" valign="top">ntpdc help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-ipv4" accesskey="2">ntpdc ipv4</a></td><td> </td><td align="left" valign="top">ipv4 option (-4)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-ipv6" accesskey="3">ntpdc ipv6</a></td><td> </td><td align="left" valign="top">ipv6 option (-6)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-command" accesskey="4">ntpdc command</a></td><td> </td><td align="left" valign="top">command option (-c)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-interactive" accesskey="5">ntpdc interactive</a></td><td> </td><td align="left" valign="top">interactive option (-i)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-listpeers" accesskey="6">ntpdc listpeers</a></td><td> </td><td align="left" valign="top">listpeers option (-l)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-numeric" accesskey="7">ntpdc numeric</a></td><td> </td><td align="left" valign="top">numeric option (-n)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-peers" accesskey="8">ntpdc peers</a></td><td> </td><td align="left" valign="top">peers option (-p)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-showpeers" accesskey="9">ntpdc showpeers</a></td><td> </td><td align="left" valign="top">showpeers option (-s)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-unconnected">ntpdc unconnected</a></td><td> </td><td align="left" valign="top">unconnected option (-u)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-config">ntpdc config</a></td><td> </td><td align="left" valign="top">presetting/configuring ntpdc
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-exit-status">ntpdc exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-Usage">ntpdc Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-See-Also">ntpdc See Also</a></td><td> </td><td align="left" valign="top">See Also
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-Authors">ntpdc Authors</a></td><td> </td><td align="left" valign="top">Authors
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpdc-Bugs">ntpdc Bugs</a></td><td> </td><td align="left" valign="top">Bugs
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#ntpdc-usage" accesskey="1">ntpdc help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#ntpdc-ipv4" accesskey="2">ipv4 option (-4)</a></li>
+<li><a href="#ntpdc-ipv6" accesskey="3">ipv6 option (-6)</a></li>
+<li><a href="#ntpdc-command" accesskey="4">command option (-c)</a></li>
+<li><a href="#ntpdc-interactive" accesskey="5">interactive option (-i)</a></li>
+<li><a href="#ntpdc-listpeers" accesskey="6">listpeers option (-l)</a></li>
+<li><a href="#ntpdc-numeric" accesskey="7">numeric option (-n)</a></li>
+<li><a href="#ntpdc-peers" accesskey="8">peers option (-p)</a></li>
+<li><a href="#ntpdc-showpeers" accesskey="9">showpeers option (-s)</a></li>
+<li><a href="#ntpdc-unconnected">unconnected option (-u)</a></li>
+<li><a href="#ntpdc-config">presetting/configuring ntpdc</a></li>
+<li><a href="#ntpdc-exit-status">ntpdc exit status</a></li>
+<li><a href="#ntpdc-Usage">ntpdc Usage</a></li>
+<li><a href="#ntpdc-See-Also">ntpdc See Also</a></li>
+<li><a href="#ntpdc-Authors">ntpdc Authors</a></li>
+<li><a href="#ntpdc-Bugs">ntpdc Bugs</a></li>
+</ul>
<hr>
-<span id="ntpdc-usage"></span><div class="header">
+<div class="subsection-level-extent" id="ntpdc-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-ipv4" accesskey="n" rel="next">ntpdc ipv4</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-ipv4" accesskey="n" rel="next">ipv4 option (-4)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1.1 ntpdc help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntpdc-help"></span>
+<h4 class="subsection" id="ntpdc-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1.1 ntpdc help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntpdc-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc-help"></a>
<p>This is the automatically generated usage text for ntpdc.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p17
+<pre class="example-preformatted">ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p17
Usage: ntpdc [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
Flg Arg Option-Name Description
-4 no ipv4 Force IPv4 DNS name resolution
</pre></div>
<hr>
-<span id="ntpdc-ipv4"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-ipv4">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-ipv6" accesskey="n" rel="next">ntpdc ipv6</a>, Previous: <a href="#ntpdc-usage" accesskey="p" rel="prev">ntpdc usage</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-ipv6" accesskey="n" rel="next">ipv6 option (-6)</a>, Previous: <a href="#ntpdc-usage" accesskey="p" rel="prev">ntpdc help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<span id="index-ntpdc_002dipv4"></span>
+<h4 class="subsection" id="ipv4-option-_0028_002d4_0029"><span>1.1.2 ipv4 option (-4)<a class="copiable-link" href="#ipv4-option-_0028_002d4_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dipv4"></a>
<p>This is the “force ipv4 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv6.
</li></ul>
<p>Force DNS resolution of following host names on the command line
to the IPv4 namespace.
</p><hr>
-<span id="ntpdc-ipv6"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-ipv6">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-command" accesskey="n" rel="next">ntpdc command</a>, Previous: <a href="#ntpdc-ipv4" accesskey="p" rel="prev">ntpdc ipv4</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-command" accesskey="n" rel="next">command option (-c)</a>, Previous: <a href="#ntpdc-ipv4" accesskey="p" rel="prev">ipv4 option (-4)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ipv6-option-_0028_002d6_0029"></span><h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<span id="index-ntpdc_002dipv6"></span>
+<h4 class="subsection" id="ipv6-option-_0028_002d6_0029"><span>1.1.3 ipv6 option (-6)<a class="copiable-link" href="#ipv6-option-_0028_002d6_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dipv6"></a>
<p>This is the “force ipv6 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv4.
</li></ul>
<p>Force DNS resolution of following host names on the command line
to the IPv6 namespace.
</p><hr>
-<span id="ntpdc-command"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-command">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-interactive" accesskey="n" rel="next">ntpdc interactive</a>, Previous: <a href="#ntpdc-ipv6" accesskey="p" rel="prev">ntpdc ipv6</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-interactive" accesskey="n" rel="next">interactive option (-i)</a>, Previous: <a href="#ntpdc-ipv6" accesskey="p" rel="prev">ipv6 option (-6)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="command-option-_0028_002dc_0029"></span><h4 class="subsection">1.1.4 command option (-c)</h4>
-<span id="index-ntpdc_002dcommand"></span>
+<h4 class="subsection" id="command-option-_0028_002dc_0029"><span>1.1.4 command option (-c)<a class="copiable-link" href="#command-option-_0028_002dc_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dcommand"></a>
<p>This is the “run a command and exit” option.
-This option takes a string argument <samp>cmd</samp>.
+This option takes a string argument <samp class="file">cmd</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>The following argument is interpreted as an interactive format command
and is added to the list of commands to be executed on the specified
host(s).
</p><hr>
-<span id="ntpdc-interactive"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-interactive">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-listpeers" accesskey="n" rel="next">ntpdc listpeers</a>, Previous: <a href="#ntpdc-command" accesskey="p" rel="prev">ntpdc command</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-listpeers" accesskey="n" rel="next">listpeers option (-l)</a>, Previous: <a href="#ntpdc-command" accesskey="p" rel="prev">command option (-c)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="interactive-option-_0028_002di_0029"></span><h4 class="subsection">1.1.5 interactive option (-i)</h4>
-<span id="index-ntpdc_002dinteractive"></span>
+<h4 class="subsection" id="interactive-option-_0028_002di_0029"><span>1.1.5 interactive option (-i)<a class="copiable-link" href="#interactive-option-_0028_002di_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dinteractive"></a>
<p>This is the “force ntpq to operate in interactive mode” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
command, listpeers, peers, showpeers.
</li></ul>
<p>Force ntpq to operate in interactive mode. Prompts will be written
to the standard output and commands read from the standard input.
</p><hr>
-<span id="ntpdc-listpeers"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-listpeers">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-numeric" accesskey="n" rel="next">ntpdc numeric</a>, Previous: <a href="#ntpdc-interactive" accesskey="p" rel="prev">ntpdc interactive</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-numeric" accesskey="n" rel="next">numeric option (-n)</a>, Previous: <a href="#ntpdc-interactive" accesskey="p" rel="prev">interactive option (-i)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="listpeers-option-_0028_002dl_0029"></span><h4 class="subsection">1.1.6 listpeers option (-l)</h4>
-<span id="index-ntpdc_002dlistpeers"></span>
+<h4 class="subsection" id="listpeers-option-_0028_002dl_0029"><span>1.1.6 listpeers option (-l)<a class="copiable-link" href="#listpeers-option-_0028_002dl_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dlistpeers"></a>
<p>This is the “print a list of the peers” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
command.
</li></ul>
<p>Print a list of the peers known to the server as well as a summary of
their state. This is equivalent to the ’listpeers’ interactive command.
</p><hr>
-<span id="ntpdc-numeric"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-numeric">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-peers" accesskey="n" rel="next">ntpdc peers</a>, Previous: <a href="#ntpdc-listpeers" accesskey="p" rel="prev">ntpdc listpeers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-peers" accesskey="n" rel="next">peers option (-p)</a>, Previous: <a href="#ntpdc-listpeers" accesskey="p" rel="prev">listpeers option (-l)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="numeric-option-_0028_002dn_0029"></span><h4 class="subsection">1.1.7 numeric option (-n)</h4>
-<span id="index-ntpdc_002dnumeric"></span>
+<h4 class="subsection" id="numeric-option-_0028_002dn_0029"><span>1.1.7 numeric option (-n)<a class="copiable-link" href="#numeric-option-_0028_002dn_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dnumeric"></a>
<p>This is the “numeric host addresses” option.
Output all host addresses in dotted-quad numeric format rather than
converting to the canonical host names.
</p><hr>
-<span id="ntpdc-peers"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-peers">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-showpeers" accesskey="n" rel="next">ntpdc showpeers</a>, Previous: <a href="#ntpdc-numeric" accesskey="p" rel="prev">ntpdc numeric</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-showpeers" accesskey="n" rel="next">showpeers option (-s)</a>, Previous: <a href="#ntpdc-numeric" accesskey="p" rel="prev">numeric option (-n)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.1.8 peers option (-p)</h4>
-<span id="index-ntpdc_002dpeers"></span>
+<h4 class="subsection" id="peers-option-_0028_002dp_0029"><span>1.1.8 peers option (-p)<a class="copiable-link" href="#peers-option-_0028_002dp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dpeers"></a>
<p>This is the “print a list of the peers” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
command.
</li></ul>
<p>Print a list of the peers known to the server as well as a summary
of their state. This is equivalent to the ’peers’ interactive command.
</p><hr>
-<span id="ntpdc-showpeers"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-showpeers">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-unconnected" accesskey="n" rel="next">ntpdc unconnected</a>, Previous: <a href="#ntpdc-peers" accesskey="p" rel="prev">ntpdc peers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-unconnected" accesskey="n" rel="next">unconnected option (-u)</a>, Previous: <a href="#ntpdc-peers" accesskey="p" rel="prev">peers option (-p)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="showpeers-option-_0028_002ds_0029"></span><h4 class="subsection">1.1.9 showpeers option (-s)</h4>
-<span id="index-ntpdc_002dshowpeers"></span>
+<h4 class="subsection" id="showpeers-option-_0028_002ds_0029"><span>1.1.9 showpeers option (-s)<a class="copiable-link" href="#showpeers-option-_0028_002ds_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dshowpeers"></a>
<p>This is the “show a list of the peers” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
command.
</li></ul>
<p>Print a list of the peers known to the server as well as a summary
of their state. This is equivalent to the ’dmpeers’ interactive command.
</p><hr>
-<span id="ntpdc-unconnected"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-unconnected">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-config" accesskey="n" rel="next">ntpdc config</a>, Previous: <a href="#ntpdc-showpeers" accesskey="p" rel="prev">ntpdc showpeers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-config" accesskey="n" rel="next">presetting/configuring ntpdc</a>, Previous: <a href="#ntpdc-showpeers" accesskey="p" rel="prev">showpeers option (-s)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="unconnected-option-_0028_002du_0029"></span><h4 class="subsection">1.1.10 unconnected option (-u)</h4>
-<span id="index-ntpdc_002dunconnected"></span>
+<h4 class="subsection" id="unconnected-option-_0028_002du_0029"><span>1.1.10 unconnected option (-u)<a class="copiable-link" href="#unconnected-option-_0028_002du_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpdc_002dunconnected"></a>
<p>This is the “use unconnected udp to communicate with ntpd (default on windows)” option.
Open an unconnected UDP association to ntpd (the default
</p>
<hr>
-<span id="ntpdc-config"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-config">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-exit-status" accesskey="n" rel="next">ntpdc exit status</a>, Previous: <a href="#ntpdc-unconnected" accesskey="p" rel="prev">ntpdc unconnected</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-exit-status" accesskey="n" rel="next">ntpdc exit status</a>, Previous: <a href="#ntpdc-unconnected" accesskey="p" rel="prev">unconnected option (-u)</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="presetting_002fconfiguring-ntpdc"></span><h4 class="subsection">1.1.11 presetting/configuring ntpdc</h4>
+<h4 class="subsection" id="presetting_002fconfiguring-ntpdc"><span>1.1.11 presetting/configuring ntpdc<a class="copiable-link" href="#presetting_002fconfiguring-ntpdc"> ¶</a></span></h4>
-<p>Any option that is not marked as <i>not presettable</i> may be preset by
-loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTPDC</code> and <code>NTPDC_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
+<p>Any option that is not marked as <i class="i">not presettable</i> may be preset by
+loading values from configuration ("rc" or "ini") files, and values from environment variables named <code class="code">NTPDC</code> and <code class="code">NTPDC_<OPTION_NAME></code>. <code class="code"><OPTION_NAME></code> must be one of
the options listed above in upper case and segmented with underscores.
-The <code>NTPDC</code> variable will be tokenized and parsed like
+The <code class="code">NTPDC</code> variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
</p>
-<p><code>libopts</code> will search in 2 places for configuration files:
-</p><ul>
-<li> $HOME
-</li><li> $PWD
+<p><code class="code">libopts</code> will search in 2 places for configuration files:
+</p><ul class="itemize mark-bullet">
+<li>$HOME
+</li><li>$PWD
</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>ntpdc</samp> runs.
+<p>The environment variables <code class="code">HOME</code>, and <code class="code">PWD</code>
+are expanded and replaced when <samp class="file">ntpdc</samp> runs.
For any of these that are plain files, they are simply processed.
-For any that are directories, then a file named <samp>.ntprc</samp> is searched for
+For any that are directories, then a file named <samp class="file">.ntprc</samp> is searched for
within that directory and processed.
</p>
<p>Configuration files may be in a wide variety of formats.
Common options are collected at the top, followed by program specific
segments. The segments are separated by lines like:
</p><div class="example">
-<pre class="example">[NTPDC]
+<pre class="example-preformatted">[NTPDC]
</pre></div>
<p>or by
</p><div class="example">
-<pre class="example"><?program ntpdc>
+<pre class="example-preformatted"><?program ntpdc>
</pre></div>
<p>Do not mix these styles within one configuration file.
</p>
<p>Compound values and carefully constructed string values may also be
specified using XML syntax:
</p><div class="example">
-<pre class="example"><option-name>
+<pre class="example-preformatted"><option-name>
<sub-opt>...&lt;...&gt;...</sub-opt>
</option-name>
</pre></div>
-<p>yielding an <code>option-name.sub-opt</code> string value of
+<p>yielding an <code class="code">option-name.sub-opt</code> string value of
</p><div class="example">
-<pre class="example">"...<...>..."
+<pre class="example-preformatted">"...<...>..."
</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
-hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching
+<p><code class="code">AutoOpts</code> does not track suboptions. You simply note that it is a
+hierarchicly valued option. <code class="code">AutoOpts</code> does provide a means for searching
the associated name/value pair list (see: optionFindValue).
</p>
<p>The command line options relating to configuration and/or usage help are:
</p>
-<span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
+<h4 class="subsubheading" id="version-_0028_002d_0029"><span>version (-)<a class="copiable-link" href="#version-_0028_002d_0029"> ¶</a></span></h4>
<p>Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing information may be selected with an option argument.
Only the first letter of the argument is examined:
</p>
-<dl compact="compact">
-<dt>‘<samp>version</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">version</samp>’</dt>
<dd><p>Only print the version. This is the default.
</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
+<dt>‘<samp class="samp">copyright</samp>’</dt>
<dd><p>Name the copyright usage licensing terms.
</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>Print the full copyright usage licensing terms.
</p></dd>
</dl>
<hr>
-<span id="ntpdc-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-exit-status">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-Usage" accesskey="n" rel="next">ntpdc Usage</a>, Previous: <a href="#ntpdc-config" accesskey="p" rel="prev">ntpdc config</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-Usage" accesskey="n" rel="next">ntpdc Usage</a>, Previous: <a href="#ntpdc-config" accesskey="p" rel="prev">presetting/configuring ntpdc</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-exit-status-1"></span><h4 class="subsection">1.1.12 ntpdc exit status</h4>
+<h4 class="subsection" id="ntpdc-exit-status-1"><span>1.1.12 ntpdc exit status<a class="copiable-link" href="#ntpdc-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
-<dt>‘<samp>66 (EX_NOINPUT)</samp>’</dt>
+<dt>‘<samp class="samp">66 (EX_NOINPUT)</samp>’</dt>
<dd><p>A specified configuration file could not be loaded.
</p></dd>
-<dt>‘<samp>70 (EX_SOFTWARE)</samp>’</dt>
+<dt>‘<samp class="samp">70 (EX_SOFTWARE)</samp>’</dt>
<dd><p>libopts had an internal operational error. Please report
it to autogen-users@lists.sourceforge.net. Thank you.
</p></dd>
</dl>
<hr>
-<span id="ntpdc-Usage"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-Usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-See-Also" accesskey="n" rel="next">ntpdc See Also</a>, Previous: <a href="#ntpdc-exit-status" accesskey="p" rel="prev">ntpdc exit status</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-See-Also" accesskey="n" rel="next">ntpdc See Also</a>, Previous: <a href="#ntpdc-exit-status" accesskey="p" rel="prev">ntpdc exit status</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-Usage-1"></span><h4 class="subsection">1.1.13 ntpdc Usage</h4>
+<h4 class="subsection" id="ntpdc-Usage-1"><span>1.1.13 ntpdc Usage<a class="copiable-link" href="#ntpdc-Usage-1"> ¶</a></span></h4>
<hr>
-<span id="ntpdc-See-Also"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-See-Also">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-Authors" accesskey="n" rel="next">ntpdc Authors</a>, Previous: <a href="#ntpdc-Usage" accesskey="p" rel="prev">ntpdc Usage</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-Authors" accesskey="n" rel="next">ntpdc Authors</a>, Previous: <a href="#ntpdc-Usage" accesskey="p" rel="prev">ntpdc Usage</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-See-Also-1"></span><h4 class="subsection">1.1.14 ntpdc See Also</h4>
+<h4 class="subsection" id="ntpdc-See-Also-1"><span>1.1.14 ntpdc See Also<a class="copiable-link" href="#ntpdc-See-Also-1"> ¶</a></span></h4>
<hr>
-<span id="ntpdc-Authors"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-Authors">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpdc-Bugs" accesskey="n" rel="next">ntpdc Bugs</a>, Previous: <a href="#ntpdc-See-Also" accesskey="p" rel="prev">ntpdc See Also</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Next: <a href="#ntpdc-Bugs" accesskey="n" rel="next">ntpdc Bugs</a>, Previous: <a href="#ntpdc-See-Also" accesskey="p" rel="prev">ntpdc See Also</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-Authors-1"></span><h4 class="subsection">1.1.15 ntpdc Authors</h4>
+<h4 class="subsection" id="ntpdc-Authors-1"><span>1.1.15 ntpdc Authors<a class="copiable-link" href="#ntpdc-Authors-1"> ¶</a></span></h4>
<hr>
-<span id="ntpdc-Bugs"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpdc-Bugs">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntpdc-Authors" accesskey="p" rel="prev">ntpdc Authors</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> </p>
+Previous: <a href="#ntpdc-Authors" accesskey="p" rel="prev">ntpdc Authors</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">Invoking ntpdc</a> </p>
</div>
-<span id="ntpdc-Bugs-1"></span><h4 class="subsection">1.1.16 ntpdc Bugs</h4>
+<h4 class="subsection" id="ntpdc-Bugs-1"><span>1.1.16 ntpdc Bugs<a class="copiable-link" href="#ntpdc-Bugs-1"> ¶</a></span></h4>
<hr>
-<span id="Usage"></span><div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntpdc-Invocation" accesskey="p" rel="prev">ntpdc Invocation</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">ntpdc Description</a> </p>
+Previous: <a href="#ntpdc-Invocation" accesskey="p" rel="prev">Invoking ntpdc</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Usage-1"></span><h3 class="section">1.2 Usage</h3>
+<h3 class="section" id="Usage-1"><span>1.2 Usage<a class="copiable-link" href="#Usage-1"> ¶</a></span></h3>
<p>The simplest use of this program is as an unprivileged command to
check the current time, offset, and error in the local clock.
For example:
</p>
<div class="example">
-<pre class="example">ntpdc ntpserver.somewhere
+<pre class="example-preformatted">ntpdc ntpserver.somewhere
</pre></div>
<p>With suitable privilege, it can be run as a command or in a
-<code>cron</code> job to reset the local clock from a reliable server, like
-the <code>ntpdate</code> and <code>rdate</code> commands.
+<code class="code">cron</code> job to reset the local clock from a reliable server, like
+the <code class="code">ntpdate</code> and <code class="code">rdate</code> commands.
For example:
</p>
<div class="example">
-<pre class="example">ntpdc -a ntpserver.somewhere
+<pre class="example-preformatted">ntpdc -a ntpserver.somewhere
</pre></div>
-<hr>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpdc @NTPDC_MS@ "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpdc @NTPDC_MS@ "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:01 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:44 AM by AutoGen 5.18.16
.\" From the definitions ntpdc-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH AUTHORS
The formatting directives in this document came from FreeBSD.
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
The
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPDC @NTPDC_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpdc-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:37:57 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:40 AM by AutoGen 5.18.16
.\" From the definitions ntpdc-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh AUTHORS
The formatting directives in this document came from FreeBSD.
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
The
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpq.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:38:12 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:34:53 AM by AutoGen 5.18.16
# From the definitions ntpq-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
/*
* EDIT THIS FILE WITH CAUTION (ntpq-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:03 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:35:55 AM by AutoGen 5.18.16
* From the definitions ntpq-opts.def
* and the template file options
*
* The ntpq program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const ntpq_opt_strs[2068] =
/* 0 */ "ntpq 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via ntpqOptions.pzCopyright */
puts(_("ntpq 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (ntpq-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:02 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:35:55 AM by AutoGen 5.18.16
* From the definitions ntpq-opts.def
* and the template file options
*
* The ntpq program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpq 1ntpqman "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpq 1ntpqman "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:15 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:55 AM by AutoGen 5.18.16
.\" From the definitions ntpq-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPQ 1ntpqmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpq-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:51 AM by AutoGen 5.18.16
.\" From the definitions ntpq-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ntpq: Network Time Protocol Query User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntpq-Description" rel="next" title="ntpq Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">ntpq: Network Time Protocol Query User’s Manual</h1>
-
-<span id="SEC_Overview"></span>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
-</ul>
-</div>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-Description" accesskey="n" rel="next">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>
</div>
-<span id="ntpq_003a-Network-Time-Protocol-Query-User-Manual"></span><h1 class="top">ntpq: Network Time Protocol Query User Manual</h1>
+<h1 class="top" id="ntpq_003a-Network-Time-Protocol-Query-User-Manual"><span>ntpq: Network Time Protocol Query User Manual<a class="copiable-link" href="#ntpq_003a-Network-Time-Protocol-Query-User-Manual"> ¶</a></span></h1>
-<p>The <code>ntpq</code> utility program is used to
+<p>The <code class="code">ntpq</code> utility program is used to
monitor the operational status
and determine the performance of
-<code>ntpd</code>, the NTP daemon.
-</p>
-<p>This document applies to version 4.2.8p17 of <code>ntpq</code>.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpq-Description" accesskey="1">ntpq Description</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<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
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="3">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Internal-Commands" accesskey="4">Internal Commands</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<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">
-</td></tr>
-<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">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#System-Variables" accesskey="7">System Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Peer-Variables" accesskey="8">Peer Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Clock-Variables" accesskey="9">Clock Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
+<code class="code">ntpd</code>, the NTP daemon.
+</p>
+<p>This document applies to version 4.2.8p17 of <code class="code">ntpq</code>.
+</p>
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
+<h2 class="shortcontents-heading">Short Table of Contents</h2>
+<div class="shortcontents">
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntpq-Description">1 Description</a></li>
+</ul>
+</div>
+</div>
<hr>
-<span id="ntpq-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntpq-Description">
+<div class="nav-panel">
<p>
-Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#Top" accesskey="p" rel="prev">ntpq: Network Time Protocol Query User Manual</a>, Up: <a href="#Top" accesskey="u" rel="up">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>The <code>ntpq</code> utility program is used to monitor NTP daemon <code>ntpd</code> operations and determine performance.
+<p>The <code class="code">ntpq</code> utility program is used to monitor NTP daemon <code class="code">ntpd</code> operations and determine performance.
It uses the standard NTP mode 6 control message formats defined in
Appendix B of the NTPv3 specification RFC1305.
The same formats are used in NTPv4, although some of the variable names have changed and new ones added.
The description on this page is for the NTPv4 variables.
</p>
-<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.
-</p>
-<p>If one or more request options is included on the command line when <code>ntpq</code> is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, <code>ntpq</code> will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. <code>ntpq</code> will prompt for commands if the standard input is a terminal device.
-</p>
-<p><code>ntpq</code> uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. <code>ntpq</code> makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.
-</p>
-<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.
-</p>
-<p>For examples and usage, see the <a href="debug.html">NTP Debugging Techniques</a> page.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpq-Invocation" accesskey="1">Invoking ntpq</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="2">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Internal-Commands" accesskey="3">Internal Commands</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<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">
-</td></tr>
-<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">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#System-Variables" accesskey="6">System Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Peer-Variables" accesskey="7">Peer Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Clock-Variables" accesskey="8">Clock Variables</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<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 class="code">ntpq</code> can also obtain and print a list of peers in a common format by sending multiple queries to the server.
+</p>
+<p>If one or more request options is included on the command line when <code class="code">ntpq</code> is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, <code class="code">ntpq</code> will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. <code class="code">ntpq</code> will prompt for commands if the standard input is a terminal device.
+</p>
+<p><code class="code">ntpq</code> uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. <code class="code">ntpq</code> makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.
+</p>
+<p>Note that in contexts where a host name is expected, a <code class="code">-4</code> qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a <code class="code">-6</code> qualifier forces DNS resolution to the IPv6 namespace.
+</p>
+<p>For examples and usage, see the <a class="url" href="debug.html">NTP Debugging Techniques</a> page.
+</p>
+<ul class="mini-toc">
+<li><a href="#ntpq-Invocation" accesskey="1">Invoking ntpq</a></li>
+<li><a href="#Usage" accesskey="2">Usage</a></li>
+<li><a href="#Internal-Commands" accesskey="3">Internal Commands</a></li>
+<li><a href="#Control-Message-Commands" accesskey="4">Control Message Commands</a></li>
+<li><a href="#Status-Words-and-Kiss-Codes" accesskey="5">Status Words and Kiss Codes</a></li>
+<li><a href="#System-Variables" accesskey="6">System Variables</a></li>
+<li><a href="#Peer-Variables" accesskey="7">Peer Variables</a></li>
+<li><a href="#Clock-Variables" accesskey="8">Clock Variables</a></li>
+</ul>
<hr>
-<span id="ntpq-Invocation"></span><div class="header">
+<div class="section-level-extent" id="ntpq-Invocation">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#ntpq-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Invoking-ntpq"></span><h3 class="section">1.1 Invoking ntpq</h3>
-<span id="index-ntpq"></span>
-<span id="index-standard-NTP-query-program"></span>
+<h3 class="section" id="Invoking-ntpq"><span>1.1 Invoking ntpq<a class="copiable-link" href="#Invoking-ntpq"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntpq"></a>
+<a class="index-entry-id" id="index-standard-NTP-query-program"></a>
<p>The
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility program is used to query NTP servers to monitor NTP operations
and performance, requesting
information about current state and/or changes in that state.
variables can be assembled, with raw and pretty-printed output
options being available.
The
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
</p>
<p>If one or more request options is included on the command line
when
-<code>ntpq</code>
+<code class="code">ntpq</code>
is executed, each of the requests will be sent
to the NTP servers running on each of the hosts given as command
line arguments, or on localhost by default.
If no request options
are given,
-<code>ntpq</code>
+<code class="code">ntpq</code>
will attempt to read commands from the
standard input and execute these on the NTP server running on the
first host given on the command line, again defaulting to localhost
when no other host is specified.
The
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility will prompt for
commands if the standard input is a terminal device.
</p>
-<p><code>ntpq</code>
+<p><code class="code">ntpq</code>
uses NTP mode 6 packets to communicate with the
NTP server, and hence can be used to query any compatible server on
the network which permits it.
this communication will be somewhat unreliable, especially over
large distances in terms of network topology.
The
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility makes
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
</p>
<p>Note that in contexts where a host name is expected, a
-<code>-4</code>
+<code class="code">-4</code>
qualifier preceding the host name forces resolution to the IPv4
namespace, while a
-<code>-6</code>
+<code class="code">-6</code>
qualifier forces resolution to the IPv6 namespace.
For examples and usage, see the
“NTP Debugging Techniques”
</p>
<p>Specifying a
command line option other than
-<code>-i</code>
+<code class="code">-i</code>
or
-<code>-n</code>
+<code class="code">-n</code>
will
cause the specified query (queries) to be sent to the indicated
host(s) immediately.
Otherwise,
-<code>ntpq</code>
+<code class="code">ntpq</code>
will attempt to read
interactive format commands from the standard input.
</p>
-<table class="menu" border="0" cellspacing="0">
-<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">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-ipv4" accesskey="2">ipv4 option (-4)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-ipv6" accesskey="3">ipv6 option (-6)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-command" accesskey="4">command option (-c)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-interactive" accesskey="5">interactive option (-i)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-numeric" accesskey="6">numeric option (-n)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<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">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-peers" accesskey="8">peers option (-p)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-refid" accesskey="9">refid option (-r)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-unconnected">unconnected option (-u)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-wide">wide option (-w)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-config">presetting/configuring ntpq</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-exit-status">ntpq exit status</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
-<span id="Internal-Commands-1"></span><h4 class="subsection">1.1.1 Internal Commands</h4>
+<ul class="mini-toc">
+<li><a href="#Internal-Commands-1" accesskey="1">Internal Commands</a></li>
+<li><a href="#ntpq-usage" accesskey="2">ntpq help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#ntpq-ipv4" accesskey="3">ipv4 option (-4)</a></li>
+<li><a href="#ntpq-ipv6" accesskey="4">ipv6 option (-6)</a></li>
+<li><a href="#ntpq-command" accesskey="5">command option (-c)</a></li>
+<li><a href="#ntpq-interactive" accesskey="6">interactive option (-i)</a></li>
+<li><a href="#ntpq-numeric" accesskey="7">numeric option (-n)</a></li>
+<li><a href="#ntpq-old_002drv" accesskey="8">old-rv option</a></li>
+<li><a href="#ntpq-peers" accesskey="9">peers option (-p)</a></li>
+<li><a href="#ntpq-refid">refid option (-r)</a></li>
+<li><a href="#ntpq-unconnected">unconnected option (-u)</a></li>
+<li><a href="#ntpq-wide">wide option (-w)</a></li>
+<li><a href="#ntpq-config">presetting/configuring ntpq</a></li>
+<li><a href="#ntpq-exit-status">ntpq exit status</a></li>
+</ul>
+<div class="subsection-level-extent" id="Internal-Commands-1">
+<h4 class="subsection subsubsection-level-set-subsection"><span>1.1.1 Internal Commands<a class="copiable-link" href="#Internal-Commands-1"> ¶</a></span></h4>
<p>Interactive format commands consist of a keyword followed by zero
to four arguments.
<p>A
number of interactive format commands are executed entirely within
the
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility itself and do not result in NTP
requests being sent to a server.
These are described following.
-</p><dl compact="compact">
-<dt><code>?</code> <code>[<kbd>command</kbd>]</code></dt>
-<dt><code>help</code> <code>[<kbd>command</kbd>]</code></dt>
+</p><dl class="table">
+<dt><code class="code">?</code> <code class="code">[<kbd class="kbd">command</kbd>]</code></dt>
+<dt><code class="code">help</code> <code class="code">[<kbd class="kbd">command</kbd>]</code></dt>
<dd><p>A
‘?’
by itself will print a list of all the commands
known to
-<code>ntpq</code>
+<code class="code">ntpq</code>
A
‘?’
followed by a command name will print function and usage
information about the command.
</p></dd>
-<dt><code>addvars</code> <kbd>name</kbd><code>[=<kbd>value</kbd>]</code><code>[,...]</code></dt>
-<dt><code>rmvars</code> <kbd>name</kbd><code>[,...]</code></dt>
-<dt><code>clearvars</code></dt>
-<dt><code>showvars</code></dt>
+<dt><code class="code">addvars</code> <kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code><code class="code">[,...]</code></dt>
+<dt><code class="code">rmvars</code> <kbd class="kbd">name</kbd><code class="code">[,...]</code></dt>
+<dt><code class="code">clearvars</code></dt>
+<dt><code class="code">showvars</code></dt>
<dd><p>The arguments to this command consist of a list of
items of the form
-<kbd>name</kbd><code>[=<kbd>value</kbd>]</code>,
+<kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code>,
where the
.No = Ns Ar value
is ignored, and can be omitted,
in requests to the server to read variables.
The
-<code>ntpq</code>
+<code class="code">ntpq</code>
utility maintains an internal list in which data to be included in
messages can be assembled, and displayed or set using the
-<code>readlist</code>
+<code class="code">readlist</code>
and
-<code>writelist</code>
+<code class="code">writelist</code>
commands described below.
The
-<code>addvars</code>
+<code class="code">addvars</code>
command allows variables and their optional values to be added to
the list.
If more than one variable is to be added, the list should
be comma-separated and not contain white space.
The
-<code>rmvars</code>
+<code class="code">rmvars</code>
command can be used to remove individual variables from the list,
while the
-<code>clearvars</code>
+<code class="code">clearvars</code>
command removes all variables from the
list.
The
-<code>showvars</code>
+<code class="code">showvars</code>
command displays the current list of optional variables.
</p></dd>
-<dt><code>authenticate</code> <code>[<code>yes</code>|<code>no</code>]</code></dt>
+<dt><code class="code">authenticate</code> <code class="code">[<code class="code">yes</code>|<code class="code">no</code>]</code></dt>
<dd><p>Normally
-<code>ntpq</code>
+<code class="code">ntpq</code>
does not authenticate requests unless
they are write requests.
The command
-<code>authenticate</code> <code>yes</code>
+<code class="code">authenticate</code> <code class="code">yes</code>
causes
-<code>ntpq</code>
+<code class="code">ntpq</code>
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
requests slightly differently.
The command
-<code>authenticate</code>
+<code class="code">authenticate</code>
causes
-<code>ntpq</code>
+<code class="code">ntpq</code>
to display whether or not
it is currently authenticating requests.
</p></dd>
-<dt><code>cooked</code></dt>
+<dt><code class="code">cooked</code></dt>
<dd><p>Causes output from query commands to be "cooked", so that
variables which are recognized by
-<code>ntpq</code>
+<code class="code">ntpq</code>
will have their
values reformatted for human consumption.
Variables which
-<code>ntpq</code>
+<code class="code">ntpq</code>
could not decode completely are
marked with a trailing
‘?’.
</p></dd>
-<dt><code>debug</code> <code>[<code>more</code>|<code>less</code>|<code>off</code>]</code></dt>
+<dt><code class="code">debug</code> <code class="code">[<code class="code">more</code>|<code class="code">less</code>|<code class="code">off</code>]</code></dt>
<dd><p>With no argument, displays the current debug level.
Otherwise, the debugging level is changed as indicated.
</p></dd>
-<dt><code>delay</code> <code>[<kbd>milliseconds</kbd>]</code></dt>
+<dt><code class="code">delay</code> <code class="code">[<kbd class="kbd">milliseconds</kbd>]</code></dt>
<dd><p>Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
so this command may be obsolete.
Without any arguments, displays the current delay.
</p></dd>
-<dt><code>drefid</code> <code>[<code>hash</code>|<code>ipv4</code>]</code></dt>
+<dt><code class="code">drefid</code> <code class="code">[<code class="code">hash</code>|<code class="code">ipv4</code>]</code></dt>
<dd><p>Display refids as IPv4 or hash.
Without any arguments, displays whether refids are shown as IPv4
addresses or hashes.
</p></dd>
-<dt><code>exit</code></dt>
+<dt><code class="code">exit</code></dt>
<dd><p>Exit
-<code>ntpq</code>
+<code class="code">ntpq</code>
</p></dd>
-<dt><code>host</code> <code>[<kbd>name</kbd>]</code></dt>
+<dt><code class="code">host</code> <code class="code">[<kbd class="kbd">name</kbd>]</code></dt>
<dd><p>Set the host to which future queries will be sent.
The
-<kbd>name</kbd>
+<kbd class="kbd">name</kbd>
may be either a host name or a numeric address.
Without any arguments, displays the current host.
</p></dd>
-<dt><code>hostnames</code> <code>[<code>yes</code>|<code>no</code>]</code></dt>
+<dt><code class="code">hostnames</code> <code class="code">[<code class="code">yes</code>|<code class="code">no</code>]</code></dt>
<dd><p>If
-<code>yes</code>
+<code class="code">yes</code>
is specified, host names are printed in
information displays.
If
-<code>no</code>
+<code class="code">no</code>
is specified, numeric
addresses are printed instead.
The default is
-<code>yes</code>,
+<code class="code">yes</code>,
unless
modified using the command line
-<code>-n</code>
+<code class="code">-n</code>
switch.
Without any arguments, displays whether host names or numeric addresses
are shown.
</p></dd>
-<dt><code>keyid</code> <code>[<kbd>keyid</kbd>]</code></dt>
+<dt><code class="code">keyid</code> <code class="code">[<kbd class="kbd">keyid</kbd>]</code></dt>
<dd><p>This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
to the
-<code>controlkey</code>
+<code class="code">controlkey</code>
key number the server has been configured to use for this
purpose.
Without any arguments, displays the current
-<kbd>keyid</kbd>.
+<kbd class="kbd">keyid</kbd>.
</p></dd>
-<dt><code>keytype</code> <code>[<kbd>digest</kbd>]</code></dt>
+<dt><code class="code">keytype</code> <code class="code">[<kbd class="kbd">digest</kbd>]</code></dt>
<dd><p>Specify the digest algorithm to use for authenticating requests, with default
-<code>MD5</code>.
+<code class="code">MD5</code>.
If
-<code>ntpq</code>
+<code class="code">ntpq</code>
was built with OpenSSL support, and OpenSSL is installed,
-<kbd>digest</kbd>
+<kbd class="kbd">digest</kbd>
can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-<code>keytype</code> <kbd>digest</kbd>
+<code class="code">keytype</code> <kbd class="kbd">digest</kbd>
algorithm used is displayed.
</p></dd>
-<dt><code>ntpversion</code> <code>[<code>1</code>|<code>2</code>|<code>3</code>|<code>4</code>]</code></dt>
+<dt><code class="code">ntpversion</code> <code class="code">[<code class="code">1</code>|<code class="code">2</code>|<code class="code">3</code>|<code class="code">4</code>]</code></dt>
<dd><p>Sets the NTP version number which
-<code>ntpq</code>
+<code class="code">ntpq</code>
claims in
packets.
Defaults to 3, and note that mode 6 control messages (and
With no argument, displays the current NTP version that will be used
when communicating with servers.
</p></dd>
-<dt><code>passwd</code></dt>
+<dt><code class="code">passwd</code></dt>
<dd><p>This command prompts you to type in a password (which will not
be echoed) which will be used to authenticate configuration
requests.
use by the NTP server for this purpose if such requests are to be
successful.
</p></dd>
-<dt><code>poll</code> <code>[<kbd>n</kbd>]</code> <code>[<code>verbose</code>]</code></dt>
+<dt><code class="code">poll</code> <code class="code">[<kbd class="kbd">n</kbd>]</code> <code class="code">[<code class="code">verbose</code>]</code></dt>
<dd><p>Poll an NTP server in client mode
-<kbd>n</kbd>
+<kbd class="kbd">n</kbd>
times.
Poll not implemented yet.
</p></dd>
-<dt><code>quit</code></dt>
+<dt><code class="code">quit</code></dt>
<dd><p>Exit
-<code>ntpq</code>
+<code class="code">ntpq</code>
</p></dd>
-<dt><code>raw</code></dt>
+<dt><code class="code">raw</code></dt>
<dd><p>Causes all output from query commands is printed as received
from the remote server.
The only formating/interpretation done on
the data is to transform nonascii data into a printable (but barely
understandable) form.
</p></dd>
-<dt><code>timeout</code> <code>[<kbd>milliseconds</kbd>]</code></dt>
+<dt><code class="code">timeout</code> <code class="code">[<kbd class="kbd">milliseconds</kbd>]</code></dt>
<dd><p>Specify a timeout period for responses to server queries.
The
default is about 5000 milliseconds.
Without any arguments, displays the current timeout period.
Note that since
-<code>ntpq</code>
+<code class="code">ntpq</code>
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
</p></dd>
-<dt><code>version</code></dt>
+<dt><code class="code">version</code></dt>
<dd><p>Display the version of the
-<code>ntpq</code>
+<code class="code">ntpq</code>
program.
</p></dd>
</dl>
-<span id="Control-Message-Commands-1"></span><h4 class="subsubsection">1.1.1.1 Control Message Commands</h4>
+<ul class="mini-toc">
+<li><a href="#Control-Message-Commands-1" accesskey="1">Control Message Commands</a></li>
+<li><a href="#Status-Words-and-Kiss-Codes-1" accesskey="2">Status Words and Kiss Codes</a></li>
+<li><a href="#System-Variables-1" accesskey="3">System Variables</a></li>
+<li><a href="#Peer-Variables-1" accesskey="4">Peer Variables</a></li>
+<li><a href="#Clock-Variables-1" accesskey="5">Clock Variables</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Control-Message-Commands-1">
+<h4 class="subsubsection"><span>1.1.1.1 Control Message Commands<a class="copiable-link" href="#Control-Message-Commands-1"> ¶</a></span></h4>
<p>Association ids are used to identify system, peer and clock variables.
System variables are assigned an association id of zero and system name
space, while each association is assigned a nonzero association id and
Most control commands send a single message to the server and expect a
single response message.
The exceptions are the
-<code>peers</code>
+<code class="code">peers</code>
command, which sends a series of messages,
and the
-<code>mreadlist</code>
+<code class="code">mreadlist</code>
and
-<code>mreadvar</code>
+<code class="code">mreadvar</code>
commands, which iterate over a range of associations.
-</p><dl compact="compact">
-<dt><code>apeers</code></dt>
+</p><dl class="table">
+<dt><code class="code">apeers</code></dt>
<dd><p>Display a list of peers in the form:
</p><div class="example">
-<pre class="example">[tally]remote refid assid st t when pool reach delay offset jitter
+<pre class="example-preformatted">[tally]remote refid assid st t when pool reach delay offset jitter
</pre></div>
<p>where the output is just like the
-<code>peers</code>
+<code class="code">peers</code>
command except that the
-<code>refid</code>
+<code class="code">refid</code>
is displayed in hex format and the association number is also displayed.
</p></dd>
-<dt><code>associations</code></dt>
+<dt><code class="code">associations</code></dt>
<dd><p>Display a list of mobilized associations in the form:
</p><div class="example">
-<pre class="example">ind assid status conf reach auth condition last_event cnt
+<pre class="example-preformatted">ind assid status conf reach auth condition last_event cnt
</pre></div>
-<dl compact="compact">
+<dl class="table">
<dt>Sy Variable Ta Sy Description</dt>
-<dt><code>ind</code> <code>Ta</code> <code>index</code> <code>on</code> <code>this</code> <code>list</code></dt>
-<dt><code>assid</code> <code>Ta</code> <code>association</code> <code>id</code></dt>
-<dt><code>status</code> <code>Ta</code> <code>peer</code> <code>status</code> <code>word</code></dt>
-<dt><code>conf</code> <code>Ta</code> <code>yes</code>: <code>No</code> <code>persistent,</code> <code>no</code>: <code>No</code> <code>ephemeral</code></dt>
-<dt><code>reach</code> <code>Ta</code> <code>yes</code>: <code>No</code> <code>reachable,</code> <code>no</code>: <code>No</code> <code>unreachable</code></dt>
-<dt><code>auth</code> <code>Ta</code> <code>ok</code>, <code>yes</code>, <code>bad</code> <code>No</code> <code>and</code> <code>none</code></dt>
-<dt><code>condition</code> <code>Ta</code> <code>selection</code> <code>status</code> <code>(see</code> <code>the</code> <code>select</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code></dt>
-<dt><code>last_event</code> <code>Ta</code> <code>event</code> <code>report</code> <code>(see</code> <code>the</code> <code>event</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code></dt>
-<dt><code>cnt</code> <code>Ta</code> <code>event</code> <code>count</code> <code>(see</code> <code>the</code> <code>count</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code></dt>
+<dt><code class="code">ind</code> <code class="code">Ta</code> <code class="code">index</code> <code class="code">on</code> <code class="code">this</code> <code class="code">list</code></dt>
+<dt><code class="code">assid</code> <code class="code">Ta</code> <code class="code">association</code> <code class="code">id</code></dt>
+<dt><code class="code">status</code> <code class="code">Ta</code> <code class="code">peer</code> <code class="code">status</code> <code class="code">word</code></dt>
+<dt><code class="code">conf</code> <code class="code">Ta</code> <code class="code">yes</code>: <code class="code">No</code> <code class="code">persistent,</code> <code class="code">no</code>: <code class="code">No</code> <code class="code">ephemeral</code></dt>
+<dt><code class="code">reach</code> <code class="code">Ta</code> <code class="code">yes</code>: <code class="code">No</code> <code class="code">reachable,</code> <code class="code">no</code>: <code class="code">No</code> <code class="code">unreachable</code></dt>
+<dt><code class="code">auth</code> <code class="code">Ta</code> <code class="code">ok</code>, <code class="code">yes</code>, <code class="code">bad</code> <code class="code">No</code> <code class="code">and</code> <code class="code">none</code></dt>
+<dt><code class="code">condition</code> <code class="code">Ta</code> <code class="code">selection</code> <code class="code">status</code> <code class="code">(see</code> <code class="code">the</code> <code class="code">select</code> <code class="code">No</code> <code class="code">field</code> <code class="code">of</code> <code class="code">the</code> <code class="code">peer</code> <code class="code">status</code> <code class="code">word)</code></dt>
+<dt><code class="code">last_event</code> <code class="code">Ta</code> <code class="code">event</code> <code class="code">report</code> <code class="code">(see</code> <code class="code">the</code> <code class="code">event</code> <code class="code">No</code> <code class="code">field</code> <code class="code">of</code> <code class="code">the</code> <code class="code">peer</code> <code class="code">status</code> <code class="code">word)</code></dt>
+<dt><code class="code">cnt</code> <code class="code">Ta</code> <code class="code">event</code> <code class="code">count</code> <code class="code">(see</code> <code class="code">the</code> <code class="code">count</code> <code class="code">No</code> <code class="code">field</code> <code class="code">of</code> <code class="code">the</code> <code class="code">peer</code> <code class="code">status</code> <code class="code">word)</code></dt>
</dl>
</dd>
-<dt><code>authinfo</code></dt>
+<dt><code class="code">authinfo</code></dt>
<dd><p>Display the authentication statistics counters:
time since reset, stored keys, free keys, key lookups, keys not found,
uncached keys, expired keys, encryptions, decryptions.
</p></dd>
-<dt><code>clocklist</code> <code>[<kbd>associd</kbd>]</code></dt>
-<dt><code>cl</code> <code>[<kbd>associd</kbd>]</code></dt>
+<dt><code class="code">clocklist</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code></dt>
+<dt><code class="code">cl</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code></dt>
<dd><p>Display all clock variables in the variable list for those associations
supporting a reference clock.
</p></dd>
-<dt><code>clockvar</code> <code>[<kbd>associd</kbd>]</code> <code>[<kbd>name</kbd><code>[=<kbd>value</kbd>]</code>]</code><code>[,...]</code></dt>
-<dt><code>cv</code> <code>[<kbd>associd</kbd>]</code> <code>[<kbd>name</kbd><code>[=<kbd>value</kbd>]</code>]</code><code>[,...]</code></dt>
+<dt><code class="code">clockvar</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code> <code class="code">[<kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code>]</code><code class="code">[,...]</code></dt>
+<dt><code class="code">cv</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code> <code class="code">[<kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code>]</code><code class="code">[,...]</code></dt>
<dd><p>Display a list of clock variables for those associations supporting a
reference clock.
</p></dd>
-<dt><code>:config</code> <kbd>configuration command line</kbd></dt>
+<dt><code class="code">:config</code> <kbd class="kbd">configuration command line</kbd></dt>
<dd><p>Send the remainder of the command line, including whitespace, to the
server as a run-time configuration command in the same format as a line
in the configuration file.
This command is experimental until further notice and clarification.
Authentication is of course required.
</p></dd>
-<dt><code>config-from-file</code> <kbd>filename</kbd></dt>
+<dt><code class="code">config-from-file</code> <kbd class="kbd">filename</kbd></dt>
<dd><p>Send each line of
-<kbd>filename</kbd>
+<kbd class="kbd">filename</kbd>
to the server as run-time configuration commands in the same format as
lines in the configuration file.
This command is experimental until further notice and clarification.
Authentication is required.
</p></dd>
-<dt><code>ifstats</code></dt>
+<dt><code class="code">ifstats</code></dt>
<dd><p>Display status and statistics counters for each local network interface address:
interface number, interface name and address or broadcast, drop, flag,
ttl, mc, received, sent, send failed, peers, uptime.
Authentication is required.
</p></dd>
-<dt><code>iostats</code></dt>
+<dt><code class="code">iostats</code></dt>
<dd><p>Display network and reference clock I/O statistics:
time since reset, receive buffers, free receive buffers, used receive buffers,
low water refills, dropped packets, ignored packets, received packets,
packets sent, packet send failures, input wakeups, useful input wakeups.
</p></dd>
-<dt><code>kerninfo</code></dt>
+<dt><code class="code">kerninfo</code></dt>
<dd><p>Display kernel loop and PPS statistics:
associd, status, pll offset, pll frequency, maximum error,
estimated error, kernel status, pll time constant, precision,
The precision value displayed is in milliseconds as well, unlike the
precision system variable.
</p></dd>
-<dt><code>lassociations</code></dt>
+<dt><code class="code">lassociations</code></dt>
<dd><p>Perform the same function as the associations command, except display
mobilized and unmobilized associations, including all clients.
</p></dd>
-<dt><code>lopeers</code> <code>[<code>-4</code>|<code>-6</code>]</code></dt>
+<dt><code class="code">lopeers</code> <code class="code">[<code class="code">-4</code>|<code class="code">-6</code>]</code></dt>
<dd><p>Display a list of all peers and clients showing
-<code>dstadr</code>
+<code class="code">dstadr</code>
(associated with the given IP version).
</p></dd>
-<dt><code>lpassociations</code></dt>
+<dt><code class="code">lpassociations</code></dt>
<dd><p>Display the last obtained list of associations, including all clients.
</p></dd>
-<dt><code>lpeers</code> <code>[<code>-4</code>|<code>-6</code>]</code></dt>
+<dt><code class="code">lpeers</code> <code class="code">[<code class="code">-4</code>|<code class="code">-6</code>]</code></dt>
<dd><p>Display a list of all peers and clients (associated with the given IP version).
</p></dd>
-<dt><code>monstats</code></dt>
+<dt><code class="code">monstats</code></dt>
<dd><p>Display monitor facility status, statistics, and limits:
enabled, addresses, peak addresses, maximum addresses,
reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
</p></dd>
-<dt><code>mreadlist</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd></dt>
-<dt><code>mrl</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd></dt>
+<dt><code class="code">mreadlist</code> <kbd class="kbd">associdlo</kbd> <kbd class="kbd">associdhi</kbd></dt>
+<dt><code class="code">mrl</code> <kbd class="kbd">associdlo</kbd> <kbd class="kbd">associdhi</kbd></dt>
<dd><p>Perform the same function as the
-<code>readlist</code>
+<code class="code">readlist</code>
command for a range of association ids.
</p></dd>
-<dt><code>mreadvar</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd> <code>[<kbd>name</kbd>]</code><code>[,...]</code></dt>
+<dt><code class="code">mreadvar</code> <kbd class="kbd">associdlo</kbd> <kbd class="kbd">associdhi</kbd> <code class="code">[<kbd class="kbd">name</kbd>]</code><code class="code">[,...]</code></dt>
<dd><p>This range may be determined from the list displayed by any
command showing associations.
</p></dd>
-<dt><code>mrv</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd> <code>[<kbd>name</kbd>]</code><code>[,...]</code></dt>
+<dt><code class="code">mrv</code> <kbd class="kbd">associdlo</kbd> <kbd class="kbd">associdhi</kbd> <code class="code">[<kbd class="kbd">name</kbd>]</code><code class="code">[,...]</code></dt>
<dd><p>Perform the same function as the
-<code>readvar</code>
+<code class="code">readvar</code>
command for a range of association ids.
This range may be determined from the list displayed by any
command showing associations.
</p></dd>
-<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>
+<dt><code class="code">mrulist</code> <code class="code">[<code class="code">limited</code> | <code class="code">kod</code> | <code class="code">mincount</code>=<kbd class="kbd">count</kbd> | <code class="code">laddr</code>=<kbd class="kbd">localaddr</kbd> | <code class="code">sort</code>=<code class="code">[-]</code><kbd class="kbd">sortorder</kbd> | <code class="code">resany</code>=<kbd class="kbd">hexmask</kbd> | <code class="code">resall</code>=<kbd class="kbd">hexmask</kbd>]</code></dt>
<dd><p>Display traffic counts of the most recently seen source addresses
collected and maintained by the monitor facility.
With the exception of
-<code>sort</code>=<code>[-]</code><kbd>sortorder</kbd>,
+<code class="code">sort</code>=<code class="code">[-]</code><kbd class="kbd">sortorder</kbd>,
the options filter the list returned by
-<code>ntpd(8)</code>.
+<code class="code">ntpd(8)</code>.
The
-<code>limited</code>
+<code class="code">limited</code>
and
-<code>kod</code>
+<code class="code">kod</code>
options return only entries representing client addresses from which the
last packet received triggered either discarding or a KoD response.
The
-<code>mincount</code>=<kbd>count</kbd>
+<code class="code">mincount</code>=<kbd class="kbd">count</kbd>
option filters entries representing less than
-<kbd>count</kbd>
+<kbd class="kbd">count</kbd>
packets.
The
-<code>laddr</code>=<kbd>localaddr</kbd>
+<code class="code">laddr</code>=<kbd class="kbd">localaddr</kbd>
option filters entries for packets received on any local address other than
-<kbd>localaddr</kbd>.
-<code>resany</code>=<kbd>hexmask</kbd>
+<kbd class="kbd">localaddr</kbd>.
+<code class="code">resany</code>=<kbd class="kbd">hexmask</kbd>
and
-<code>resall</code>=<kbd>hexmask</kbd>
+<code class="code">resall</code>=<kbd class="kbd">hexmask</kbd>
filter entries containing none or less than all, respectively, of the bits in
-<kbd>hexmask</kbd>,
+<kbd class="kbd">hexmask</kbd>,
which must begin with
-<code>0x</code>.
+<code class="code">0x</code>.
The
-<kbd>sortorder</kbd>
+<kbd class="kbd">sortorder</kbd>
defaults to
-<code>lstint</code>
+<code class="code">lstint</code>
and may be
-<code>addr</code>,
-<code>avgint</code>,
-<code>count</code>,
-<code>lstint</code>,
+<code class="code">addr</code>,
+<code class="code">avgint</code>,
+<code class="code">count</code>,
+<code class="code">lstint</code>,
or any of those preceded by
‘-’
to reverse the sort order.
The output columns are:
-</p><dl compact="compact">
+</p><dl class="table">
<dt>Column</dt>
<dd><p>Description
</p></dd>
-<dt><code>lstint</code></dt>
+<dt><code class="code">lstint</code></dt>
<dd><p>Interval in seconds between the receipt of the most recent packet from
this address and the completion of the retrieval of the MRU list by
-<code>ntpq</code>
+<code class="code">ntpq</code>
</p></dd>
-<dt><code>avgint</code></dt>
+<dt><code class="code">avgint</code></dt>
<dd><p>Average interval in s between packets from this address.
</p></dd>
-<dt><code>rstr</code></dt>
+<dt><code class="code">rstr</code></dt>
<dd><p>Restriction flags associated with this address.
Most are copied unchanged from the matching
-<code>restrict</code>
+<code class="code">restrict</code>
command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
the last packet from this address triggered a rate control response.
</p></dd>
-<dt><code>r</code></dt>
+<dt><code class="code">r</code></dt>
<dd><p>Rate control indicator, either
a period,
-<code>L</code>
+<code class="code">L</code>
or
-<code>K</code>
+<code class="code">K</code>
for no rate control response,
rate limiting by discarding, or rate limiting with a KoD response, respectively.
</p></dd>
-<dt><code>m</code></dt>
+<dt><code class="code">m</code></dt>
<dd><p>Packet mode.
</p></dd>
-<dt><code>v</code></dt>
+<dt><code class="code">v</code></dt>
<dd><p>Packet version number.
</p></dd>
-<dt><code>count</code></dt>
+<dt><code class="code">count</code></dt>
<dd><p>Packets received from this address.
</p></dd>
-<dt><code>rport</code></dt>
+<dt><code class="code">rport</code></dt>
<dd><p>Source port of last packet from this address.
</p></dd>
-<dt><code>remote</code> <code>address</code></dt>
+<dt><code class="code">remote</code> <code class="code">address</code></dt>
<dd><p>host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
</p></dd>
</dl>
</dd>
-<dt><code>opeers</code> <code>[<code>-4</code> | <code>-6</code>]</code></dt>
+<dt><code class="code">opeers</code> <code class="code">[<code class="code">-4</code> | <code class="code">-6</code>]</code></dt>
<dd><p>Obtain and print the old-style list of all peers and clients showing
-<code>dstadr</code>
+<code class="code">dstadr</code>
(associated with the given IP version),
rather than the
-<code>refid</code>.
+<code class="code">refid</code>.
</p></dd>
-<dt><code>passociations</code></dt>
+<dt><code class="code">passociations</code></dt>
<dd><p>Perform the same function as the
-<code>associations</code>
+<code class="code">associations</code>
command,
except that it uses previously stored data rather than making a new query.
</p></dd>
-<dt><code>peers</code></dt>
+<dt><code class="code">peers</code></dt>
<dd><p>Display a list of peers in the form:
</p><div class="example">
-<pre class="example">[tally]remote refid st t when pool reach delay offset jitter
+<pre class="example-preformatted">[tally]remote refid st t when pool reach delay offset jitter
</pre></div>
-<dl compact="compact">
+<dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>[tally]</code></dt>
+<dt><code class="code">[tally]</code></dt>
<dd><p>single-character code indicating current value of the
-<code>select</code>
+<code class="code">select</code>
field of the
.Lk decode.html#peer "peer status word"
</p></dd>
-<dt><code>remote</code></dt>
+<dt><code class="code">remote</code></dt>
<dd><p>host name (or IP number) of peer.
The value displayed will be truncated to 15 characters unless the
-<code>ntpq</code>
-<code>-w</code>
+<code class="code">ntpq</code>
+<code class="code">-w</code>
option is given, in which case the full value will be displayed
on the first line, and if too long,
the remaining data will be displayed on the next line.
</p></dd>
-<dt><code>refid</code></dt>
+<dt><code class="code">refid</code></dt>
<dd><p>source IP address or
.Lk decode.html#kiss "’kiss code"
</p></dd>
-<dt><code>st</code></dt>
+<dt><code class="code">st</code></dt>
<dd><p>stratum: 0 for local reference clocks, 1 for servers with local
reference clocks, ..., 16 for unsynchronized server clocks
</p></dd>
-<dt><code>t</code></dt>
-<dd><p><code>u</code>:
+<dt><code class="code">t</code></dt>
+<dd><p><code class="code">u</code>:
unicast or manycast client,
-<code>b</code>:
+<code class="code">b</code>:
broadcast or multicast client,
-<code>p</code>:
+<code class="code">p</code>:
pool source,
-<code>l</code>:
+<code class="code">l</code>:
local (reference clock),
-<code>s</code>:
+<code class="code">s</code>:
symmetric (peer),
-<code>A</code>:
+<code class="code">A</code>:
manycast server,
-<code>B</code>:
+<code class="code">B</code>:
broadcast server,
-<code>M</code>:
+<code class="code">M</code>:
multicast server
</p></dd>
-<dt><code>when</code></dt>
+<dt><code class="code">when</code></dt>
<dd><p>time in seconds, minutes, hours, or days since the last packet
was received, or
‘-’
if a packet has never been received
</p></dd>
-<dt><code>poll</code></dt>
+<dt><code class="code">poll</code></dt>
<dd><p>poll interval (s)
</p></dd>
-<dt><code>reach</code></dt>
+<dt><code class="code">reach</code></dt>
<dd><p>reach shift register (octal)
</p></dd>
-<dt><code>delay</code></dt>
+<dt><code class="code">delay</code></dt>
<dd><p>roundtrip delay
</p></dd>
-<dt><code>offset</code></dt>
+<dt><code class="code">offset</code></dt>
<dd><p>offset of server relative to this host
</p></dd>
-<dt><code>jitter</code></dt>
+<dt><code class="code">jitter</code></dt>
<dd><p>offset RMS error estimate.
</p></dd>
</dl>
</dd>
-<dt><code>pstats</code> <kbd>associd</kbd></dt>
+<dt><code class="code">pstats</code> <kbd class="kbd">associd</kbd></dt>
<dd><p>Display the statistics for the peer with the given
-<kbd>associd</kbd>:
+<kbd class="kbd">associd</kbd>:
associd, status, remote host, local address, time last received,
time until next send, reachability change, packets sent,
packets received, bad authentication, bogus origin, duplicate,
bad dispersion, bad reference time, candidate order.
</p></dd>
-<dt><code>readlist</code> <code>[<kbd>associd</kbd>]</code></dt>
-<dt><code>rl</code> <code>[<kbd>associd</kbd>]</code></dt>
+<dt><code class="code">readlist</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code></dt>
+<dt><code class="code">rl</code> <code class="code">[<kbd class="kbd">associd</kbd>]</code></dt>
<dd><p>Display all system or peer variables.
If the
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is omitted, it is assumed to be zero.
</p></dd>
-<dt><code>readvar</code> <code>[<kbd>associd</kbd> <kbd>name</kbd><code>[=<kbd>value</kbd>]</code> <code>[, ...]</code>]</code></dt>
-<dt><code>rv</code> <code>[<kbd>associd</kbd> <kbd>name</kbd><code>[=<kbd>value</kbd>]</code> <code>[, ...]</code>]</code></dt>
+<dt><code class="code">readvar</code> <code class="code">[<kbd class="kbd">associd</kbd> <kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code> <code class="code">[, ...]</code>]</code></dt>
+<dt><code class="code">rv</code> <code class="code">[<kbd class="kbd">associd</kbd> <kbd class="kbd">name</kbd><code class="code">[=<kbd class="kbd">value</kbd>]</code> <code class="code">[, ...]</code>]</code></dt>
<dd><p>Display the specified system or peer variables.
If
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is zero, the variables are from the
-<a href="#System-Variables">System Variables</a>
+<a class="ref" href="#System-Variables">System Variables</a>
name space, otherwise they are from the
-<a href="#Peer-Variables">Peer Variables</a>
+<a class="ref" href="#Peer-Variables">Peer Variables</a>
name space.
The
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is required, as the same name can occur in both spaces.
If no
-<kbd>name</kbd>
+<kbd class="kbd">name</kbd>
is included, all operative variables in the name space are displayed.
In this case only, if the
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is omitted, it is assumed to be zero.
Multiple names are specified with comma separators and without whitespace.
Note that time values are represented in milliseconds
and frequency values in parts-per-million (PPM).
Some NTP timestamps are represented in the format
-<kbd>YYYY</kbd><kbd>MM</kbd> <kbd>DD</kbd> <kbd>TTTT</kbd>,
+<kbd class="kbd">YYYY</kbd><kbd class="kbd">MM</kbd> <kbd class="kbd">DD</kbd> <kbd class="kbd">TTTT</kbd>,
where
-<kbd>YYYY</kbd>
+<kbd class="kbd">YYYY</kbd>
is the year,
-<kbd>MM</kbd>
+<kbd class="kbd">MM</kbd>
the month of year,
-<kbd>DD</kbd>
+<kbd class="kbd">DD</kbd>
the day of month and
-<kbd>TTTT</kbd>
+<kbd class="kbd">TTTT</kbd>
the time of day.
</p></dd>
-<dt><code>reslist</code></dt>
+<dt><code class="code">reslist</code></dt>
<dd><p>Display the access control (restrict) list for
-<code>ntpq</code>
+<code class="code">ntpq</code>
Authentication is required.
</p></dd>
-<dt><code>saveconfig</code> <kbd>filename</kbd></dt>
+<dt><code class="code">saveconfig</code> <kbd class="kbd">filename</kbd></dt>
<dd><p>Save the current configuration,
including any runtime modifications made by
-<code>:config</code>
+<code class="code">:config</code>
or
-<code>config-from-file</code>,
+<code class="code">config-from-file</code>,
to the NTP server host file
-<kbd>filename</kbd>.
+<kbd class="kbd">filename</kbd>.
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-<code>ntpd(8)</code>
+<code class="code">ntpd(8)</code>
configuration file.
-<kbd>filename</kbd>
+<kbd class="kbd">filename</kbd>
can use
-<code>date(1)</code>
+<code class="code">date(1)</code>
format specifiers to substitute the current date and time, for
example,
</p><div class="example">
-<pre class="example"><code>saveconfig</code> <samp>ntp-%Y%m%d-%H%M%S.conf</samp>.
+<pre class="example-preformatted"><code class="code">saveconfig</code> <samp class="file">ntp-%Y%m%d-%H%M%S.conf</samp>.
</pre></div>
<p>The filename used is stored in system variable
-<code>savedconfig</code>.
+<code class="code">savedconfig</code>.
Authentication is required.
</p></dd>
-<dt><code>sysinfo</code></dt>
+<dt><code class="code">sysinfo</code></dt>
<dd><p>Display system operational summary:
associd, status, system peer, system peer mode, leap indicator,
stratum, log2 precision, root delay, root dispersion,
reference id, reference time, system jitter, clock jitter,
clock wander, broadcast delay, symm. auth. delay.
</p></dd>
-<dt><code>sysstats</code></dt>
+<dt><code class="code">sysstats</code></dt>
<dd><p>Display system uptime and packet counts maintained in the
protocol module:
uptime, sysstats reset, packets received, current version,
declined, restricted, rate limited, KoD responses,
processed for time.
</p></dd>
-<dt><code>timerstats</code></dt>
+<dt><code class="code">timerstats</code></dt>
<dd><p>Display interval timer counters:
time since reset, timer overruns, calls to transmit.
</p></dd>
-<dt><code>writelist</code> <kbd>associd</kbd></dt>
+<dt><code class="code">writelist</code> <kbd class="kbd">associd</kbd></dt>
<dd><p>Set all system or peer variables included in the variable list.
</p></dd>
-<dt><code>writevar</code> <kbd>associd</kbd> <kbd>name</kbd>=<kbd>value</kbd> <code>[, ...]</code></dt>
+<dt><code class="code">writevar</code> <kbd class="kbd">associd</kbd> <kbd class="kbd">name</kbd>=<kbd class="kbd">value</kbd> <code class="code">[, ...]</code></dt>
<dd><p>Set the specified variables in the variable list.
If the
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is zero, the variables are from the
-<a href="#System-Variables">System Variables</a>
+<a class="ref" href="#System-Variables">System Variables</a>
name space, otherwise they are from the
-<a href="#Peer-Variables">Peer Variables</a>
+<a class="ref" href="#Peer-Variables">Peer Variables</a>
name space.
The
-<kbd>associd</kbd>
+<kbd class="kbd">associd</kbd>
is required, as the same name can occur in both spaces.
Authentication is required.
</p></dd>
</dl>
-<span id="Status-Words-and-Kiss-Codes-1"></span><h4 class="subsubsection">1.1.1.2 Status Words and Kiss Codes</h4>
+</div>
+<div class="subsubsection-level-extent" id="Status-Words-and-Kiss-Codes-1">
+<h4 class="subsubsection"><span>1.1.1.2 Status Words and Kiss Codes<a class="copiable-link" href="#Status-Words-and-Kiss-Codes-1"> ¶</a></span></h4>
<p>The current state of the operating program is shown
in a set of status words
maintained by the system.
Status information is also available on a per-association basis.
These words are displayed by the
-<code>readlist</code>
+<code class="code">readlist</code>
and
-<code>associations</code>
+<code class="code">associations</code>
commands both in hexadecimal and in decoded short tip strings.
The codes, tips and short explanations are documented on the
.Lk decode.html "Event Messages and Status Words"
They are now displayed, when appropriate,
in the reference identifier field in various billboards.
</p>
-<span id="System-Variables-1"></span><h4 class="subsubsection">1.1.1.3 System Variables</h4>
+</div>
+<div class="subsubsection-level-extent" id="System-Variables-1">
+<h4 class="subsubsection"><span>1.1.1.3 System Variables<a class="copiable-link" href="#System-Variables-1"> ¶</a></span></h4>
<p>The following system variables appear in the
-<code>readlist</code>
+<code class="code">readlist</code>
billboard.
Not all variables are displayed in some configurations.
</p>
-<dl compact="compact">
+<dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>status</code></dt>
+<dt><code class="code">status</code></dt>
<dd><p>.Lk decode.html#sys "system status word"
</p></dd>
-<dt><code>version</code></dt>
+<dt><code class="code">version</code></dt>
<dd><p>NTP software version and build time
</p></dd>
-<dt><code>processor</code></dt>
+<dt><code class="code">processor</code></dt>
<dd><p>hardware platform and version
</p></dd>
-<dt><code>system</code></dt>
+<dt><code class="code">system</code></dt>
<dd><p>operating system and version
</p></dd>
-<dt><code>leap</code></dt>
+<dt><code class="code">leap</code></dt>
<dd><p>leap warning indicator (0-3)
</p></dd>
-<dt><code>stratum</code></dt>
+<dt><code class="code">stratum</code></dt>
<dd><p>stratum (1-15)
</p></dd>
-<dt><code>precision</code></dt>
+<dt><code class="code">precision</code></dt>
<dd><p>precision (log2 s)
</p></dd>
-<dt><code>rootdelay</code></dt>
+<dt><code class="code">rootdelay</code></dt>
<dd><p>total roundtrip delay to the primary reference clock
</p></dd>
-<dt><code>rootdisp</code></dt>
+<dt><code class="code">rootdisp</code></dt>
<dd><p>total dispersion to the primary reference clock
</p></dd>
-<dt><code>refid</code></dt>
+<dt><code class="code">refid</code></dt>
<dd><p>reference id or
.Lk decode.html#kiss "kiss code"
</p></dd>
-<dt><code>reftime</code></dt>
+<dt><code class="code">reftime</code></dt>
<dd><p>reference time
</p></dd>
-<dt><code>clock</code></dt>
+<dt><code class="code">clock</code></dt>
<dd><p>date and time of day
</p></dd>
-<dt><code>peer</code></dt>
+<dt><code class="code">peer</code></dt>
<dd><p>system peer association id
</p></dd>
-<dt><code>tc</code></dt>
+<dt><code class="code">tc</code></dt>
<dd><p>time constant and poll exponent (log2 s) (3-17)
</p></dd>
-<dt><code>mintc</code></dt>
+<dt><code class="code">mintc</code></dt>
<dd><p>minimum time constant (log2 s) (3-10)
</p></dd>
-<dt><code>offset</code></dt>
+<dt><code class="code">offset</code></dt>
<dd><p>combined offset of server relative to this host
</p></dd>
-<dt><code>frequency</code></dt>
+<dt><code class="code">frequency</code></dt>
<dd><p>frequency drift (PPM) relative to hardware clock
</p></dd>
-<dt><code>sys_jitter</code></dt>
+<dt><code class="code">sys_jitter</code></dt>
<dd><p>combined system jitter
</p></dd>
-<dt><code>clk_wander</code></dt>
+<dt><code class="code">clk_wander</code></dt>
<dd><p>clock frequency wander (PPM)
</p></dd>
-<dt><code>clk_jitter</code></dt>
+<dt><code class="code">clk_jitter</code></dt>
<dd><p>clock jitter
</p></dd>
-<dt><code>tai</code></dt>
+<dt><code class="code">tai</code></dt>
<dd><p>TAI-UTC offset (s)
</p></dd>
-<dt><code>leapsec</code></dt>
+<dt><code class="code">leapsec</code></dt>
<dd><p>NTP seconds when the next leap second is/was inserted
</p></dd>
-<dt><code>expire</code></dt>
+<dt><code class="code">expire</code></dt>
<dd><p>NTP seconds when the NIST leapseconds file expires
</p></dd>
</dl>
additional system variables are displayed,
including some or all of the following,
depending on the particular Autokey dance:
-</p><dl compact="compact">
+</p><dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>host</code></dt>
+<dt><code class="code">host</code></dt>
<dd><p>Autokey host name for this host
</p></dd>
-<dt><code>ident</code></dt>
+<dt><code class="code">ident</code></dt>
<dd><p>Autokey group name for this host
</p></dd>
-<dt><code>flags</code></dt>
+<dt><code class="code">flags</code></dt>
<dd><p>host flags (see Autokey specification)
</p></dd>
-<dt><code>digest</code></dt>
+<dt><code class="code">digest</code></dt>
<dd><p>OpenSSL message digest algorithm
</p></dd>
-<dt><code>signature</code></dt>
+<dt><code class="code">signature</code></dt>
<dd><p>OpenSSL digest/signature scheme
</p></dd>
-<dt><code>update</code></dt>
+<dt><code class="code">update</code></dt>
<dd><p>NTP seconds at last signature update
</p></dd>
-<dt><code>cert</code></dt>
+<dt><code class="code">cert</code></dt>
<dd><p>certificate subject, issuer and certificate flags
</p></dd>
-<dt><code>until</code></dt>
+<dt><code class="code">until</code></dt>
<dd><p>NTP seconds when the certificate expires
</p></dd>
</dl>
-<span id="Peer-Variables-1"></span><h4 class="subsubsection">1.1.1.4 Peer Variables</h4>
+</div>
+<div class="subsubsection-level-extent" id="Peer-Variables-1">
+<h4 class="subsubsection"><span>1.1.1.4 Peer Variables<a class="copiable-link" href="#Peer-Variables-1"> ¶</a></span></h4>
<p>The following peer variables appear in the
-<code>readlist</code>
+<code class="code">readlist</code>
billboard for each association.
Not all variables are displayed in some configurations.
</p>
-<dl compact="compact">
+<dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>associd</code></dt>
+<dt><code class="code">associd</code></dt>
<dd><p>association id
</p></dd>
-<dt><code>status</code></dt>
+<dt><code class="code">status</code></dt>
<dd><p>.Lk decode.html#peer "peer status word"
</p></dd>
-<dt><code>srcadr</code></dt>
+<dt><code class="code">srcadr</code></dt>
<dd><p>source (remote) IP address
</p></dd>
-<dt><code>srcport</code></dt>
+<dt><code class="code">srcport</code></dt>
<dd><p>source (remote) port
</p></dd>
-<dt><code>dstadr</code></dt>
+<dt><code class="code">dstadr</code></dt>
<dd><p>destination (local) IP address
</p></dd>
-<dt><code>dstport</code></dt>
+<dt><code class="code">dstport</code></dt>
<dd><p>destination (local) port
</p></dd>
-<dt><code>leap</code></dt>
+<dt><code class="code">leap</code></dt>
<dd><p>leap indicator (0-3)
</p></dd>
-<dt><code>stratum</code></dt>
+<dt><code class="code">stratum</code></dt>
<dd><p>stratum (0-15)
</p></dd>
-<dt><code>precision</code></dt>
+<dt><code class="code">precision</code></dt>
<dd><p>precision (log2 s)
</p></dd>
-<dt><code>rootdelay</code></dt>
+<dt><code class="code">rootdelay</code></dt>
<dd><p>total roundtrip delay to the primary reference clock
</p></dd>
-<dt><code>rootdisp</code></dt>
+<dt><code class="code">rootdisp</code></dt>
<dd><p>total root dispersion to the primary reference clock
</p></dd>
-<dt><code>refid</code></dt>
+<dt><code class="code">refid</code></dt>
<dd><p>reference id or
.Lk decode.html#kiss "kiss code"
</p></dd>
-<dt><code>reftime</code></dt>
+<dt><code class="code">reftime</code></dt>
<dd><p>reference time
</p></dd>
-<dt><code>rec</code></dt>
+<dt><code class="code">rec</code></dt>
<dd><p>last packet received time
</p></dd>
-<dt><code>reach</code></dt>
+<dt><code class="code">reach</code></dt>
<dd><p>reach register (octal)
</p></dd>
-<dt><code>unreach</code></dt>
+<dt><code class="code">unreach</code></dt>
<dd><p>unreach counter
</p></dd>
-<dt><code>hmode</code></dt>
+<dt><code class="code">hmode</code></dt>
<dd><p>host mode (1-6)
</p></dd>
-<dt><code>pmode</code></dt>
+<dt><code class="code">pmode</code></dt>
<dd><p>peer mode (1-5)
</p></dd>
-<dt><code>hpoll</code></dt>
+<dt><code class="code">hpoll</code></dt>
<dd><p>host poll exponent (log2 s) (3-17)
</p></dd>
-<dt><code>ppoll</code></dt>
+<dt><code class="code">ppoll</code></dt>
<dd><p>peer poll exponent (log2 s) (3-17)
</p></dd>
-<dt><code>headway</code></dt>
+<dt><code class="code">headway</code></dt>
<dd><p>headway (see
.Lk rate.html "Rate Management and the Kiss-o’-Death Packet" )
</p></dd>
-<dt><code>flash</code></dt>
+<dt><code class="code">flash</code></dt>
<dd><p>.Lk decode.html#flash "flash status word"
</p></dd>
-<dt><code>keyid</code></dt>
+<dt><code class="code">keyid</code></dt>
<dd><p>symmetric key id
</p></dd>
-<dt><code>offset</code></dt>
+<dt><code class="code">offset</code></dt>
<dd><p>filter offset
</p></dd>
-<dt><code>delay</code></dt>
+<dt><code class="code">delay</code></dt>
<dd><p>filter delay
</p></dd>
-<dt><code>dispersion</code></dt>
+<dt><code class="code">dispersion</code></dt>
<dd><p>filter dispersion
</p></dd>
-<dt><code>jitter</code></dt>
+<dt><code class="code">jitter</code></dt>
<dd><p>filter jitter
</p></dd>
-<dt><code>bias</code></dt>
+<dt><code class="code">bias</code></dt>
<dd><p>unicast/broadcast bias
</p></dd>
-<dt><code>xleave</code></dt>
+<dt><code class="code">xleave</code></dt>
<dd><p>interleave delay (see
.Lk xleave.html "NTP Interleaved Modes" )
</p></dd>
</dl>
<p>The
-<code>bias</code>
+<code class="code">bias</code>
variable is calculated when the first broadcast packet is received
after the calibration volley.
It represents the offset of the broadcast subgraph relative to the
unicast subgraph.
The
-<code>xleave</code>
+<code class="code">xleave</code>
variable appears only for the interleaved symmetric and interleaved modes.
It represents the internal queuing, buffering and transmission delays
for the preceding packet.
</p>
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional peer variables are displayed, including the following:
-</p><dl compact="compact">
+</p><dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>flags</code></dt>
+<dt><code class="code">flags</code></dt>
<dd><p>peer flags (see Autokey specification)
</p></dd>
-<dt><code>host</code></dt>
+<dt><code class="code">host</code></dt>
<dd><p>Autokey server name
</p></dd>
-<dt><code>flags</code></dt>
+<dt><code class="code">flags</code></dt>
<dd><p>peer flags (see Autokey specification)
</p></dd>
-<dt><code>signature</code></dt>
+<dt><code class="code">signature</code></dt>
<dd><p>OpenSSL digest/signature scheme
</p></dd>
-<dt><code>initsequence</code></dt>
+<dt><code class="code">initsequence</code></dt>
<dd><p>initial key id
</p></dd>
-<dt><code>initkey</code></dt>
+<dt><code class="code">initkey</code></dt>
<dd><p>initial key index
</p></dd>
-<dt><code>timestamp</code></dt>
+<dt><code class="code">timestamp</code></dt>
<dd><p>Autokey signature timestamp
</p></dd>
-<dt><code>ident</code></dt>
+<dt><code class="code">ident</code></dt>
<dd><p>Autokey group name for this association
</p></dd>
</dl>
-<span id="Clock-Variables-1"></span><h4 class="subsubsection">1.1.1.5 Clock Variables</h4>
+</div>
+<div class="subsubsection-level-extent" id="Clock-Variables-1">
+<h4 class="subsubsection"><span>1.1.1.5 Clock Variables<a class="copiable-link" href="#Clock-Variables-1"> ¶</a></span></h4>
<p>The following clock variables appear in the
-<code>clocklist</code>
+<code class="code">clocklist</code>
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
-</p><dl compact="compact">
+</p><dl class="table">
<dt>Variable</dt>
<dd><p>Description
</p></dd>
-<dt><code>associd</code></dt>
+<dt><code class="code">associd</code></dt>
<dd><p>association id
</p></dd>
-<dt><code>status</code></dt>
+<dt><code class="code">status</code></dt>
<dd><p>.Lk decode.html#clock "clock status word"
</p></dd>
-<dt><code>device</code></dt>
+<dt><code class="code">device</code></dt>
<dd><p>device description
</p></dd>
-<dt><code>timecode</code></dt>
+<dt><code class="code">timecode</code></dt>
<dd><p>ASCII time code string (specific to device)
</p></dd>
-<dt><code>poll</code></dt>
+<dt><code class="code">poll</code></dt>
<dd><p>poll messages sent
</p></dd>
-<dt><code>noreply</code></dt>
+<dt><code class="code">noreply</code></dt>
<dd><p>no reply
</p></dd>
-<dt><code>badformat</code></dt>
+<dt><code class="code">badformat</code></dt>
<dd><p>bad format
</p></dd>
-<dt><code>baddata</code></dt>
+<dt><code class="code">baddata</code></dt>
<dd><p>bad date or time
</p></dd>
-<dt><code>fudgetime1</code></dt>
+<dt><code class="code">fudgetime1</code></dt>
<dd><p>fudge time 1
</p></dd>
-<dt><code>fudgetime2</code></dt>
+<dt><code class="code">fudgetime2</code></dt>
<dd><p>fudge time 2
</p></dd>
-<dt><code>stratum</code></dt>
+<dt><code class="code">stratum</code></dt>
<dd><p>driver stratum
</p></dd>
-<dt><code>refid</code></dt>
+<dt><code class="code">refid</code></dt>
<dd><p>driver reference id
</p></dd>
-<dt><code>flags</code></dt>
+<dt><code class="code">flags</code></dt>
<dd><p>driver flags
</p></dd>
</dl>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpq</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntpq</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<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>)
-</td></tr>
-<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)
-</td></tr>
-<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)
-</td></tr>
-<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)
-</td></tr>
-<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)
-</td></tr>
-<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)
-</td></tr>
-<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
-</td></tr>
-<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)
-</td></tr>
-<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)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-unconnected">ntpq unconnected</a></td><td> </td><td align="left" valign="top">unconnected option (-u)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-wide">ntpq wide</a></td><td> </td><td align="left" valign="top">wide option (-w)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpq-config">ntpq config</a></td><td> </td><td align="left" valign="top">presetting/configuring ntpq
-</td></tr>
-<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
-</td></tr>
-</table>
<hr>
-<span id="ntpq-usage"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="ntpq-usage">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-ipv4" accesskey="n" rel="next">ipv4 option (-4)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="ntpq-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1.2 ntpq help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntpq-help"></span>
+<h4 class="subsection" id="ntpq-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1.2 ntpq help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntpq-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq-help"></a>
<p>This is the automatically generated usage text for ntpq.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntpq - standard NTP query program - Ver. 4.2.8p17
+<pre class="example-preformatted">ntpq - standard NTP query program - Ver. 4.2.8p17
Usage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
Flg Arg Option-Name Description
-4 no ipv4 Force IPv4 name resolution
</pre></div>
<hr>
-<span id="ntpq-ipv4"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-ipv4">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-ipv6" accesskey="n" rel="next">ipv6 option (-6)</a>, Previous: <a href="#ntpq-usage" accesskey="p" rel="prev">ntpq help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.1.3 ipv4 option (-4)</h4>
-<span id="index-ntpq_002dipv4"></span>
+<h4 class="subsection" id="ipv4-option-_0028_002d4_0029"><span>1.1.3 ipv4 option (-4)<a class="copiable-link" href="#ipv4-option-_0028_002d4_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dipv4"></a>
<p>This is the “force ipv4 name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv6.
</li></ul>
<p>Force resolution of following host names on the command line
to the IPv4 namespace.
</p><hr>
-<span id="ntpq-ipv6"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-ipv6">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-command" accesskey="n" rel="next">command option (-c)</a>, Previous: <a href="#ntpq-ipv4" accesskey="p" rel="prev">ipv4 option (-4)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="ipv6-option-_0028_002d6_0029"></span><h4 class="subsection">1.1.4 ipv6 option (-6)</h4>
-<span id="index-ntpq_002dipv6"></span>
+<h4 class="subsection" id="ipv6-option-_0028_002d6_0029"><span>1.1.4 ipv6 option (-6)<a class="copiable-link" href="#ipv6-option-_0028_002d6_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dipv6"></a>
<p>This is the “force ipv6 name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv4.
</li></ul>
<p>Force resolution of following host names on the command line
to the IPv6 namespace.
</p><hr>
-<span id="ntpq-command"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-command">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-interactive" accesskey="n" rel="next">interactive option (-i)</a>, Previous: <a href="#ntpq-ipv6" accesskey="p" rel="prev">ipv6 option (-6)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="command-option-_0028_002dc_0029"></span><h4 class="subsection">1.1.5 command option (-c)</h4>
-<span id="index-ntpq_002dcommand"></span>
+<h4 class="subsection" id="command-option-_0028_002dc_0029"><span>1.1.5 command option (-c)<a class="copiable-link" href="#command-option-_0028_002dc_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dcommand"></a>
<p>This is the “run a command and exit” option.
-This option takes a string argument <samp>cmd</samp>.
+This option takes a string argument <samp class="file">cmd</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>The following argument is interpreted as an interactive format command
and is added to the list of commands to be executed on the specified
host(s).
</p><hr>
-<span id="ntpq-interactive"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-interactive">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-numeric" accesskey="n" rel="next">numeric option (-n)</a>, Previous: <a href="#ntpq-command" accesskey="p" rel="prev">command option (-c)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="interactive-option-_0028_002di_0029"></span><h4 class="subsection">1.1.6 interactive option (-i)</h4>
-<span id="index-ntpq_002dinteractive"></span>
+<h4 class="subsection" id="interactive-option-_0028_002di_0029"><span>1.1.6 interactive option (-i)<a class="copiable-link" href="#interactive-option-_0028_002di_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dinteractive"></a>
<p>This is the “force ntpq to operate in interactive mode” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
command, peers.
</li></ul>
-<p>Force <code>ntpq</code> to operate in interactive mode.
+<p>Force <code class="code">ntpq</code> to operate in interactive mode.
Prompts will be written to the standard output and
commands read from the standard input.
</p><hr>
-<span id="ntpq-numeric"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-numeric">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-old_002drv" accesskey="n" rel="next">old-rv option</a>, Previous: <a href="#ntpq-interactive" accesskey="p" rel="prev">interactive option (-i)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="numeric-option-_0028_002dn_0029"></span><h4 class="subsection">1.1.7 numeric option (-n)</h4>
-<span id="index-ntpq_002dnumeric"></span>
+<h4 class="subsection" id="numeric-option-_0028_002dn_0029"><span>1.1.7 numeric option (-n)<a class="copiable-link" href="#numeric-option-_0028_002dn_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dnumeric"></a>
<p>This is the “numeric host addresses” option.
Output all host addresses in dotted-quad numeric format rather than
converting to the canonical host names.
</p><hr>
-<span id="ntpq-old_002drv"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-old_002drv">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-peers" accesskey="n" rel="next">peers option (-p)</a>, Previous: <a href="#ntpq-numeric" accesskey="p" rel="prev">numeric option (-n)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="old_002drv-option"></span><h4 class="subsection">1.1.8 old-rv option</h4>
-<span id="index-ntpq_002dold_002drv"></span>
+<h4 class="subsection" id="old_002drv-option"><span>1.1.8 old-rv option<a class="copiable-link" href="#old_002drv-option"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dold_002drv"></a>
<p>This is the “always output status line with readvar” option.
-By default, <code>ntpq</code> now suppresses the <code>associd=...</code>
-line that precedes the output of <code>readvar</code>
-(alias <code>rv</code>) when a single variable is requested, such as
-<code>ntpq -c "rv 0 offset"</code>.
-This option causes <code>ntpq</code> to include both lines of output
-for a single-variable <code>readvar</code>.
+By default, <code class="code">ntpq</code> now suppresses the <code class="code">associd=...</code>
+line that precedes the output of <code class="code">readvar</code>
+(alias <code class="code">rv</code>) when a single variable is requested, such as
+<code class="code">ntpq -c "rv 0 offset"</code>.
+This option causes <code class="code">ntpq</code> to include both lines of output
+for a single-variable <code class="code">readvar</code>.
Using an environment variable to
preset this option in a script will enable both older and
-newer <code>ntpq</code> to behave identically in this regard.
+newer <code class="code">ntpq</code> to behave identically in this regard.
</p><hr>
-<span id="ntpq-peers"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-peers">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-refid" accesskey="n" rel="next">refid option (-r)</a>, Previous: <a href="#ntpq-old_002drv" accesskey="p" rel="prev">old-rv option</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.1.9 peers option (-p)</h4>
-<span id="index-ntpq_002dpeers"></span>
+<h4 class="subsection" id="peers-option-_0028_002dp_0029"><span>1.1.9 peers option (-p)<a class="copiable-link" href="#peers-option-_0028_002dp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dpeers"></a>
<p>This is the “print a list of the peers” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
interactive.
</li></ul>
<p>Print a list of the peers known to the server as well as a summary
of their state. This is equivalent to the ’peers’ interactive command.
</p><hr>
-<span id="ntpq-refid"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-refid">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-unconnected" accesskey="n" rel="next">unconnected option (-u)</a>, Previous: <a href="#ntpq-peers" accesskey="p" rel="prev">peers option (-p)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="refid-option-_0028_002dr_0029"></span><h4 class="subsection">1.1.10 refid option (-r)</h4>
-<span id="index-ntpq_002drefid"></span>
+<h4 class="subsection" id="refid-option-_0028_002dr_0029"><span>1.1.10 refid option (-r)<a class="copiable-link" href="#refid-option-_0028_002dr_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002drefid"></a>
<p>This is the “set default display type for s2+ refids” option.
This option takes a keyword argument.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> This option takes a keyword as its argument.
+</p><ul class="itemize mark-bullet">
+<li>This option takes a keyword as its argument.
The argument sets an enumeration value that can be tested by comparing the option value macro (OPT_VALUE_REFID).
The available keywords are:
<div class="example">
-<pre class="example"> hash ipv4
+<pre class="example-preformatted"> hash ipv4
</pre></div>
<p>or their numeric equivalent.
<p>Set the default display format for S2+ refids.
</p><hr>
-<span id="ntpq-unconnected"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-unconnected">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-wide" accesskey="n" rel="next">wide option (-w)</a>, Previous: <a href="#ntpq-refid" accesskey="p" rel="prev">refid option (-r)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="unconnected-option-_0028_002du_0029"></span><h4 class="subsection">1.1.11 unconnected option (-u)</h4>
-<span id="index-ntpq_002dunconnected"></span>
+<h4 class="subsection" id="unconnected-option-_0028_002du_0029"><span>1.1.11 unconnected option (-u)<a class="copiable-link" href="#unconnected-option-_0028_002du_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dunconnected"></a>
<p>This is the “use unconnected udp to communicate with ntpd (default on windows)” option.
Open an unconnected UDP association to ntpd (the default
on Windows).
</p><hr>
-<span id="ntpq-wide"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-wide">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-config" accesskey="n" rel="next">presetting/configuring ntpq</a>, Previous: <a href="#ntpq-unconnected" accesskey="p" rel="prev">unconnected option (-u)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="wide-option-_0028_002dw_0029"></span><h4 class="subsection">1.1.12 wide option (-w)</h4>
-<span id="index-ntpq_002dwide"></span>
+<h4 class="subsection" id="wide-option-_0028_002dw_0029"><span>1.1.12 wide option (-w)<a class="copiable-link" href="#wide-option-_0028_002dw_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntpq_002dwide"></a>
<p>This is the “display the full ’remote’ value” option.
Display the full value of the ’remote’ value. If this requires
</p>
<hr>
-<span id="ntpq-config"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-config">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#ntpq-exit-status" accesskey="n" rel="next">ntpq exit status</a>, Previous: <a href="#ntpq-wide" accesskey="p" rel="prev">wide option (-w)</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="presetting_002fconfiguring-ntpq"></span><h4 class="subsection">1.1.13 presetting/configuring ntpq</h4>
+<h4 class="subsection" id="presetting_002fconfiguring-ntpq"><span>1.1.13 presetting/configuring ntpq<a class="copiable-link" href="#presetting_002fconfiguring-ntpq"> ¶</a></span></h4>
-<p>Any option that is not marked as <i>not presettable</i> may be preset by
-loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTPQ</code> and <code>NTPQ_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
+<p>Any option that is not marked as <i class="i">not presettable</i> may be preset by
+loading values from configuration ("rc" or "ini") files, and values from environment variables named <code class="code">NTPQ</code> and <code class="code">NTPQ_<OPTION_NAME></code>. <code class="code"><OPTION_NAME></code> must be one of
the options listed above in upper case and segmented with underscores.
-The <code>NTPQ</code> variable will be tokenized and parsed like
+The <code class="code">NTPQ</code> variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
</p>
-<p><code>libopts</code> will search in 2 places for configuration files:
-</p><ul>
-<li> $HOME
-</li><li> $PWD
+<p><code class="code">libopts</code> will search in 2 places for configuration files:
+</p><ul class="itemize mark-bullet">
+<li>$HOME
+</li><li>$PWD
</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>ntpq</samp> runs.
+<p>The environment variables <code class="code">HOME</code>, and <code class="code">PWD</code>
+are expanded and replaced when <samp class="file">ntpq</samp> runs.
For any of these that are plain files, they are simply processed.
-For any that are directories, then a file named <samp>.ntprc</samp> is searched for
+For any that are directories, then a file named <samp class="file">.ntprc</samp> is searched for
within that directory and processed.
</p>
<p>Configuration files may be in a wide variety of formats.
Common options are collected at the top, followed by program specific
segments. The segments are separated by lines like:
</p><div class="example">
-<pre class="example">[NTPQ]
+<pre class="example-preformatted">[NTPQ]
</pre></div>
<p>or by
</p><div class="example">
-<pre class="example"><?program ntpq>
+<pre class="example-preformatted"><?program ntpq>
</pre></div>
<p>Do not mix these styles within one configuration file.
</p>
<p>Compound values and carefully constructed string values may also be
specified using XML syntax:
</p><div class="example">
-<pre class="example"><option-name>
+<pre class="example-preformatted"><option-name>
<sub-opt>...&lt;...&gt;...</sub-opt>
</option-name>
</pre></div>
-<p>yielding an <code>option-name.sub-opt</code> string value of
+<p>yielding an <code class="code">option-name.sub-opt</code> string value of
</p><div class="example">
-<pre class="example">"...<...>..."
+<pre class="example-preformatted">"...<...>..."
</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
-hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching
+<p><code class="code">AutoOpts</code> does not track suboptions. You simply note that it is a
+hierarchicly valued option. <code class="code">AutoOpts</code> does provide a means for searching
the associated name/value pair list (see: optionFindValue).
</p>
<p>The command line options relating to configuration and/or usage help are:
</p>
-<span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
+<h4 class="subsubheading" id="version-_0028_002d_0029"><span>version (-)<a class="copiable-link" href="#version-_0028_002d_0029"> ¶</a></span></h4>
<p>Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing information may be selected with an option argument.
Only the first letter of the argument is examined:
</p>
-<dl compact="compact">
-<dt>‘<samp>version</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">version</samp>’</dt>
<dd><p>Only print the version. This is the default.
</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
+<dt>‘<samp class="samp">copyright</samp>’</dt>
<dd><p>Name the copyright usage licensing terms.
</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>Print the full copyright usage licensing terms.
</p></dd>
</dl>
<hr>
-<span id="ntpq-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntpq-exit-status">
+<div class="nav-panel">
<p>
-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>
+Previous: <a href="#ntpq-config" accesskey="p" rel="prev">presetting/configuring ntpq</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">Invoking ntpq</a> </p>
</div>
-<span id="ntpq-exit-status-1"></span><h4 class="subsection">1.1.14 ntpq exit status</h4>
+<h4 class="subsection" id="ntpq-exit-status-1"><span>1.1.14 ntpq exit status<a class="copiable-link" href="#ntpq-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
-<dt>‘<samp>66 (EX_NOINPUT)</samp>’</dt>
+<dt>‘<samp class="samp">66 (EX_NOINPUT)</samp>’</dt>
<dd><p>A specified configuration file could not be loaded.
</p></dd>
-<dt>‘<samp>70 (EX_SOFTWARE)</samp>’</dt>
+<dt>‘<samp class="samp">70 (EX_SOFTWARE)</samp>’</dt>
<dd><p>libopts had an internal operational error. Please report
it to autogen-users@lists.sourceforge.net. Thank you.
</p></dd>
</dl>
<hr>
-<span id="Usage"></span><div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Usage">
+<div class="nav-panel">
<p>
-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>
+Next: <a href="#Internal-Commands" accesskey="n" rel="next">Internal Commands</a>, Previous: <a href="#ntpq-Description" accesskey="p" rel="prev">Description</a>, Up: <a href="#Top" accesskey="u" rel="up">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Usage-1"></span><h3 class="section">1.2 Usage</h3>
+<h3 class="section" id="Usage-1"><span>1.2 Usage<a class="copiable-link" href="#Usage-1"> ¶</a></span></h3>
-<table>
+<table class="multitable">
<thead><tr><th width="23%">What</th><th width="23%">Default</th><th width="5%">Flag</th><th width="15%">Option</th></tr></thead>
-<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>
-<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>
-<tr><td width="23%">leapseconds file</td><td width="23%">none</td><td width="5%"></td><td width="15%"><code>leapfile</code></td></tr>
-<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>
-<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>
-<tr><td width="23%">include file</td><td width="23%">none</td><td width="5%">none</td><td width="15%"><code>includefile</code></td></tr>
-<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>
-<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>
+<tbody><tr><td width="23%">configuration file</td><td width="23%"><code class="code">/etc/ntp.conf</code></td><td width="5%"><code class="code">-c</code></td><td width="15%"><code class="code">conffile</code></td></tr>
+<tr><td width="23%">frequency file</td><td width="23%">none</td><td width="5%"><code class="code">-f</code></td><td width="15%"><code class="code">driftfile</code></td></tr>
+<tr><td width="23%">leapseconds file</td><td width="23%">none</td><td width="5%"></td><td width="15%"><code class="code">leapfile</code></td></tr>
+<tr><td width="23%">process ID file</td><td width="23%">none</td><td width="5%"><code class="code">-p</code></td><td width="15%"><code class="code">pidfile</code></td></tr>
+<tr><td width="23%">log file</td><td width="23%">system log</td><td width="5%"><code class="code">-l</code></td><td width="15%"><code class="code">logfile</code></td></tr>
+<tr><td width="23%">include file</td><td width="23%">none</td><td width="5%">none</td><td width="15%"><code class="code">includefile</code></td></tr>
+<tr><td width="23%">statistics path</td><td width="23%"><code class="code">/var/NTP</code></td><td width="5%"><code class="code">-s</code></td><td width="15%"><code class="code">statsdir</code></td></tr>
+<tr><td width="23%">keys path</td><td width="23%"><code class="code">/usr/local/etc</code></td><td width="5%"><code class="code">-k</code></td><td width="15%"><code class="code">keysdir</code></td></tr>
+</tbody>
</table>
<hr>
-<span id="Internal-Commands"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Internal-Commands">
+<div class="nav-panel">
<p>
-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>
+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">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Internal-Commands-2"></span><h3 class="section">1.3 Internal Commands</h3>
+<h3 class="section" id="Internal-Commands-2"><span>1.3 Internal Commands<a class="copiable-link" href="#Internal-Commands-2"> ¶</a></span></h3>
-<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.
+<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 class="code">></code>, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the <code class="code">ntpq</code> program itself and do not result in NTP mode-6 requests being sent to a server. These are described following.
</p>
-<dl compact="compact">
-<dt><code><span id="help"></span><code>? [</code><kbd>command_keyword</kbd><code>]</code></code></dt>
-<dt><code><code>help [</code><kbd>command_keyword</kbd><code>]</code></code></dt>
-<dd><p>A <code>?</code> by itself will print a list of all the command keywords known to <code>ntpq</code>. A <code>?</code> followed by a command keyword will print function and usage information about the command.
+<dl class="table">
+<dt><code class="code"><a class="anchor" id="help"></a><code class="code">? [</code><kbd class="kbd">command_keyword</kbd><code class="code">]</code></code></dt>
+<dt><code class="code"><code class="code">help [</code><kbd class="kbd">command_keyword</kbd><code class="code">]</code></code></dt>
+<dd><p>A <code class="code">?</code> by itself will print a list of all the command keywords known to <code class="code">ntpq</code>. A <code class="code">?</code> followed by a command keyword will print function and usage information about the command.
</p>
</dd>
-<dt><code><span id="addvars"></span>><code>addvars <kbd>name</kbd> [ = <kbd>value</kbd>] [...]</code></code></dt>
-<dt><code><code>rmvars <kbd>name</kbd> [...]</code></code></dt>
-<dt><code><code>clearvars</code></dt></code></dt>
+<dt><code class="code"><a class="anchor" id="addvars"></a>><code class="code">addvars <kbd class="kbd">name</kbd> [ = <kbd class="kbd">value</kbd>] [...]</code></code></dt>
+<dt><code class="code"><code class="code">rmvars <kbd class="kbd">name</kbd> [...]</code></code></dt>
+<dt><code class="code"><code class="code">clearvars</code></dt></code></dt>
<dd><p>The arguments to these commands consist of a list of items of the form
-<code><kbd>name</kbd> = <kbd>value</kbd></code>, where the <code>= <kbd>value</kbd></code> is ignored,
+<code class="code"><kbd class="kbd">name</kbd> = <kbd class="kbd">value</kbd></code>, where the <code class="code">= <kbd class="kbd">value</kbd></code> is ignored,
and can be omitted in read requests.
-<code>ntpq</code> maintains an internal list in which data to be included
-in control messages can be assembled, and sent using the <code>readlist</code>
-and <code>writelist</code> commands described below.
-The <code>addvars</code> command allows variables and optional values
+<code class="code">ntpq</code> maintains an internal list in which data to be included
+in control messages can be assembled, and sent using the <code class="code">readlist</code>
+and <code class="code">writelist</code> commands described below.
+The <code class="code">addvars</code> command allows variables and optional values
to be added to the list.
If more than one variable is to be added
the list should be comma-separated and not contain white space.
-The <code>rmvars</code> command can be used to remove individual variables
+The <code class="code">rmvars</code> command can be used to remove individual variables
from the list,
-while the <code>clearlist</code> command removes all variables from the list.
+while the <code class="code">clearlist</code> command removes all variables from the list.
</p>
</dd>
-<dt><code><span id="cooked"></span><code>cooked</code></code></dt>
+<dt><code class="code"><a class="anchor" id="cooked"></a><code class="code">cooked</code></code></dt>
<dd><p>Display server messages in prettyprint format.
</p>
</dd>
-<dt><code><span id="debug"></span><code>debug more | less | off</code></code></dt>
+<dt><code class="code"><a class="anchor" id="debug"></a><code class="code">debug more | less | off</code></code></dt>
<dd><p>Turns internal query program debugging on and off.
</p>
</dd>
-<dt><code><span id="delay"></span><code>delay <kbd>milliseconds</kbd></code></code></dt>
+<dt><code class="code"><a class="anchor" id="delay"></a><code class="code">delay <kbd class="kbd">milliseconds</kbd></code></code></dt>
<dd><p>Specify a time interval to be added to timestamps included in requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, so this command may be obsolete.
</p>
</dd>
-<dt><code><span id="host"></span><code>host <kbd>name</kbd></code></code></dt>
+<dt><code class="code"><a class="anchor" id="host"></a><code class="code">host <kbd class="kbd">name</kbd></code></code></dt>
<dd><p>Set the host to which future queries will be sent.
The name may be either a DNS name or a numeric address.
</p>
</dd>
-<dt><code><span id="hostnames"></span><code>hostnames [yes | no]</code></code></dt>
-<dd><p>If <code>yes</code> is specified, host names are printed in information displays.
-If <code>no</code> is specified, numeric addresses are printed instead.
-The default is <code>yes</code>,
-unless modified using the command line <code>-n</code> switch.
+<dt><code class="code"><a class="anchor" id="hostnames"></a><code class="code">hostnames [yes | no]</code></code></dt>
+<dd><p>If <code class="code">yes</code> is specified, host names are printed in information displays.
+If <code class="code">no</code> is specified, numeric addresses are printed instead.
+The default is <code class="code">yes</code>,
+unless modified using the command line <code class="code">-n</code> switch.
</p>
</dd>
-<dt><code><span id="keyid"></span><code>keyid <kbd>keyid</kbd></code></code></dt>
+<dt><code class="code"><a class="anchor" id="keyid"></a><code class="code">keyid <kbd class="kbd">keyid</kbd></code></code></dt>
<dd><p>This command specifies the key number to be used
to authenticate configuration requests.
-This must correspond to a key ID configured in <code>ntp.conf</code> for this purpose.
+This must correspond to a key ID configured in <code class="code">ntp.conf</code> for this purpose.
</p>
</dd>
-<dt><code><span id="keytype"></span><code>keytype</code></code></dt>
+<dt><code class="code"><a class="anchor" id="keytype"></a><code class="code">keytype</code></code></dt>
<dd><p>Specify the digest algorithm to use for authenticated requests,
-with default <code>MD5</code>.
+with default <code class="code">MD5</code>.
If the OpenSSL library is installed,
digest can be be any message digest algorithm supported by the library.
-The current selections are: <code>AES128CMAC</code>, <code>MD2</code>, <code>MD4</code>, <code>MD5</code>, <code>MDC2</code>, <code>RIPEMD160</code>, <code>SHA</code> and <code>SHA1</code>.
+The current selections are: <code class="code">AES128CMAC</code>, <code class="code">MD2</code>, <code class="code">MD4</code>, <code class="code">MD5</code>, <code class="code">MDC2</code>, <code class="code">RIPEMD160</code>, <code class="code">SHA</code> and <code class="code">SHA1</code>.
</p>
</dd>
-<dt><code><span id="ntpversion"></span><code>ntpversion 1 | 2 | 3 | 4</code></code></dt>
-<dd><p>Sets the NTP version number which <code>ntpq</code> claims in packets.
+<dt><code class="code"><a class="anchor" id="ntpversion"></a><code class="code">ntpversion 1 | 2 | 3 | 4</code></code></dt>
+<dd><p>Sets the NTP version number which <code class="code">ntpq</code> claims in packets.
Defaults to 2.
Note that mode-6 control messages (and modes, for that matter)
didn’t exist in NTP version 1.
</p>
</dd>
-<dt><code><span id="passwd"></span><code>passwd</code></code></dt>
+<dt><code class="code"><a class="anchor" id="passwd"></a><code class="code">passwd</code></code></dt>
<dd><p>This command prompts for a password to authenticate requests.
-The password must correspond to the key ID configured in <code>ntp.conf</code> for this purpose.
+The password must correspond to the key ID configured in <code class="code">ntp.conf</code> for this purpose.
</p>
</dd>
-<dt><code><span id="quit"></span><code>quit</code></code></dt>
-<dd><p>Exit <code>ntpq</code>.
+<dt><code class="code"><a class="anchor" id="quit"></a><code class="code">quit</code></code></dt>
+<dd><p>Exit <code class="code">ntpq</code>.
</p>
</dd>
-<dt><code><span id="raw"></span><code>raw</code></code></dt>
+<dt><code class="code"><a class="anchor" id="raw"></a><code class="code">raw</code></code></dt>
<dd><p>Display server messages as received and without reformatting.
</p>
</dd>
-<dt><code><span id="timeout"></span><code>timeout <kbd>milliseconds</kbd></code></code></dt>
+<dt><code class="code"><a class="anchor" id="timeout"></a><code class="code">timeout <kbd class="kbd">milliseconds</kbd></code></code></dt>
<dd><p>Specify a timeout period for responses to server queries.
The default is about 5000 milliseconds.
-Note that since <code>ntpq</code> retries each query once after a timeout
+Note that since <code class="code">ntpq</code> retries each query once after a timeout
the total waiting time for a timeout will be twice the timeout value set.
</p>
</dd>
</dl>
<hr>
-<span id="Control-Message-Commands"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Control-Message-Commands">
+<div class="nav-panel">
<p>
-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>
+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">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Control-Message-Commands-2"></span><h3 class="section">1.4 Control Message Commands</h3>
+<h3 class="section" id="Control-Message-Commands-2"><span>1.4 Control Message Commands<a class="copiable-link" href="#Control-Message-Commands-2"> ¶</a></span></h3>
<p>Association IDs are used to identify system, peer and clock variables.
System variables are assigned an association ID of zero and system name space,
while each association is assigned a nonzero association ID and peer namespace.
Most control commands send a single mode-6 message to the server
and expect a single response message.
-The exceptions are the <code>peers</code> command,
+The exceptions are the <code class="code">peers</code> command,
which sends a series of messages,
-and the <code>mreadlist</code> and <code>mreadvar</code> commands,
+and the <code class="code">mreadlist</code> and <code class="code">mreadvar</code> commands,
which iterate over a range of associations.
</p>
-<span id="as"></span><dl compact="compact">
-<dt><code><code>associations</code></code></dt>
+<a class="anchor" id="as"></a><dl class="table">
+<dt><code class="code"><code class="code">associations</code></code></dt>
<dd><p>Display a list of mobilized associations in the form:
<br>
-<code>ind assid status conf reach auth condition last_event cnt</code>
+<code class="code">ind assid status conf reach auth condition last_event cnt</code>
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="40%">Description</th></tr></thead>
-<tr><td width="10%"><code>ind</code></td><td width="40%">index on this list</td></tr>
-<tr><td width="10%"><code>assid</code></td><td width="40%">association ID</td></tr>
-<tr><td width="10%"><code>status</code></td><td width="40%"><a href="decode.html#peer">peer status word</a></td></tr>
-<tr><td width="10%"><code>conf</code></td><td width="40%"><code>yes</code>: persistent, <code>no</code>: ephemeral</td></tr>
-<tr><td width="10%"><code>reach</code></td><td width="40%"><code>yes</code>: reachable, <code>no</code>: unreachable</td></tr>
-<tr><td width="10%"><code>auth</code></td><td width="40%"><code>ok</code>, <code>yes</code>, <code>bad</code> and <code>none</code></td></tr>
-<tr><td width="10%"><code>condition</code></td><td width="40%">selection status (see the <code>select</code> field of the <a href="decode.html#peer">peer status word</a>)</td></tr>
-<tr><td width="10%"><code>last_event</code></td><td width="40%">event report (see the <code>event</code> field of the <a href="decode.html#peer">peer status word</a>)</td></tr>
-<tr><td width="10%"><code>cnt</code>
-event count (see the <code>count</code> field of the <a href="decode.html#peer">peer status word</a>)</td></tr>
+<tbody><tr><td width="10%"><code class="code">ind</code></td><td width="40%">index on this list</td></tr>
+<tr><td width="10%"><code class="code">assid</code></td><td width="40%">association ID</td></tr>
+<tr><td width="10%"><code class="code">status</code></td><td width="40%"><a class="url" href="decode.html#peer">peer status word</a></td></tr>
+<tr><td width="10%"><code class="code">conf</code></td><td width="40%"><code class="code">yes</code>: persistent, <code class="code">no</code>: ephemeral</td></tr>
+<tr><td width="10%"><code class="code">reach</code></td><td width="40%"><code class="code">yes</code>: reachable, <code class="code">no</code>: unreachable</td></tr>
+<tr><td width="10%"><code class="code">auth</code></td><td width="40%"><code class="code">ok</code>, <code class="code">yes</code>, <code class="code">bad</code> and <code class="code">none</code></td></tr>
+<tr><td width="10%"><code class="code">condition</code></td><td width="40%">selection status (see the <code class="code">select</code> field of the <a class="url" href="decode.html#peer">peer status word</a>)</td></tr>
+<tr><td width="10%"><code class="code">last_event</code></td><td width="40%">event report (see the <code class="code">event</code> field of the <a class="url" href="decode.html#peer">peer status word</a>)</td></tr>
+<tr><td width="10%"><code class="code">cnt</code>
+event count (see the <code class="code">count</code> field of the <a class="url" href="decode.html#peer">peer status word</a>)</td></tr>
+</tbody>
</table>
</dd>
-<dt><code><span id="cv"></span>clockvar <kbd>assocID</kbd> [<kbd>name</kbd> [ = <kbd>value</kbd> [...]] [...]]</code></dt>
-<dt><code>cv <kbd>assocID</kbd> [<kbd>name</kbd> [ = <kbd>value</kbd> [...] ][...]]</code></dt>
+<dt><code class="code"><a class="anchor" id="cv"></a>clockvar <kbd class="kbd">assocID</kbd> [<kbd class="kbd">name</kbd> [ = <kbd class="kbd">value</kbd> [...]] [...]]</code></dt>
+<dt><code class="code">cv <kbd class="kbd">assocID</kbd> [<kbd class="kbd">name</kbd> [ = <kbd class="kbd">value</kbd> [...] ][...]]</code></dt>
<dd><p>Display a list of ‘clock variables’ for those associations supporting a reference clock.
</p>
</dd>
-<dt><code><span id="g_t_003aconfig"></span>:config [...]</code></dt>
+<dt><code class="code"><a class="anchor" id="g_t_003aconfig"></a>:config [...]</code></dt>
<dd><p>Send the remainder of the command line, including whitespace, to the server
as a run-time configuration command in the same format
as the configuration file.
Authentication is of course required.
</p>
</dd>
-<dt><code><span id="config_002dfrom_002dfile"></span>config-from-file <kbd>filename</kbd></code></dt>
-<dd><p>Send the each line of <kbd>filename</kbd> to the server as
+<dt><code class="code"><a class="anchor" id="config_002dfrom_002dfile"></a>config-from-file <kbd class="kbd">filename</kbd></code></dt>
+<dd><p>Send the each line of <kbd class="kbd">filename</kbd> to the server as
run-time configuration commands in the same format as the configuration file.
This command is experimental until further notice and clarification.
Authentication is required.
</p>
</dd>
-<dt><code><span id="ifstats"></span>ifstats</code></dt>
+<dt><code class="code"><a class="anchor" id="ifstats"></a>ifstats</code></dt>
<dd><p>Display statistics for each local network address.
Authentication is required.
</p>
</dd>
-<dt><code><span id="iostats"></span>iostats</code></dt>
+<dt><code class="code"><a class="anchor" id="iostats"></a>iostats</code></dt>
<dd><p>Display network and reference clock I/O statistics.
</p>
</dd>
-<dt><code><span id="kerninfo"></span>kerninfo</code></dt>
+<dt><code class="code"><a class="anchor" id="kerninfo"></a>kerninfo</code></dt>
<dd><p>Display kernel loop and PPS statistics.
As with other ntpq output, times are in milliseconds.
The precision value displayed is in milliseconds as well,
unlike the precision system variable.
</p>
</dd>
-<dt><code><span id="lassoc"></span>lassociations</code></dt>
+<dt><code class="code"><a class="anchor" id="lassoc"></a>lassociations</code></dt>
<dd><p>Perform the same function as the associations command,
except display mobilized and unmobilized associations.
</p>
</dd>
-<dt><code><span id="monstats"></span>monstats</code></dt>
+<dt><code class="code"><a class="anchor" id="monstats"></a>monstats</code></dt>
<dd><p>Display monitor facility statistics.
</p>
</dd>
-<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>
+<dt><code class="code"><a class="anchor" id="mrulist"></a>mrulist [limited | kod | mincount=<kbd class="kbd">count</kbd> | laddr=<kbd class="kbd">localaddr</kbd> | sort=<kbd class="kbd">sortorder</kbd> | resany=<kbd class="kbd">hexmask</kbd> | resall=<kbd class="kbd">hexmask</kbd>]</code></dt>
<dd><p>Obtain and print traffic counts collected and maintained by
the monitor facility.
-With the exception of <code>sort=<kbd>sortorder</kbd></code>,
-the options filter the list returned by <code>ntpd</code>.
-The <code>limited</code> and <code>kod</code> options return only entries
+With the exception of <code class="code">sort=<kbd class="kbd">sortorder</kbd></code>,
+the options filter the list returned by <code class="code">ntpd</code>.
+The <code class="code">limited</code> and <code class="code">kod</code> options return only entries
representing client addresses from which the last packet received
triggered either discarding or a KoD response.
-The <code>mincount=<kbd>count</kbd></code> option filters entries representing
-less than <code><kbd>count</kbd></code> packets.
-The <code>laddr=<kbd>localaddr</kbd></code> option filters entries for packets
-received on any local address other than <code><kbd>localaddr</kbd></code>.
-<code>resany=<kbd>hexmask</kbd></code> and <code>resall=<kbd>hexmask</kbd></code>
+The <code class="code">mincount=<kbd class="kbd">count</kbd></code> option filters entries representing
+less than <code class="code"><kbd class="kbd">count</kbd></code> packets.
+The <code class="code">laddr=<kbd class="kbd">localaddr</kbd></code> option filters entries for packets
+received on any local address other than <code class="code"><kbd class="kbd">localaddr</kbd></code>.
+<code class="code">resany=<kbd class="kbd">hexmask</kbd></code> and <code class="code">resall=<kbd class="kbd">hexmask</kbd></code>
filter entries containing none or less than all, respectively,
-of the bits in <code><kbd>hexmask</kbd></code>, which must begin with <code>0x</code>.
+of the bits in <code class="code"><kbd class="kbd">hexmask</kbd></code>, which must begin with <code class="code">0x</code>.
<br>
-The <code><kbd>sortorder</kbd></code> defaults to <code>lstint</code> and may be any of
-<code>addr</code>, <code>count</code>, <code>avgint</code>, <code>lstint</code>, or
+The <code class="code"><kbd class="kbd">sortorder</kbd></code> defaults to <code class="code">lstint</code> and may be any of
+<code class="code">addr</code>, <code class="code">count</code>, <code class="code">avgint</code>, <code class="code">lstint</code>, or
any of those preceded by a minus sign (hyphen) to reverse the sort order.
The output columns are:
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Column</th><th width="40%">Description</th></tr></thead>
-<tr><td width="10%"><code>lstint</code></td><td width="40%">Interval in s between the receipt of the most recent packet from this
-address and the completion of the retrieval of the MRU list by <code>ntpq</code></td></tr>
-<tr><td width="10%"><code>avgint</code></td><td width="40%">Average interval in s between packets from this address.</td></tr>
-<tr><td width="10%"><code>rstr</code></td><td width="40%">Restriction flags associated with this address.
-Most are copied unchanged from the matching <code>restrict</code> command,
+<tbody><tr><td width="10%"><code class="code">lstint</code></td><td width="40%">Interval in s between the receipt of the most recent packet from this
+address and the completion of the retrieval of the MRU list by <code class="code">ntpq</code></td></tr>
+<tr><td width="10%"><code class="code">avgint</code></td><td width="40%">Average interval in s between packets from this address.</td></tr>
+<tr><td width="10%"><code class="code">rstr</code></td><td width="40%">Restriction flags associated with this address.
+Most are copied unchanged from the matching <code class="code">restrict</code> command,
however 0x400 (kod) and 0x20 (limited) flags are cleared unless
the last packet from this address triggered a rate control response.</td></tr>
-<tr><td width="10%"><code>r</code></td><td width="40%">Rate control indicator, either a period, <code>L</code> or <code>K</code> for
+<tr><td width="10%"><code class="code">r</code></td><td width="40%">Rate control indicator, either a period, <code class="code">L</code> or <code class="code">K</code> for
no rate control response, rate limiting by discarding, or
rate limiting with a KoD response, respectively.</td></tr>
-<tr><td width="10%"><code>m</code></td><td width="40%">Packet mode.</td></tr>
-<tr><td width="10%"><code>v</code></td><td width="40%">Packet version number.</td></tr>
-<tr><td width="10%"><code>count</code></td><td width="40%">Packets received from this address.</td></tr>
-<tr><td width="10%"><code>rport</code></td><td width="40%">Source port of last packet from this address.</td></tr>
-<tr><td width="10%"><code>remote address</code></td><td width="40%">DNS name, numeric address, or address followed by claimed DNS name which
+<tr><td width="10%"><code class="code">m</code></td><td width="40%">Packet mode.</td></tr>
+<tr><td width="10%"><code class="code">v</code></td><td width="40%">Packet version number.</td></tr>
+<tr><td width="10%"><code class="code">count</code></td><td width="40%">Packets received from this address.</td></tr>
+<tr><td width="10%"><code class="code">rport</code></td><td width="40%">Source port of last packet from this address.</td></tr>
+<tr><td width="10%"><code class="code">remote address</code></td><td width="40%">DNS name, numeric address, or address followed by claimed DNS name which
could not be verified in parentheses.</td></tr>
+</tbody>
</table>
</dd>
-<dt><code><span id="mreadvar"></span><code>mreadvar <kbd>assocID</kbd> <kbd>assocID</kbd> [ <kbd>variable_name</kbd> [ = <kbd>value</kbd>[ ... ]</code></code></dt>
-<dt><code><span id="mrv"></span><code>mrv <kbd>assocID</kbd> <kbd>assocID</kbd> [ <kbd>variable_name</kbd> [ = <kbd>value</kbd>[ ... ]</code></code></dt>
-<dd><p>Perform the same function as the <code>readvar</code> command,
+<dt><code class="code"><a class="anchor" id="mreadvar"></a><code class="code">mreadvar <kbd class="kbd">assocID</kbd> <kbd class="kbd">assocID</kbd> [ <kbd class="kbd">variable_name</kbd> [ = <kbd class="kbd">value</kbd>[ ... ]</code></code></dt>
+<dt><code class="code"><a class="anchor" id="mrv"></a><code class="code">mrv <kbd class="kbd">assocID</kbd> <kbd class="kbd">assocID</kbd> [ <kbd class="kbd">variable_name</kbd> [ = <kbd class="kbd">value</kbd>[ ... ]</code></code></dt>
+<dd><p>Perform the same function as the <code class="code">readvar</code> command,
except for a range of association IDs.
This range is determined from the association list cached by
-the most recent <code>associations</code> command.
+the most recent <code class="code">associations</code> command.
</p>
</dd>
-<dt><code><span id="passoc"></span><code>passociations</code></code></dt>
-<dd><p>Perform the same function as the <code>associations command</code>, except that
+<dt><code class="code"><a class="anchor" id="passoc"></a><code class="code">passociations</code></code></dt>
+<dd><p>Perform the same function as the <code class="code">associations command</code>, except that
it uses previously stored data rather than making a new query.
</p>
</dd>
-<dt><code><span id="pe"></span><code>peers</code></code></dt>
+<dt><code class="code"><a class="anchor" id="pe"></a><code class="code">peers</code></code></dt>
<dd><p>Display a list of peers in the form:
<br>
-<code>[tally]remote refid st t when pool reach delay offset jitter</code>
+<code class="code">[tally]remote refid st t when pool reach delay offset jitter</code>
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>[tally]</code></td><td width="20%">single-character code indicating current value of the <code>select</code> field
-of the <a href="decode.html#peer">peer status word</a>.</td></tr>
-<tr><td width="10%"><code>remote</code></td><td width="20%">host name (or IP number) of peer</td></tr>
-<tr><td width="10%"><code>refid</code></td><td width="20%">association ID or <a href="decode.html#kiss">kiss code</a>.</td></tr>
-<tr><td width="10%"><code>st</code></td><td width="20%">stratum</td></tr>
-<tr><td width="10%"><code>t</code></td><td width="20%"><code>u</code>: unicast or manycast client,
-<code>b</code>: broadcast or multicast client,
-<code>l</code>: local (reference clock),
-<code>s</code>: symmetric (peer),
-<code>A</code>: manycast server,
-<code>B</code>: broadcast server,
-<code>M</code>: multicast server.</td></tr>
-<tr><td width="10%"><code>when</code></td><td width="20%">sec/min/hr since last received packet</td></tr>
-<tr><td width="10%"><code>poll</code></td><td width="20%">poll interval (log(2) s)</td></tr>
-<tr><td width="10%"><code>reach</code></td><td width="20%">reach shift register (octal)</td></tr>
-<tr><td width="10%"><code>delay</code></td><td width="20%">roundtrip delay</td></tr>
-<tr><td width="10%"><code>offset</code></td><td width="20%">offset of server relative to this host</td></tr>
-<tr><td width="10%"><code>jitter</code></td><td width="20%">jitter</td></tr>
+<tbody><tr><td width="10%"><code class="code">[tally]</code></td><td width="20%">single-character code indicating current value of the <code class="code">select</code> field
+of the <a class="url" href="decode.html#peer">peer status word</a>.</td></tr>
+<tr><td width="10%"><code class="code">remote</code></td><td width="20%">host name (or IP number) of peer</td></tr>
+<tr><td width="10%"><code class="code">refid</code></td><td width="20%">association ID or <a class="url" href="decode.html#kiss">kiss code</a>.</td></tr>
+<tr><td width="10%"><code class="code">st</code></td><td width="20%">stratum</td></tr>
+<tr><td width="10%"><code class="code">t</code></td><td width="20%"><code class="code">u</code>: unicast or manycast client,
+<code class="code">b</code>: broadcast or multicast client,
+<code class="code">l</code>: local (reference clock),
+<code class="code">s</code>: symmetric (peer),
+<code class="code">A</code>: manycast server,
+<code class="code">B</code>: broadcast server,
+<code class="code">M</code>: multicast server.</td></tr>
+<tr><td width="10%"><code class="code">when</code></td><td width="20%">sec/min/hr since last received packet</td></tr>
+<tr><td width="10%"><code class="code">poll</code></td><td width="20%">poll interval (log(2) s)</td></tr>
+<tr><td width="10%"><code class="code">reach</code></td><td width="20%">reach shift register (octal)</td></tr>
+<tr><td width="10%"><code class="code">delay</code></td><td width="20%">roundtrip delay</td></tr>
+<tr><td width="10%"><code class="code">offset</code></td><td width="20%">offset of server relative to this host</td></tr>
+<tr><td width="10%"><code class="code">jitter</code></td><td width="20%">jitter</td></tr>
+</tbody>
</table>
</dd>
-<dt><code><span id="rv"></span>readvar <kbd>assocID</kbd> <kbd>name</kbd> [ = <kbd>value</kbd> ] [,...]</code></dt>
-<dt><code>rv <kbd>assocID</kbd> [ <kbd>name</kbd> ] [,...]</code></dt>
+<dt><code class="code"><a class="anchor" id="rv"></a>readvar <kbd class="kbd">assocID</kbd> <kbd class="kbd">name</kbd> [ = <kbd class="kbd">value</kbd> ] [,...]</code></dt>
+<dt><code class="code">rv <kbd class="kbd">assocID</kbd> [ <kbd class="kbd">name</kbd> ] [,...]</code></dt>
<dd><p>Display the specified variables.
-If <code><kbd>assocID</kbd></code> is zero,
+If <code class="code"><kbd class="kbd">assocID</kbd></code> is zero,
the variables are from the ‘system variables’ name space,
otherwise they are from the ‘peer variables’ name space.
-The <kbd>assocID</kbd> is required, as the same name can occur in both spaces.
-If no <kbd>name</kbd> is included,
+The <kbd class="kbd">assocID</kbd> is required, as the same name can occur in both spaces.
+If no <kbd class="kbd">name</kbd> is included,
all operative variables in the name space are displayed.
-In this case only, if the <code><kbd>assocID</kbd></code> is omitted, it is assumed zero.
+In this case only, if the <code class="code"><kbd class="kbd">assocID</kbd></code> is omitted, it is assumed zero.
Multiple names are specified with comma separators and without whitespace.
Note that time values are represented in milliseconds and
frequency values in parts-per-million (PPM).
TTTT the time of day.
</p>
</dd>
-<dt><code><span id="saveconfig"></span><code>saveconfig <kbd>filename</kbd></code></code></dt>
+<dt><code class="code"><a class="anchor" id="saveconfig"></a><code class="code">saveconfig <kbd class="kbd">filename</kbd></code></code></dt>
<dd><p>Write the current configuration, including any runtime modifications
-given with <code>:config</code> or <code>config-from-file</code>,
-to the ntpd host’s file <kbd>filename</kbd>.
+given with <code class="code">:config</code> or <code class="code">config-from-file</code>,
+to the ntpd host’s file <kbd class="kbd">filename</kbd>.
This command will be rejected by the server unless
-<a href="miscopt.html#saveconfigdir">saveconfigdir</a>
-appears in the <code>ntpd</code> configuration file.
-<kbd>filename</kbd> can use <code>strftime()</code> format specifiers
+<a class="url" href="miscopt.html#saveconfigdir">saveconfigdir</a>
+appears in the <code class="code">ntpd</code> configuration file.
+<kbd class="kbd">filename</kbd> can use <code class="code">strftime()</code> format specifiers
to substitute the current date and time, for example,
-<code>saveconfig ntp-%Y%m%d-%H%M%S.conf</code>.
-The filename used is stored in system variable <code>savedconfig</code>.
+<code class="code">saveconfig ntp-%Y%m%d-%H%M%S.conf</code>.
+The filename used is stored in system variable <code class="code">savedconfig</code>.
Authentication is required.
</p>
</dd>
-<dt><code><span id="writevar"></span>writevar <kbd>assocID</kbd> <kbd>name</kbd> = <kbd>value</kbd> [,...]</code></dt>
+<dt><code class="code"><a class="anchor" id="writevar"></a>writevar <kbd class="kbd">assocID</kbd> <kbd class="kbd">name</kbd> = <kbd class="kbd">value</kbd> [,...]</code></dt>
<dd><p>Write the specified variables.
-If the <code><kbd>assocID</kbd></code> is zero, the variables are from the
+If the <code class="code"><kbd class="kbd">assocID</kbd></code> is zero, the variables are from the
‘system variables’ name space, otherwise they are from the
‘peer variables’ name space.
-The <code><kbd>assocID</kbd></code> is required,
+The <code class="code"><kbd class="kbd">assocID</kbd></code> is required,
as the same name can occur in both spaces.
</p>
</dd>
-<dt><code><span id="sysinfo"></span><code>sysinfo</code></code></dt>
+<dt><code class="code"><a class="anchor" id="sysinfo"></a><code class="code">sysinfo</code></code></dt>
<dd><p>Display operational summary.
</p>
</dd>
-<dt><code><span id="sysstats"></span><code>sysstats</code></code></dt>
+<dt><code class="code"><a class="anchor" id="sysstats"></a><code class="code">sysstats</code></code></dt>
<dd><p>Print statistics counters maintained in the protocol module.
</p>
</dd>
</dl>
<hr>
-<span id="Status-Words-and-Kiss-Codes"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Status-Words-and-Kiss-Codes">
+<div class="nav-panel">
<p>
-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>
+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">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Status-Words-and-Kiss-Codes-2"></span><h3 class="section">1.5 Status Words and Kiss Codes</h3>
+<h3 class="section" id="Status-Words-and-Kiss-Codes-2"><span>1.5 Status Words and Kiss Codes<a class="copiable-link" href="#Status-Words-and-Kiss-Codes-2"> ¶</a></span></h3>
<p>The current state of the operating program is shown
in a set of status words maintained by the system
and each association separately.
-These words are displayed in the <code>rv</code> and <code>as</code> commands
+These words are displayed in the <code class="code">rv</code> and <code class="code">as</code> commands
both in hexadecimal and decoded short tip strings.
The codes, tips and short explanations are on the
-<a href="decode.html">Event Messages and Status Words</a> page.
+<a class="url" href="decode.html">Event Messages and Status Words</a> page.
The page also includes a list of system and peer messages,
the code for the latest of which is included in the status word.
</p>
<p>Information resulting from protocol machine state transitions
is displayed using an informal set of ASCII strings called
-<a href="decode.html#kiss">kiss codes</a>.
+<a class="url" href="decode.html#kiss">kiss codes</a>.
The original purpose was for kiss-o’-death (KoD) packets sent
by the server to advise the client of an unusual condition.
They are now displayed, when appropriate,
in the reference identifier field in various billboards.
</p>
<hr>
-<span id="System-Variables"></span><div class="header">
+</div>
+<div class="section-level-extent" id="System-Variables">
+<div class="nav-panel">
<p>
-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>
+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">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="System-Variables-2"></span><h3 class="section">1.6 System Variables</h3>
+<h3 class="section" id="System-Variables-2"><span>1.6 System Variables<a class="copiable-link" href="#System-Variables-2"> ¶</a></span></h3>
-<p>The following system variables appear in the <code>rv</code> billboard.
+<p>The following system variables appear in the <code class="code">rv</code> billboard.
Not all variables are displayed in some configurations.
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>status</code></td><td width="20%"><a href="decode.html#sys">system status word</a></td></tr>
-<tr><td width="10%"><code>version</code></td><td width="20%">NTP software version and build time</td></tr>
-<tr><td width="10%"><code>processor</code></td><td width="20%">hardware platform and version</td></tr>
-<tr><td width="10%"><code>system</code></td><td width="20%">operating system and version</td></tr>
-<tr><td width="10%"><code>leap</code></td><td width="20%">leap warning indicator (0-3)</td></tr>
-<tr><td width="10%"><code>stratum</code></td><td width="20%">stratum (1-15)</td></tr>
-<tr><td width="10%"><code>precision</code></td><td width="20%">precision (log(2) s)</td></tr>
-<tr><td width="10%"><code>rootdelay</code></td><td width="20%">total roundtrip delay to the primary reference clock</td></tr>
-<tr><td width="10%"><code>rootdisp</code></td><td width="20%">total dispersion to the primary reference clock</td></tr>
-<tr><td width="10%"><code>peer</code></td><td width="20%">system peer association ID</td></tr>
-<tr><td width="10%"><code>tc</code>
+<tbody><tr><td width="10%"><code class="code">status</code></td><td width="20%"><a class="url" href="decode.html#sys">system status word</a></td></tr>
+<tr><td width="10%"><code class="code">version</code></td><td width="20%">NTP software version and build time</td></tr>
+<tr><td width="10%"><code class="code">processor</code></td><td width="20%">hardware platform and version</td></tr>
+<tr><td width="10%"><code class="code">system</code></td><td width="20%">operating system and version</td></tr>
+<tr><td width="10%"><code class="code">leap</code></td><td width="20%">leap warning indicator (0-3)</td></tr>
+<tr><td width="10%"><code class="code">stratum</code></td><td width="20%">stratum (1-15)</td></tr>
+<tr><td width="10%"><code class="code">precision</code></td><td width="20%">precision (log(2) s)</td></tr>
+<tr><td width="10%"><code class="code">rootdelay</code></td><td width="20%">total roundtrip delay to the primary reference clock</td></tr>
+<tr><td width="10%"><code class="code">rootdisp</code></td><td width="20%">total dispersion to the primary reference clock</td></tr>
+<tr><td width="10%"><code class="code">peer</code></td><td width="20%">system peer association ID</td></tr>
+<tr><td width="10%"><code class="code">tc</code>
time constant and poll exponent (log(2) s) (3-17)</td></tr>
-<tr><td width="10%"><code>mintc</code>
+<tr><td width="10%"><code class="code">mintc</code>
minimum time constant (log(2) s) (3-10)</td></tr>
-<tr><td width="10%"><code>clock</code></td><td width="20%">date and time of day</td></tr>
-<tr><td width="10%"><code>refid</code>
-reference ID or <a href="decode.html#kiss">kiss code</a></td></tr>
-<tr><td width="10%"><code>reftime</code></td><td width="20%">reference time</td></tr>
-<tr><td width="10%"><code>offset</code></td><td width="20%">combined offset of server relative to this host</td></tr>
-<tr><td width="10%"><code>sys_jitter</code></td><td width="20%">combined system jitter</td></tr>
-<tr><td width="10%"><code>frequency</code></td><td width="20%">frequency offset (PPM) relative to hardware clock</td></tr>
-<tr><td width="10%"><code>clk_wander</code></td><td width="20%">clock frequency wander (PPM)</td></tr>
-<tr><td width="10%"><code>clk_jitter</code></td><td width="20%">clock jitter</td></tr>
-<tr><td width="10%"><code>tai</code></td><td width="20%">TAI-UTC offset (s)</td></tr>
-<tr><td width="10%"><code>leapsec</code></td><td width="20%">NTP seconds when the next leap second is/was inserted</td></tr>
-<tr><td width="10%"><code>expire</code></td><td width="20%">NTP seconds when the NIST leapseconds file expires</td></tr>
+<tr><td width="10%"><code class="code">clock</code></td><td width="20%">date and time of day</td></tr>
+<tr><td width="10%"><code class="code">refid</code>
+reference ID or <a class="url" href="decode.html#kiss">kiss code</a></td></tr>
+<tr><td width="10%"><code class="code">reftime</code></td><td width="20%">reference time</td></tr>
+<tr><td width="10%"><code class="code">offset</code></td><td width="20%">combined offset of server relative to this host</td></tr>
+<tr><td width="10%"><code class="code">sys_jitter</code></td><td width="20%">combined system jitter</td></tr>
+<tr><td width="10%"><code class="code">frequency</code></td><td width="20%">frequency offset (PPM) relative to hardware clock</td></tr>
+<tr><td width="10%"><code class="code">clk_wander</code></td><td width="20%">clock frequency wander (PPM)</td></tr>
+<tr><td width="10%"><code class="code">clk_jitter</code></td><td width="20%">clock jitter</td></tr>
+<tr><td width="10%"><code class="code">tai</code></td><td width="20%">TAI-UTC offset (s)</td></tr>
+<tr><td width="10%"><code class="code">leapsec</code></td><td width="20%">NTP seconds when the next leap second is/was inserted</td></tr>
+<tr><td width="10%"><code class="code">expire</code></td><td width="20%">NTP seconds when the NIST leapseconds file expires</td></tr>
+</tbody>
</table>
<p>The jitter and wander statistics are exponentially-weighted RMS averages.
additional system variables are displayed, including some or all of the
following, depending on the particular Autokey dance:
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>host</code></td><td width="20%">Autokey host name for this host</td></tr>
-<tr><td width="10%"><code>ident</code></td><td width="20%">Autokey group name for this host</td></tr>
-<tr><td width="10%"><code>flags</code></td><td width="20%">host flags (see Autokey specification)</td></tr>
-<tr><td width="10%"><code>digest</code></td><td width="20%">OpenSSL message digest algorithm</td></tr>
-<tr><td width="10%"><code>signature</code></td><td width="20%">OpenSSL digest/signature scheme</td></tr>
-<tr><td width="10%"><code>update</code></td><td width="20%">NTP seconds at last signature update</td></tr>
-<tr><td width="10%"><code>cert</code></td><td width="20%">certificate subject, issuer and certificate flags</td></tr>
-<tr><td width="10%"><code>until</code></td><td width="20%">NTP seconds when the certificate expires</td></tr>
+<tbody><tr><td width="10%"><code class="code">host</code></td><td width="20%">Autokey host name for this host</td></tr>
+<tr><td width="10%"><code class="code">ident</code></td><td width="20%">Autokey group name for this host</td></tr>
+<tr><td width="10%"><code class="code">flags</code></td><td width="20%">host flags (see Autokey specification)</td></tr>
+<tr><td width="10%"><code class="code">digest</code></td><td width="20%">OpenSSL message digest algorithm</td></tr>
+<tr><td width="10%"><code class="code">signature</code></td><td width="20%">OpenSSL digest/signature scheme</td></tr>
+<tr><td width="10%"><code class="code">update</code></td><td width="20%">NTP seconds at last signature update</td></tr>
+<tr><td width="10%"><code class="code">cert</code></td><td width="20%">certificate subject, issuer and certificate flags</td></tr>
+<tr><td width="10%"><code class="code">until</code></td><td width="20%">NTP seconds when the certificate expires</td></tr>
+</tbody>
</table>
<hr>
-<span id="Peer-Variables"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Peer-Variables">
+<div class="nav-panel">
<p>
-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>
+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">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Peer-Variables-2"></span><h3 class="section">1.7 Peer Variables</h3>
+<h3 class="section" id="Peer-Variables-2"><span>1.7 Peer Variables<a class="copiable-link" href="#Peer-Variables-2"> ¶</a></span></h3>
-<p>The following peer variables appear in the <code>rv</code> billboard
+<p>The following peer variables appear in the <code class="code">rv</code> billboard
for each association.
Not all variables are displayed in some configurations.
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>associd</code></td><td width="20%">association ID</td></tr>
-<tr><td width="10%"><code>status</code></td><td width="20%"><a href="decode.html#peer">peer status word</a></td></tr>
-<tr><td width="10%"><code>srcadr</code></td><td width="20%">source (remote) IP address and port</td></tr>
-<tr><td width="10%"><code>dstadr</code></td><td width="20%">destination (local) IP address and port</td></tr>
-<tr><td width="10%"><code>leap</code></td><td width="20%">leap indicator (0-3)</td></tr>
-<tr><td width="10%"><code>stratum</code></td><td width="20%">stratum (0-15)</td></tr>
-<tr><td width="10%"><code>precision</code></td><td width="20%">precision (log(2) s)</td></tr>
-<tr><td width="10%"><code>rootdelay</code></td><td width="20%">total roundtrip delay to the primary reference clock</td></tr>
-<tr><td width="10%"><code>rootdisp</code></td><td width="20%">total root dispersion to the primary reference clock</td></tr>
-<tr><td width="10%"><code>refid</code></td><td width="20%">reference ID or <a href="decode.html#kiss">kiss code</a></td></tr>
-<tr><td width="10%"><code>reftime</code></td><td width="20%">reference time</td></tr>
-<tr><td width="10%"><code>reach</code></td><td width="20%">reach register (octal)</td></tr>
-<tr><td width="10%"><code>unreach</code></td><td width="20%">unreach counter</td></tr>
-<tr><td width="10%"><code>hmode</code></td><td width="20%">host mode (1-6)</td></tr>
-<tr><td width="10%"><code>pmode</code></td><td width="20%">peer mode (1-5)</td></tr>
-<tr><td width="10%"><code>hpoll</code></td><td width="20%">host poll exponent (log(2) s) (3-17)</td></tr>
-<tr><td width="10%"><code>ppoll</code></td><td width="20%">peer poll exponent (log(2) s) (3-17)</td></tr>
-<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>
-<tr><td width="10%"><code>flash</code></td><td width="20%"><a href="decode.html#flash">flash status word</a></td></tr>
-<tr><td width="10%"><code>offset</code></td><td width="20%">filter offset</td></tr>
-<tr><td width="10%"><code>delay</code></td><td width="20%">filter delay</td></tr>
-<tr><td width="10%"><code>dispersion</code></td><td width="20%">filter dispersion</td></tr>
-<tr><td width="10%"><code>jitter</code></td><td width="20%">filter jitter</td></tr>
-<tr><td width="10%"><code>ident</code></td><td width="20%">Autokey group name for this association</td></tr>
-<tr><td width="10%"><code>bias</code></td><td width="20%">unicast/broadcast bias</td></tr>
-<tr><td width="10%"><code>xleave</code></td><td width="20%">interleave delay (see <a href="xleave.html">NTP Interleaved Modes</a>)</td></tr>
+<tbody><tr><td width="10%"><code class="code">associd</code></td><td width="20%">association ID</td></tr>
+<tr><td width="10%"><code class="code">status</code></td><td width="20%"><a class="url" href="decode.html#peer">peer status word</a></td></tr>
+<tr><td width="10%"><code class="code">srcadr</code></td><td width="20%">source (remote) IP address and port</td></tr>
+<tr><td width="10%"><code class="code">dstadr</code></td><td width="20%">destination (local) IP address and port</td></tr>
+<tr><td width="10%"><code class="code">leap</code></td><td width="20%">leap indicator (0-3)</td></tr>
+<tr><td width="10%"><code class="code">stratum</code></td><td width="20%">stratum (0-15)</td></tr>
+<tr><td width="10%"><code class="code">precision</code></td><td width="20%">precision (log(2) s)</td></tr>
+<tr><td width="10%"><code class="code">rootdelay</code></td><td width="20%">total roundtrip delay to the primary reference clock</td></tr>
+<tr><td width="10%"><code class="code">rootdisp</code></td><td width="20%">total root dispersion to the primary reference clock</td></tr>
+<tr><td width="10%"><code class="code">refid</code></td><td width="20%">reference ID or <a class="url" href="decode.html#kiss">kiss code</a></td></tr>
+<tr><td width="10%"><code class="code">reftime</code></td><td width="20%">reference time</td></tr>
+<tr><td width="10%"><code class="code">reach</code></td><td width="20%">reach register (octal)</td></tr>
+<tr><td width="10%"><code class="code">unreach</code></td><td width="20%">unreach counter</td></tr>
+<tr><td width="10%"><code class="code">hmode</code></td><td width="20%">host mode (1-6)</td></tr>
+<tr><td width="10%"><code class="code">pmode</code></td><td width="20%">peer mode (1-5)</td></tr>
+<tr><td width="10%"><code class="code">hpoll</code></td><td width="20%">host poll exponent (log(2) s) (3-17)</td></tr>
+<tr><td width="10%"><code class="code">ppoll</code></td><td width="20%">peer poll exponent (log(2) s) (3-17)</td></tr>
+<tr><td width="10%"><code class="code">headway</code></td><td width="20%">headway (see <a class="url" href="rate.html">Rate Management and the Kiss-o’-Death Packet</a>)</td></tr>
+<tr><td width="10%"><code class="code">flash</code></td><td width="20%"><a class="url" href="decode.html#flash">flash status word</a></td></tr>
+<tr><td width="10%"><code class="code">offset</code></td><td width="20%">filter offset</td></tr>
+<tr><td width="10%"><code class="code">delay</code></td><td width="20%">filter delay</td></tr>
+<tr><td width="10%"><code class="code">dispersion</code></td><td width="20%">filter dispersion</td></tr>
+<tr><td width="10%"><code class="code">jitter</code></td><td width="20%">filter jitter</td></tr>
+<tr><td width="10%"><code class="code">ident</code></td><td width="20%">Autokey group name for this association</td></tr>
+<tr><td width="10%"><code class="code">bias</code></td><td width="20%">unicast/broadcast bias</td></tr>
+<tr><td width="10%"><code class="code">xleave</code></td><td width="20%">interleave delay (see <a class="url" href="xleave.html">NTP Interleaved Modes</a>)</td></tr>
+</tbody>
</table>
<p>The bias variable is calculated when the first broadcast packet is received
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional peer variables are displayed, including the following:
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>flags</code></td><td width="20%">peer flags (see Autokey specification)</td></tr>
-<tr><td width="10%"><code>host</code></td><td width="20%">Autokey server name</td></tr>
-<tr><td width="10%"><code>flags</code></td><td width="20%">peer flags (see Autokey specification)</td></tr>
-<tr><td width="10%"><code>signature</code></td><td width="20%">OpenSSL digest/signature scheme</td></tr>
-<tr><td width="10%"><code>initsequence</code></td><td width="20%">initial key ID</td></tr>
-<tr><td width="10%"><code>initkey</code></td><td width="20%">initial key index</td></tr>
-<tr><td width="10%"><code>timestamp</code></td><td width="20%">Autokey signature timestamp</td></tr>
+<tbody><tr><td width="10%"><code class="code">flags</code></td><td width="20%">peer flags (see Autokey specification)</td></tr>
+<tr><td width="10%"><code class="code">host</code></td><td width="20%">Autokey server name</td></tr>
+<tr><td width="10%"><code class="code">flags</code></td><td width="20%">peer flags (see Autokey specification)</td></tr>
+<tr><td width="10%"><code class="code">signature</code></td><td width="20%">OpenSSL digest/signature scheme</td></tr>
+<tr><td width="10%"><code class="code">initsequence</code></td><td width="20%">initial key ID</td></tr>
+<tr><td width="10%"><code class="code">initkey</code></td><td width="20%">initial key index</td></tr>
+<tr><td width="10%"><code class="code">timestamp</code></td><td width="20%">Autokey signature timestamp</td></tr>
+</tbody>
</table>
<hr>
-<span id="Clock-Variables"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Clock-Variables">
+<div class="nav-panel">
<p>
-Previous: <a href="#Peer-Variables" accesskey="p" rel="prev">Peer Variables</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Previous: <a href="#Peer-Variables" accesskey="p" rel="prev">Peer Variables</a>, Up: <a href="#Top" accesskey="u" rel="up">ntpq: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Clock-Variables-2"></span><h3 class="section">1.8 Clock Variables</h3>
+<h3 class="section" id="Clock-Variables-2"><span>1.8 Clock Variables<a class="copiable-link" href="#Clock-Variables-2"> ¶</a></span></h3>
-<p>The following clock variables appear in the <code>cv</code> billboard for each association with a reference clock. Not all variables are displayed in some configurations.
+<p>The following clock variables appear in the <code class="code">cv</code> billboard for each association with a reference clock. Not all variables are displayed in some configurations.
</p>
-<table>
+<table class="multitable">
<thead><tr><th width="10%">Variable</th><th width="20%">Description</th></tr></thead>
-<tr><td width="10%"><code>associd</code></td><td width="20%">association ID</td></tr>
-<tr><td width="10%"><code>status</code></td><td width="20%"><a href="decode.html#clock">clock status word</a></td></tr>
-<tr><td width="10%"><code>device</code></td><td width="20%">device description</td></tr>
-<tr><td width="10%"><code>timecode</code></td><td width="20%">ASCII time code string (specific to device)</td></tr>
-<tr><td width="10%"><code>poll</code></td><td width="20%">poll messages sent</td></tr>
-<tr><td width="10%"><code>noreply</code></td><td width="20%">no reply</td></tr>
-<tr><td width="10%"><code>badformat</code></td><td width="20%">bad format</td></tr>
-<tr><td width="10%"><code>baddata</code></td><td width="20%">bad date or time</td></tr>
-<tr><td width="10%"><code>fudgetime1</code></td><td width="20%">fudge time 1</td></tr>
-<tr><td width="10%"><code>fudgetime2</code></td><td width="20%">fudge time 2</td></tr>
-<tr><td width="10%"><code>stratum</code></td><td width="20%">driver stratum</td></tr>
-<tr><td width="10%"><code>refid</code></td><td width="20%">driver reference ID</td></tr>
-<tr><td width="10%"><code>flags</code></td><td width="20%">driver flags</td></tr>
+<tbody><tr><td width="10%"><code class="code">associd</code></td><td width="20%">association ID</td></tr>
+<tr><td width="10%"><code class="code">status</code></td><td width="20%"><a class="url" href="decode.html#clock">clock status word</a></td></tr>
+<tr><td width="10%"><code class="code">device</code></td><td width="20%">device description</td></tr>
+<tr><td width="10%"><code class="code">timecode</code></td><td width="20%">ASCII time code string (specific to device)</td></tr>
+<tr><td width="10%"><code class="code">poll</code></td><td width="20%">poll messages sent</td></tr>
+<tr><td width="10%"><code class="code">noreply</code></td><td width="20%">no reply</td></tr>
+<tr><td width="10%"><code class="code">badformat</code></td><td width="20%">bad format</td></tr>
+<tr><td width="10%"><code class="code">baddata</code></td><td width="20%">bad date or time</td></tr>
+<tr><td width="10%"><code class="code">fudgetime1</code></td><td width="20%">fudge time 1</td></tr>
+<tr><td width="10%"><code class="code">fudgetime2</code></td><td width="20%">fudge time 2</td></tr>
+<tr><td width="10%"><code class="code">stratum</code></td><td width="20%">driver stratum</td></tr>
+<tr><td width="10%"><code class="code">refid</code></td><td width="20%">driver reference ID</td></tr>
+<tr><td width="10%"><code class="code">flags</code></td><td width="20%">driver flags</td></tr>
+</tbody>
</table>
-<hr>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpq @NTPQ_MS@ "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpq @NTPQ_MS@ "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:15 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:55 AM by AutoGen 5.18.16
.\" From the definitions ntpq-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPQ @NTPQ_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpq-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:51 AM by AutoGen 5.18.16
.\" From the definitions ntpq-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpsnmpd.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:38:20 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:35:00 AM by AutoGen 5.18.16
# From the definitions ntpsnmpd-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
@exampleindent 0
@example
-ntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.8p16
+ntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.8p17
Usage: ntpsnmpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
Flg Arg Option-Name Description
-n no nofork Do not fork
/*
* EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:17 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:36:04 AM by AutoGen 5.18.16
* From the definitions ntpsnmpd-opts.def
* and the template file options
*
* The ntpsnmpd program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const ntpsnmpd_opt_strs[1614] =
/* 0 */ "ntpsnmpd 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via ntpsnmpdOptions.pzCopyright */
puts(_("ntpsnmpd 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:16 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:36:04 AM by AutoGen 5.18.16
* From the definitions ntpsnmpd-opts.def
* and the template file options
*
* The ntpsnmpd program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpsnmpd 1ntpsnmpdman "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpsnmpd 1ntpsnmpdman "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:21 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:01 AM by AutoGen 5.18.16
.\" From the definitions ntpsnmpd-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.NOP "Heiko Gerstung"
.br
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:18 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:58 AM by AutoGen 5.18.16
.\" From the definitions ntpsnmpd-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh AUTHORS
.An "Heiko Gerstung"
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#ntpsnmpd-Description" rel="next" title="ntpsnmpd Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual</h1>
-<span id="SEC_Overview"></span>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
-</ul>
-</div>
-
-
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#ntpsnmpd-Description" accesskey="n" rel="next">
ntpsnmpd 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>
+Next: <a href="#ntpsnmpd-Description" accesskey="n" rel="next">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>
</div>
-<span id="ntpsnmpd_003a-Network-Time-Protocol-Query-User-Manual"></span><h1 class="top">ntpsnmpd: Network Time Protocol Query User Manual</h1>
+<h1 class="top" id="ntpsnmpd_003a-Network-Time-Protocol-Query-User-Manual"><span>ntpsnmpd: Network Time Protocol Query User Manual<a class="copiable-link" href="#ntpsnmpd_003a-Network-Time-Protocol-Query-User-Manual"> ¶</a></span></h1>
-<p>The <code>ntpsnmpd</code> utility program is used to monitor NTP daemon <code>ntpd</code>
+<p>The <code class="code">ntpsnmpd</code> utility program is used to monitor NTP daemon <code class="code">ntpd</code>
operations and determine performance. It uses the standard NTP mode 6 control
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntpsnmpd</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntpsnmpd</code>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpsnmpd-Description" accesskey="1">ntpsnmpd Description</a></td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• ntpsnmpd Invocation</td><td> </td><td align="left" valign="top">Invoking ntpsnmpd
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="3">Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-</table>
+<div class="element-shortcontents" id="SEC_Shortcontents">
+<h2 class="shortcontents-heading">Short Table of Contents</h2>
+
+<div class="shortcontents">
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#ntpsnmpd-Description">1 Description</a></li>
+</ul>
+</div>
+</div>
<hr>
-<span id="ntpsnmpd-Description"></span><div class="header">
+<div class="chapter-level-extent" id="ntpsnmpd-Description">
+<div class="nav-panel">
<p>
-Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#Top" accesskey="p" rel="prev">ntpsnmpd: Network Time Protocol Query User Manual</a>, Up: <a href="#Top" accesskey="u" rel="up">ntpsnmpd: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>The <code>ntpsnmpd</code> utility program provides an SNMP MIB agent for <code>ntpd</code>.
+<p>The <code class="code">ntpsnmpd</code> utility program provides an SNMP MIB agent for <code class="code">ntpd</code>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="1">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#Usage" accesskey="1">Usage</a></li>
+</ul>
<hr>
-<span id="Usage"></span><div class="header">
+<div class="section-level-extent" id="Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntpsnmpd-Description" accesskey="p" rel="prev">ntpsnmpd Description</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Previous: <a href="#ntpsnmpd-Description" accesskey="p" rel="prev">Description</a>, Up: <a href="#Top" accesskey="u" rel="up">ntpsnmpd: Network Time Protocol Query User Manual</a> </p>
</div>
-<span id="Usage-1"></span><h3 class="section">1.1 Usage</h3>
+<h3 class="section" id="Usage-1"><span>1.1 Usage<a class="copiable-link" href="#Usage-1"> ¶</a></span></h3>
<p>(what should we say here?)
-</p><hr>
+</p></div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpsnmpd @NTPSNMPD_MS@ "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH ntpsnmpd @NTPSNMPD_MS@ "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:21 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:01 AM by AutoGen 5.18.16
.\" From the definitions ntpsnmpd-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.NOP "Heiko Gerstung"
.br
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPSNMPD @NTPSNMPD_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:18 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:34:58 AM by AutoGen 5.18.16
.\" From the definitions ntpsnmpd-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh AUTHORS
.An "Heiko Gerstung"
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH calc_tickadj 1calc_tickadjman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH calc_tickadj 1calc_tickadjman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:36 AM by AutoGen 5.18.16
.\" From the definitions calc_tickadj-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:12 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:50 AM by AutoGen 5.18.16
.\" From the definitions calc_tickadj-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>calc_tickadj User’s Manual</title>
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
-<span id="Top"></span><div class="header">
+<a name="Top"></a>
+<div class="header">
<p>
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>
</div>
-<span id="calc_005ftickadj-User_0027s-Manual"></span><h1 class="top">calc_tickadj User’s Manual</h1>
+<a name="calc_005ftickadj-User_0027s-Manual"></a>
+<h1 class="top">calc_tickadj User’s Manual</h1>
<p>This document describes the use of the NTP Project’s <code>calc_tickadj</code> program.
This document applies to version 4.2.8p17 of <code>calc_tickadj</code>.
</p>
-<span id="SEC_Overview"></span>
+<a name="SEC_Overview"></a>
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
<ul class="no-bullet">
-<li><a id="stoc-Invoking-calc_005ftickadj" href="#toc-Invoking-calc_005ftickadj">1 Invoking calc_tickadj</a></li>
+<li><a name="stoc-Invoking-calc_005ftickadj" href="#toc-Invoking-calc_005ftickadj">1 Invoking calc_tickadj</a></li>
</ul>
</div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• calc_tickadj Description</td><td> </td><td align="left" valign="top">Description
+<tr><td align="left" valign="top">• calc_tickadj Description:</td><td> </td><td align="left" valign="top">Description
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-Invocation" accesskey="2">calc_tickadj Invocation</a></td><td> </td><td align="left" valign="top">Invoking calc_tickadj
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-Invocation" accesskey="2">calc_tickadj Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking calc_tickadj
</td></tr>
</table>
<hr>
-<span id="calc_005ftickadj-Invocation"></span><div class="header">
+<a name="calc_005ftickadj-Invocation"></a>
+<div class="header">
<p>
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
</div>
-<span id="Invoking-calc_005ftickadj"></span><h2 class="chapter">1 Invoking calc_tickadj</h2>
-<span id="index-calc_005ftickadj"></span>
-<span id="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e"></span>
+<a name="Invoking-calc_005ftickadj"></a>
+<h2 class="chapter">1 Invoking calc_tickadj</h2>
+<a name="index-calc_005ftickadj"></a>
+<a name="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e"></a>
<p>The <code>calc_tickadj</code> script uses provided ntp drift file to generate optimal
tick value. Generally, ntpd can do better job if the drift value is the
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>calc_tickadj</code> program.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-usage" accesskey="1">calc_tickadj usage</a></td><td> </td><td align="left" valign="top">calc_tickadj help/usage (<samp>--help</samp>)
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-usage" accesskey="1">calc_tickadj usage</a>:</td><td> </td><td align="left" valign="top">calc_tickadj help/usage (<samp>--help</samp>)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="2">calc_tickadj drift-file</a></td><td> </td><td align="left" valign="top">drift-file option (-d)
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="2">calc_tickadj drift-file</a>:</td><td> </td><td align="left" valign="top">drift-file option (-d)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="3">calc_tickadj tick</a></td><td> </td><td align="left" valign="top">tick option (-t)
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="3">calc_tickadj tick</a>:</td><td> </td><td align="left" valign="top">tick option (-t)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="4">calc_tickadj exit status</a></td><td> </td><td align="left" valign="top">exit status
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="4">calc_tickadj exit status</a>:</td><td> </td><td align="left" valign="top">exit status
</td></tr>
</table>
<hr>
-<span id="calc_005ftickadj-usage"></span><div class="header">
+<a name="calc_005ftickadj-usage"></a>
+<div class="header">
<p>
Next: <a href="#calc_005ftickadj-drift_002dfile" accesskey="n" rel="next">calc_tickadj drift-file</a>, Up: <a href="#calc_005ftickadj-Invocation" accesskey="u" rel="up">calc_tickadj Invocation</a> </p>
</div>
-<span id="calc_005ftickadj-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 calc_tickadj help/usage (<samp>--help</samp>)</h3>
-<span id="index-calc_005ftickadj-help"></span>
+<a name="calc_005ftickadj-help_002fusage-_0028_002d_002dhelp_0029"></a>
+<h3 class="section">1.1 calc_tickadj help/usage (<samp>--help</samp>)</h3>
+<a name="index-calc_005ftickadj-help"></a>
<p>This is the automatically generated usage text for calc_tickadj.
</p>
</pre></div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="1">drift-file option (-d)</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="1">calc_tickadj drift-file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="2">tick option (-t)</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="2">calc_tickadj tick</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="3">calc_tickadj exit status</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="3">calc_tickadj exit status</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
-<span id="calc_005ftickadj-drift_002dfile"></span><div class="header">
+<a name="calc_005ftickadj-drift_002dfile"></a>
+<div class="header">
<p>
Next: <a href="#calc_005ftickadj-tick" accesskey="n" rel="next">calc_tickadj tick</a>, Previous: <a href="#calc_005ftickadj-usage" accesskey="p" rel="prev">calc_tickadj usage</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p>
</div>
-<span id="drift_002dfile-option-_0028_002dd_0029"></span><h4 class="subsection">1.1.1 drift-file option (-d)</h4>
-<span id="index-calc_005ftickadj_002ddrift_002dfile"></span>
+<a name="drift_002dfile-option-_0028_002dd_0029"></a>
+<h4 class="subsection">1.1.1 drift-file option (-d)</h4>
+<a name="index-calc_005ftickadj_002ddrift_002dfile"></a>
<p>This is the “ntp drift file to use” option.
This option takes a string argument.
Use the specified drift file for calculations
</p><hr>
-<span id="calc_005ftickadj-tick"></span><div class="header">
+<a name="calc_005ftickadj-tick"></a>
+<div class="header">
<p>
Next: <a href="#calc_005ftickadj-exit-status" accesskey="n" rel="next">calc_tickadj exit status</a>, Previous: <a href="#calc_005ftickadj-drift_002dfile" accesskey="p" rel="prev">calc_tickadj drift-file</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p>
</div>
-<span id="tick-option-_0028_002dt_0029"></span><h4 class="subsection">1.1.2 tick option (-t)</h4>
-<span id="index-calc_005ftickadj_002dtick"></span>
+<a name="tick-option-_0028_002dt_0029"></a>
+<h4 class="subsection">1.1.2 tick option (-t)</h4>
+<a name="index-calc_005ftickadj_002dtick"></a>
<p>This is the “tick value of this host” option.
This option takes a number argument.
The current tick which to adjustment will be calculated
</p><hr>
-<span id="calc_005ftickadj-exit-status"></span><div class="header">
+<a name="calc_005ftickadj-exit-status"></a>
+<div class="header">
<p>
Previous: <a href="#calc_005ftickadj-tick" accesskey="p" rel="prev">calc_tickadj tick</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p>
</div>
-<span id="calc_005ftickadj-exit-status-1"></span><h4 class="subsection">1.1.3 calc_tickadj exit status</h4>
+<a name="calc_005ftickadj-exit-status-1"></a>
+<h4 class="subsection">1.1.3 calc_tickadj exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH calc_tickadj 1calc_tickadjman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH calc_tickadj 1calc_tickadjman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:36 AM by AutoGen 5.18.16
.\" From the definitions calc_tickadj-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:12 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:50 AM by AutoGen 5.18.16
.\" From the definitions calc_tickadj-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
#
# EDIT THIS FILE WITH CAUTION (invoke-calc_tickadj.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:13 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 03:50:37 AM by AutoGen 5.18.16
# From the definitions calc_tickadj-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-plot_summary.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:36 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 03:50:27 AM by AutoGen 5.18.16
# From the definitions plot_summary-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-summary.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:40 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 03:50:32 AM by AutoGen 5.18.16
# From the definitions summary-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:17 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:32:53 AM by AutoGen 5.18.16
# From the definitions ntp-wait-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
# EDIT THIS FILE WITH CAUTION (ntp-wait-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:15 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:32:51 AM by AutoGen 5.18.16
# From the definitions ntp-wait-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-wait 1ntp-waitman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntp-wait 1ntp-waitman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:18 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:39 AM by AutoGen 5.18.16
.\" From the definitions ntp-wait-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_WAIT 1ntp-waitmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:15 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:52 AM by AutoGen 5.18.16
.\" From the definitions ntp-wait-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Ntp-wait User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">Ntp-wait User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<a class="node-id" id="Top"></a><div class="nav-panel">
<p>
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>
</div>
-<h1 class="node-heading">Top</h1>
+<h1 class="node"><span>Top<a class="copiable-link" href="#Top"> ¶</a></span></h1>
-<p>This document describes the use of the NTP Project’s <code>ntp-wait</code> program.
+<p>This document describes the use of the NTP Project’s <code class="code">ntp-wait</code> program.
</p>
<p>If there are time-sensitive applications,
the proper sequence of events is to
-run <code>ntpd -g</code> as early as possible,
+run <code class="code">ntpd -g</code> as early as possible,
then invoke all of the non-time-sensitive process,
-run <code>ntp-wait</code> to block
+run <code class="code">ntp-wait</code> to block
until the system’s time has stabilized and synchronized,
and only then start any applicaitons (like database servers) that require
accurate and stable time.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntp-wait</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntp-wait</code>.
</p>
-<span id="SEC_Overview"></span>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<li><a id="stoc-Invoking-ntp_002dwait" href="#toc-Invoking-ntp_002dwait">1 Invoking ntp-wait</a></li>
-
-</div>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• ntp-wait Description</td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-Invocation" accesskey="2">ntp-wait Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntp-wait
-</td></tr>
-</table>
-
<hr>
-<span id="ntp_002dwait-Invocation"></span><div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<div class="section-level-extent" id="ntp_002dwait-Invocation">
+<div class="nav-panel">
</div>
-<span id="Invoking-ntp_002dwait"></span><h3 class="section">1 Invoking ntp-wait</h3>
-<span id="index-ntp_002dwait"></span>
-<span id="index-Wait-for-ntpd-to-stabilize-the-system-clock"></span>
+<h3 class="section" id="Invoking-ntp_002dwait"><span>1 Invoking ntp-wait<a class="copiable-link" href="#Invoking-ntp_002dwait"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntp_002dwait"></a>
+<a class="index-entry-id" id="index-Wait-for-ntpd-to-stabilize-the-system-clock"></a>
-<p><code>ntp-wait</code>
+<p><code class="code">ntp-wait</code>
will send at most
-<kbd>num-tries</kbd>
+<kbd class="kbd">num-tries</kbd>
queries to
-<code>ntpd(8)</code>,
+<code class="code">ntpd(8)</code>,
sleeping for
-<kbd>secs-between-tries</kbd>
+<kbd class="kbd">secs-between-tries</kbd>
after each status return that says
-<code>ntpd(8)</code>
+<code class="code">ntpd(8)</code>
has not yet produced a synchronized and stable system clock.
</p>
-<p><code>ntp-wait</code>
+<p><code class="code">ntp-wait</code>
will do this quietly, unless the
-<code>-v</code>
+<code class="code">-v</code>
flag is provided.
This can be useful at boot time, to delay the boot sequence until after
-<kbd>ntpd</kbd> <kbd>-g</kbd>
+<kbd class="kbd">ntpd</kbd> <kbd class="kbd">-g</kbd>
has set the time.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp-wait</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntp-wait</code> program.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-usage" accesskey="1">ntp-wait usage</a></td><td> </td><td align="left" valign="top">ntp-wait help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-tries" accesskey="2">ntp-wait tries</a></td><td> </td><td align="left" valign="top">tries option (-n)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-sleep" accesskey="3">ntp-wait sleep</a></td><td> </td><td align="left" valign="top">sleep option (-s)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-verbose" accesskey="4">ntp-wait verbose</a></td><td> </td><td align="left" valign="top">verbose option (-v)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-exit-status" accesskey="5">ntp-wait exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-Authors" accesskey="6">ntp-wait Authors</a></td><td> </td><td align="left" valign="top">Authors
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dwait-Notes" accesskey="7">ntp-wait Notes</a></td><td> </td><td align="left" valign="top">Notes
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#ntp_002dwait-usage" accesskey="1">ntp-wait help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#ntp_002dwait-tries" accesskey="2">tries option (-n)</a></li>
+<li><a href="#ntp_002dwait-sleep" accesskey="3">sleep option (-s)</a></li>
+<li><a href="#ntp_002dwait-verbose" accesskey="4">verbose option (-v)</a></li>
+<li><a href="#ntp_002dwait-exit-status" accesskey="5">ntp-wait exit status</a></li>
+<li><a href="#ntp_002dwait-Authors" accesskey="6">ntp-wait Authors</a></li>
+<li><a href="#ntp_002dwait-Notes" accesskey="7">ntp-wait Notes</a></li>
+</ul>
<hr>
-<span id="ntp_002dwait-usage"></span><div class="header">
+<div class="subsection-level-extent" id="ntp_002dwait-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-tries" accesskey="n" rel="next">ntp-wait tries</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-tries" accesskey="n" rel="next">tries option (-n)</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="ntp_002dwait-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1 ntp-wait help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntp_002dwait-help"></span>
+<h4 class="subsection" id="ntp_002dwait-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1 ntp-wait help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntp_002dwait-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dwait-help"></a>
<p>This is the automatically generated usage text for ntp-wait.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p17
+<pre class="example-preformatted">ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p17
USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
-n, --tries=num Number of times to check ntpd
</pre></div>
<hr>
-<span id="ntp_002dwait-tries"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-tries">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-sleep" accesskey="n" rel="next">ntp-wait sleep</a>, Previous: <a href="#ntp_002dwait-usage" accesskey="p" rel="prev">ntp-wait usage</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-sleep" accesskey="n" rel="next">sleep option (-s)</a>, Previous: <a href="#ntp_002dwait-usage" accesskey="p" rel="prev">ntp-wait help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="tries-option-_0028_002dn_0029"></span><h4 class="subsection">1.2 tries option (-n)</h4>
-<span id="index-ntp_002dwait_002dtries"></span>
+<h4 class="subsection" id="tries-option-_0028_002dn_0029"><span>1.2 tries option (-n)<a class="copiable-link" href="#tries-option-_0028_002dn_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dwait_002dtries"></a>
<p>This is the “number of times to check ntpd” option.
This option takes a number argument.
- The maximum number of times we will check <code>ntpd</code> to see if
+ The maximum number of times we will check <code class="code">ntpd</code> to see if
it has been able to synchronize and stabilize the system clock.
</p><hr>
-<span id="ntp_002dwait-sleep"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-sleep">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-verbose" accesskey="n" rel="next">ntp-wait verbose</a>, Previous: <a href="#ntp_002dwait-tries" accesskey="p" rel="prev">ntp-wait tries</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-verbose" accesskey="n" rel="next">verbose option (-v)</a>, Previous: <a href="#ntp_002dwait-tries" accesskey="p" rel="prev">tries option (-n)</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="sleep-option-_0028_002ds_0029"></span><h4 class="subsection">1.3 sleep option (-s)</h4>
-<span id="index-ntp_002dwait_002dsleep"></span>
+<h4 class="subsection" id="sleep-option-_0028_002ds_0029"><span>1.3 sleep option (-s)<a class="copiable-link" href="#sleep-option-_0028_002ds_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dwait_002dsleep"></a>
<p>This is the “how long to sleep between tries” option.
-This option takes a number argument <samp>secs-between-tries</samp>.
- We will sleep for <samp>secs-between-tries</samp> after each query
- of <code>ntpd</code> that returns "the time is not yet stable".
+This option takes a number argument <samp class="file">secs-between-tries</samp>.
+ We will sleep for <samp class="file">secs-between-tries</samp> after each query
+ of <code class="code">ntpd</code> that returns "the time is not yet stable".
</p><hr>
-<span id="ntp_002dwait-verbose"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-verbose">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-exit-status" accesskey="n" rel="next">ntp-wait exit status</a>, Previous: <a href="#ntp_002dwait-sleep" accesskey="p" rel="prev">ntp-wait sleep</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-exit-status" accesskey="n" rel="next">ntp-wait exit status</a>, Previous: <a href="#ntp_002dwait-sleep" accesskey="p" rel="prev">sleep option (-s)</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="verbose-option-_0028_002dv_0029"></span><h4 class="subsection">1.4 verbose option (-v)</h4>
-<span id="index-ntp_002dwait_002dverbose"></span>
+<h4 class="subsection" id="verbose-option-_0028_002dv_0029"><span>1.4 verbose option (-v)<a class="copiable-link" href="#verbose-option-_0028_002dv_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dwait_002dverbose"></a>
<p>This is the “be verbose” option.
- By default, <code>ntp-wait</code> is silent.
- With this option, <code>ntp-wait</code> will provide status information.
+ By default, <code class="code">ntp-wait</code> is silent.
+ With this option, <code class="code">ntp-wait</code> will provide status information.
</p><hr>
-<span id="ntp_002dwait-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-exit-status">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-Authors" accesskey="n" rel="next">ntp-wait Authors</a>, Previous: <a href="#ntp_002dwait-verbose" accesskey="p" rel="prev">ntp-wait verbose</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-Authors" accesskey="n" rel="next">ntp-wait Authors</a>, Previous: <a href="#ntp_002dwait-verbose" accesskey="p" rel="prev">verbose option (-v)</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="ntp_002dwait-exit-status-1"></span><h4 class="subsection">1.5 ntp-wait exit status</h4>
+<h4 class="subsection" id="ntp_002dwait-exit-status-1"><span>1.5 ntp-wait exit status<a class="copiable-link" href="#ntp_002dwait-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
</dl>
<hr>
-<span id="ntp_002dwait-Authors"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-Authors">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dwait-Notes" accesskey="n" rel="next">ntp-wait Notes</a>, Previous: <a href="#ntp_002dwait-exit-status" accesskey="p" rel="prev">ntp-wait exit status</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Next: <a href="#ntp_002dwait-Notes" accesskey="n" rel="next">ntp-wait Notes</a>, Previous: <a href="#ntp_002dwait-exit-status" accesskey="p" rel="prev">ntp-wait exit status</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
</div>
-<span id="ntp_002dwait-Authors-1"></span><h4 class="subsection">1.6 ntp-wait Authors</h4>
+<h4 class="subsection" id="ntp_002dwait-Authors-1"><span>1.6 ntp-wait Authors<a class="copiable-link" href="#ntp_002dwait-Authors-1"> ¶</a></span></h4>
<hr>
-<span id="ntp_002dwait-Notes"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dwait-Notes">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002dwait-Authors" accesskey="p" rel="prev">ntp-wait Authors</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">ntp-wait Invocation</a> </p>
+Previous: <a href="#ntp_002dwait-Authors" accesskey="p" rel="prev">ntp-wait Authors</a>, Up: <a href="#ntp_002dwait-Invocation" accesskey="u" rel="up">Invoking ntp-wait</a> </p>
+</div>
+<h4 class="subsection" id="ntp_002dwait-Notes-1"><span>1.7 ntp-wait Notes<a class="copiable-link" href="#ntp_002dwait-Notes-1"> ¶</a></span></h4>
+</div>
</div>
-<span id="ntp_002dwait-Notes-1"></span><h4 class="subsection">1.7 ntp-wait Notes</h4>
-<hr>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-wait @NTP_WAIT_MS@ "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntp-wait @NTP_WAIT_MS@ "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:18 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:39 AM by AutoGen 5.18.16
.\" From the definitions ntp-wait-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_WAIT @NTP_WAIT_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:15 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:52 AM by AutoGen 5.18.16
.\" From the definitions ntp-wait-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:20 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 03:50:47 AM by AutoGen 5.18.16
# From the definitions ntpsweep-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
# EDIT THIS FILE WITH CAUTION (ntpsweep-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:20 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:32:55 AM by AutoGen 5.18.16
# From the definitions ntpsweep-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpsweep 1ntpsweepman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntpsweep 1ntpsweepman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:23 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:44 AM by AutoGen 5.18.16
.\" From the definitions ntpsweep-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt NTPSWEEP 1ntpsweepmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpsweep-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:22 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:45 AM by AutoGen 5.18.16
.\" From the definitions ntpsweep-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ntpsweep User’s Manual</title>
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
-<span id="Top"></span><div class="header">
+<a name="Top"></a>
+<div class="header">
<p>
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>
</div>
</p>
<p>This document applies to version 4.2.8p17 of <code>ntpsweep</code>.
</p>
-<span id="SEC_Overview"></span>
+<a name="SEC_Overview"></a>
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<li><a id="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li>
+<li><a name="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li>
</div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• ntpsweep Description</td><td> </td><td align="left" valign="top">Description
+<tr><td align="left" valign="top">• ntpsweep Description:</td><td> </td><td align="left" valign="top">Description
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-Invocation" accesskey="2">ntpsweep Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntpsweep
+<tr><td align="left" valign="top">• <a href="#ntpsweep-Invocation" accesskey="2">ntpsweep Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking ntpsweep
</td></tr>
</table>
<hr>
-<span id="ntpsweep-Invocation"></span><div class="header">
+<a name="ntpsweep-Invocation"></a>
+<div class="header">
<p>
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
</div>
-<span id="Invoking-ntpsweep"></span><h3 class="section">1 Invoking ntpsweep</h3>
-<span id="index-ntpsweep"></span>
-<span id="index-Print-various-informations-about-given-ntp-servers"></span>
+<a name="Invoking-ntpsweep"></a>
+<h3 class="section">1 Invoking ntpsweep</h3>
+<a name="index-ntpsweep"></a>
+<a name="index-Print-various-informations-about-given-ntp-servers"></a>
<p><code>ntpsweep</code>
prints per host the NTP stratum level, the clock offset in seconds, the daemon
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntpsweep-usage" accesskey="1">ntpsweep usage</a></td><td> </td><td align="left" valign="top">ntpsweep help/usage (<samp>--help</samp>)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-usage" accesskey="1">ntpsweep usage</a>:</td><td> </td><td align="left" valign="top">ntpsweep help/usage (<samp>--help</samp>)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-host_002dlist" accesskey="2">ntpsweep host-list</a></td><td> </td><td align="left" valign="top">host-list option (-l)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-host_002dlist" accesskey="2">ntpsweep host-list</a>:</td><td> </td><td align="left" valign="top">host-list option (-l)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-peers" accesskey="3">ntpsweep peers</a></td><td> </td><td align="left" valign="top">peers option (-p)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-peers" accesskey="3">ntpsweep peers</a>:</td><td> </td><td align="left" valign="top">peers option (-p)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-maxlevel" accesskey="4">ntpsweep maxlevel</a></td><td> </td><td align="left" valign="top">maxlevel option (-m)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-maxlevel" accesskey="4">ntpsweep maxlevel</a>:</td><td> </td><td align="left" valign="top">maxlevel option (-m)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-strip" accesskey="5">ntpsweep strip</a></td><td> </td><td align="left" valign="top">strip option (-s)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-strip" accesskey="5">ntpsweep strip</a>:</td><td> </td><td align="left" valign="top">strip option (-s)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-host" accesskey="6">ntpsweep host</a></td><td> </td><td align="left" valign="top">host option (-h)
+<tr><td align="left" valign="top">• <a href="#ntpsweep-host" accesskey="6">ntpsweep host</a>:</td><td> </td><td align="left" valign="top">host option (-h)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntpsweep-exit-status" accesskey="7">ntpsweep exit status</a></td><td> </td><td align="left" valign="top">exit status
+<tr><td align="left" valign="top">• <a href="#ntpsweep-exit-status" accesskey="7">ntpsweep exit status</a>:</td><td> </td><td align="left" valign="top">exit status
</td></tr>
</table>
<hr>
-<span id="ntpsweep-usage"></span><div class="header">
+<a name="ntpsweep-usage"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-host_002dlist" accesskey="n" rel="next">ntpsweep host-list</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="ntpsweep-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1 ntpsweep help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntpsweep-help"></span>
+<a name="ntpsweep-help_002fusage-_0028_002d_002dhelp_0029"></a>
+<h4 class="subsection">1.1 ntpsweep help/usage (<samp>--help</samp>)</h4>
+<a name="index-ntpsweep-help"></a>
<p>This is the automatically generated usage text for ntpsweep.
</p>
</pre></div>
<hr>
-<span id="ntpsweep-host_002dlist"></span><div class="header">
+<a name="ntpsweep-host_002dlist"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-peers" accesskey="n" rel="next">ntpsweep peers</a>, Previous: <a href="#ntpsweep-usage" accesskey="p" rel="prev">ntpsweep usage</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="host_002dlist-option-_0028_002dl_0029"></span><h4 class="subsection">1.2 host-list option (-l)</h4>
-<span id="index-ntpsweep_002dhost_002dlist"></span>
+<a name="host_002dlist-option-_0028_002dl_0029"></a>
+<h4 class="subsection">1.2 host-list option (-l)</h4>
+<a name="index-ntpsweep_002dhost_002dlist"></a>
<p>This is the “host to execute actions on” option.
This option takes a string argument.
<p>Use this option to specify the host on which this script operates.
May appear multiple times.
</p><hr>
-<span id="ntpsweep-peers"></span><div class="header">
+<a name="ntpsweep-peers"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-maxlevel" accesskey="n" rel="next">ntpsweep maxlevel</a>, Previous: <a href="#ntpsweep-host_002dlist" accesskey="p" rel="prev">ntpsweep host-list</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.3 peers option (-p)</h4>
-<span id="index-ntpsweep_002dpeers"></span>
+<a name="peers-option-_0028_002dp_0029"></a>
+<h4 class="subsection">1.3 peers option (-p)</h4>
+<a name="index-ntpsweep_002dpeers"></a>
<p>This is the “recursively list all peers a host synchronizes to” option.
This option has no ‘<samp>doc</samp>’ documentation.
</p><hr>
-<span id="ntpsweep-maxlevel"></span><div class="header">
+<a name="ntpsweep-maxlevel"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-strip" accesskey="n" rel="next">ntpsweep strip</a>, Previous: <a href="#ntpsweep-peers" accesskey="p" rel="prev">ntpsweep peers</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="maxlevel-option-_0028_002dm_0029"></span><h4 class="subsection">1.4 maxlevel option (-m)</h4>
-<span id="index-ntpsweep_002dmaxlevel"></span>
+<a name="maxlevel-option-_0028_002dm_0029"></a>
+<h4 class="subsection">1.4 maxlevel option (-m)</h4>
+<a name="index-ntpsweep_002dmaxlevel"></a>
<p>This is the “traverse peers up to this level (4 is a reasonable number)” option.
This option takes a number argument.
This option has no ‘<samp>doc</samp>’ documentation.
</p><hr>
-<span id="ntpsweep-strip"></span><div class="header">
+<a name="ntpsweep-strip"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-host" accesskey="n" rel="next">ntpsweep host</a>, Previous: <a href="#ntpsweep-maxlevel" accesskey="p" rel="prev">ntpsweep maxlevel</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="strip-option-_0028_002ds_0029"></span><h4 class="subsection">1.5 strip option (-s)</h4>
-<span id="index-ntpsweep_002dstrip"></span>
+<a name="strip-option-_0028_002ds_0029"></a>
+<h4 class="subsection">1.5 strip option (-s)</h4>
+<a name="index-ntpsweep_002dstrip"></a>
<p>This is the “strip this string from hostnames” option.
This option takes a string argument.
This option has no ‘<samp>doc</samp>’ documentation.
</p><hr>
-<span id="ntpsweep-host"></span><div class="header">
+<a name="ntpsweep-host"></a>
+<div class="header">
<p>
Next: <a href="#ntpsweep-exit-status" accesskey="n" rel="next">ntpsweep exit status</a>, Previous: <a href="#ntpsweep-strip" accesskey="p" rel="prev">ntpsweep strip</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="host-option-_0028_002dh_0029"></span><h4 class="subsection">1.6 host option (-h)</h4>
-<span id="index-ntpsweep_002dhost"></span>
+<a name="host-option-_0028_002dh_0029"></a>
+<h4 class="subsection">1.6 host option (-h)</h4>
+<a name="index-ntpsweep_002dhost"></a>
<p>This is the “specify a single host” option.
This option takes a string argument.
</p>
<p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong>
</p><hr>
-<span id="ntpsweep-exit-status"></span><div class="header">
+<a name="ntpsweep-exit-status"></a>
+<div class="header">
<p>
Previous: <a href="#ntpsweep-host" accesskey="p" rel="prev">ntpsweep host</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p>
</div>
-<span id="ntpsweep-exit-status-1"></span><h4 class="subsection">1.7 ntpsweep exit status</h4>
+<a name="ntpsweep-exit-status-1"></a>
+<h4 class="subsection">1.7 ntpsweep exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpsweep 1ntpsweepman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntpsweep 1ntpsweepman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:23 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:44 AM by AutoGen 5.18.16
.\" From the definitions ntpsweep-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt NTPSWEEP 1ntpsweepmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpsweep-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:22 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:45 AM by AutoGen 5.18.16
.\" From the definitions ntpsweep-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
#
# EDIT THIS FILE WITH CAUTION (invoke-ntptrace.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:27 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:32:57 AM by AutoGen 5.18.16
# From the definitions ntptrace-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
# EDIT THIS FILE WITH CAUTION (ntptrace-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:25 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:32:55 AM by AutoGen 5.18.16
# From the definitions ntptrace-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntptrace 1ntptraceman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntptrace 1ntptraceman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:28 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:48 AM by AutoGen 5.18.16
.\" From the definitions ntptrace-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPTRACE 1ntptracemdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:25 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:55 AM by AutoGen 5.18.16
.\" From the definitions ntptrace-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Ntptrace User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">Ntptrace User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
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>
</div>
-<span id="Simple-Network-Time-Protocol-User-Manual"></span><h1 class="top">Simple Network Time Protocol User Manual</h1>
+<h1 class="top" id="Simple-Network-Time-Protocol-User-Manual"><span>Simple Network Time Protocol User Manual<a class="copiable-link" href="#Simple-Network-Time-Protocol-User-Manual"> ¶</a></span></h1>
-<p>This document describes the use of the NTP Project’s <code>ntptrace</code> program.
-This document applies to version 4.2.8p17 of <code>ntptrace</code>.
+<p>This document describes the use of the NTP Project’s <code class="code">ntptrace</code> program.
+This document applies to version 4.2.8p17 of <code class="code">ntptrace</code>.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Invoking-ntptrace" href="#toc-Invoking-ntptrace">1 Invoking ntptrace</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Invoking-ntptrace" href="#ntptrace-Invocation">1 Invoking ntptrace</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• ntptrace Description</td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-Invocation" accesskey="2">ntptrace Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntptrace
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="ntptrace-Invocation"></span><div class="header">
+<div class="chapter-level-extent" id="ntptrace-Invocation">
+<div class="nav-panel">
<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Up: <a href="#Top" accesskey="u" rel="up">Simple Network Time Protocol User Manual</a> </p>
</div>
-<span id="Invoking-ntptrace"></span><h2 class="chapter">1 Invoking ntptrace</h2>
-<span id="index-ntptrace"></span>
-<span id="index-Trace-peers-of-an-NTP-server"></span>
+<h2 class="chapter section-level-set-chapter" id="Invoking-ntptrace"><span>1 Invoking ntptrace<a class="copiable-link" href="#Invoking-ntptrace"> ¶</a></span></h2>
+<a class="index-entry-id" id="index-ntptrace"></a>
+<a class="index-entry-id" id="index-Trace-peers-of-an-NTP-server"></a>
-<p><code>ntptrace</code> is a perl script that uses the ntpq utility program to follow
+<p><code class="code">ntptrace</code> is a perl script that uses the ntpq utility program to follow
the chain of NTP servers from a given host back to the primary time source. For
ntptrace to work properly, each of these servers must implement the NTP Control
and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
the output from ntptrace:
</p>
<div class="example">
-<pre class="example">% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
+<pre class="example-preformatted">% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
</pre></div>
<p>On each line, the fields are (left to right): the host name, the host stratum,
the time offset between that host and the local host (as measured by
-<code>ntptrace</code>; this is why it is not always zero for "localhost"), the host
+<code class="code">ntptrace</code>; this is why it is not always zero for "localhost"), the host
synchronization distance, and (only for stratum-1 servers) the reference clock
ID. All times are given in seconds. Note that the stratum is the server hop
count to the primary source, while the synchronization distance is the
defined in RFC-1305.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntptrace</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntptrace</code> program.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntptrace-usage" accesskey="1">ntptrace usage</a></td><td> </td><td align="left" valign="top">ntptrace help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-numeric" accesskey="2">ntptrace numeric</a></td><td> </td><td align="left" valign="top">numeric option (-n)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-max_002dhosts" accesskey="3">ntptrace max-hosts</a></td><td> </td><td align="left" valign="top">max-hosts option (-m)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-host" accesskey="4">ntptrace host</a></td><td> </td><td align="left" valign="top">host option (-r)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-exit-status" accesskey="5">ntptrace exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#ntptrace-usage" accesskey="1">ntptrace help/usage (<samp class="option">--help</samp>)</a></li>
+</ul>
<hr>
-<span id="ntptrace-usage"></span><div class="header">
+<div class="section-level-extent" id="ntptrace-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntptrace-numeric" accesskey="n" rel="next">ntptrace numeric</a>, Up: <a href="#ntptrace-Invocation" accesskey="u" rel="up">ntptrace Invocation</a> </p>
+Up: <a href="#ntptrace-Invocation" accesskey="u" rel="up">Invoking ntptrace</a> </p>
</div>
-<span id="ntptrace-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 ntptrace help/usage (<samp>--help</samp>)</h3>
-<span id="index-ntptrace-help"></span>
+<h3 class="section subsection-level-set-section" id="ntptrace-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1 ntptrace help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntptrace-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntptrace-help"></a>
<p>This is the automatically generated usage text for ntptrace.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntptrace - Trace peers of an NTP server - Ver. 4.2.8p17
+<pre class="example-preformatted">ntptrace - Trace peers of an NTP server - Ver. 4.2.8p17
USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host]
-n, --numeric Print IP addresses instead of hostnames
hyphen and the flag character.
</pre></div>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntptrace-numeric" accesskey="1">numeric option (-n)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-max_002dhosts" accesskey="2">max-hosts option (-m)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-host" accesskey="3">host option (-r)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntptrace-exit-status" accesskey="4">ntptrace exit status</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#ntptrace-numeric" accesskey="1">numeric option (-n)</a></li>
+<li><a href="#ntptrace-max_002dhosts" accesskey="2">max-hosts option (-m)</a></li>
+<li><a href="#ntptrace-host" accesskey="3">host option (-r)</a></li>
+<li><a href="#ntptrace-exit-status" accesskey="4">ntptrace exit status</a></li>
+</ul>
<hr>
-<span id="ntptrace-numeric"></span><div class="header">
+<div class="subsection-level-extent" id="ntptrace-numeric">
+<div class="nav-panel">
<p>
-Next: <a href="#ntptrace-max_002dhosts" accesskey="n" rel="next">ntptrace max-hosts</a>, Previous: <a href="#ntptrace-usage" accesskey="p" rel="prev">ntptrace usage</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace usage</a> </p>
+Next: <a href="#ntptrace-max_002dhosts" accesskey="n" rel="next">max-hosts option (-m)</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace help/usage (<samp class="option">--help</samp>)</a> </p>
</div>
-<span id="numeric-option-_0028_002dn_0029"></span><h4 class="subsection">1.1.1 numeric option (-n)</h4>
-<span id="index-ntptrace_002dnumeric"></span>
+<h4 class="subsection" id="numeric-option-_0028_002dn_0029"><span>1.1.1 numeric option (-n)<a class="copiable-link" href="#numeric-option-_0028_002dn_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntptrace_002dnumeric"></a>
<p>This is the “print ip addresses instead of hostnames” option.
Output hosts as dotted-quad numeric format rather than converting to
the canonical host names.
</p><hr>
-<span id="ntptrace-max_002dhosts"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntptrace-max_002dhosts">
+<div class="nav-panel">
<p>
-Next: <a href="#ntptrace-host" accesskey="n" rel="next">ntptrace host</a>, Previous: <a href="#ntptrace-numeric" accesskey="p" rel="prev">ntptrace numeric</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace usage</a> </p>
+Next: <a href="#ntptrace-host" accesskey="n" rel="next">host option (-r)</a>, Previous: <a href="#ntptrace-numeric" accesskey="p" rel="prev">numeric option (-n)</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace help/usage (<samp class="option">--help</samp>)</a> </p>
</div>
-<span id="max_002dhosts-option-_0028_002dm_0029"></span><h4 class="subsection">1.1.2 max-hosts option (-m)</h4>
-<span id="index-ntptrace_002dmax_002dhosts"></span>
+<h4 class="subsection" id="max_002dhosts-option-_0028_002dm_0029"><span>1.1.2 max-hosts option (-m)<a class="copiable-link" href="#max_002dhosts-option-_0028_002dm_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntptrace_002dmax_002dhosts"></a>
<p>This is the “maximum number of peers to trace” option.
This option takes a number argument.
-This option has no ‘<samp>doc</samp>’ documentation.
+This option has no ‘<samp class="samp">doc</samp>’ documentation.
</p><hr>
-<span id="ntptrace-host"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntptrace-host">
+<div class="nav-panel">
<p>
-Next: <a href="#ntptrace-exit-status" accesskey="n" rel="next">ntptrace exit status</a>, Previous: <a href="#ntptrace-max_002dhosts" accesskey="p" rel="prev">ntptrace max-hosts</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace usage</a> </p>
+Next: <a href="#ntptrace-exit-status" accesskey="n" rel="next">ntptrace exit status</a>, Previous: <a href="#ntptrace-max_002dhosts" accesskey="p" rel="prev">max-hosts option (-m)</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace help/usage (<samp class="option">--help</samp>)</a> </p>
</div>
-<span id="host-option-_0028_002dr_0029"></span><h4 class="subsection">1.1.3 host option (-r)</h4>
-<span id="index-ntptrace_002dhost"></span>
+<h4 class="subsection" id="host-option-_0028_002dr_0029"><span>1.1.3 host option (-r)<a class="copiable-link" href="#host-option-_0028_002dr_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntptrace_002dhost"></a>
<p>This is the “single remote host” option.
This option takes a string argument.
-This option has no ‘<samp>doc</samp>’ documentation.
+This option has no ‘<samp class="samp">doc</samp>’ documentation.
</p><hr>
-<span id="ntptrace-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntptrace-exit-status">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntptrace-host" accesskey="p" rel="prev">ntptrace host</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace usage</a> </p>
+Previous: <a href="#ntptrace-host" accesskey="p" rel="prev">host option (-r)</a>, Up: <a href="#ntptrace-usage" accesskey="u" rel="up">ntptrace help/usage (<samp class="option">--help</samp>)</a> </p>
</div>
-<span id="ntptrace-exit-status-1"></span><h4 class="subsection">1.1.4 ntptrace exit status</h4>
+<h4 class="subsection" id="ntptrace-exit-status-1"><span>1.1.4 ntptrace exit status<a class="copiable-link" href="#ntptrace-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
</dl>
-<hr>
+</div>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntptrace @NTPTRACE_MS@ "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntptrace @NTPTRACE_MS@ "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:28 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:48 AM by AutoGen 5.18.16
.\" From the definitions ntptrace-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTPTRACE @NTPTRACE_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:25 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:55 AM by AutoGen 5.18.16
.\" From the definitions ntptrace-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
# EDIT THIS FILE WITH CAUTION (plot_summary-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:35 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:33:00 AM by AutoGen 5.18.16
# From the definitions plot_summary-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH plot_summary 1plot_summaryman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH plot_summary 1plot_summaryman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:37 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:28 AM by AutoGen 5.18.16
.\" From the definitions plot_summary-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:38 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:30 AM by AutoGen 5.18.16
.\" From the definitions plot_summary-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Plot_summary User’s Manual</title>
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
-<span id="Top"></span><div class="header">
+<a name="Top"></a>
+<div class="header">
<p>
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>
</div>
-<span id="Plot_005fsummary-User-Manual"></span><h1 class="top">Plot_summary User Manual</h1>
+<a name="Plot_005fsummary-User-Manual"></a>
+<h1 class="top">Plot_summary User Manual</h1>
<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program.
This document applies to version 4.2.8p17 of <code>plot_summary</code>.
</p>
-<span id="SEC_Overview"></span>
+<a name="SEC_Overview"></a>
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
<ul class="no-bullet">
-<li><a id="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li>
+<li><a name="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li>
</ul>
</div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• plot_summary Description</td><td> </td><td align="left" valign="top">Description
+<tr><td align="left" valign="top">• plot_summary Description:</td><td> </td><td align="left" valign="top">Description
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-Invocation" accesskey="2">plot_summary Invocation</a></td><td> </td><td align="left" valign="top">Invoking plot_summary
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-Invocation" accesskey="2">plot_summary Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking plot_summary
</td></tr>
</table>
<hr>
-<span id="plot_005fsummary-Invocation"></span><div class="header">
+<a name="plot_005fsummary-Invocation"></a>
+<div class="header">
<p>
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
</div>
-<span id="Invoking-plot_005fsummary"></span><h2 class="chapter">1 Invoking plot_summary</h2>
-<span id="index-plot_005fsummary"></span>
-<span id="index-plot-statistics-generated-by-summary-script"></span>
+<a name="Invoking-plot_005fsummary"></a>
+<h2 class="chapter">1 Invoking plot_summary</h2>
+<a name="index-plot_005fsummary"></a>
+<a name="index-plot-statistics-generated-by-summary-script"></a>
<p>This section was generated by <strong>AutoGen</strong>,
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-usage" accesskey="1">plot_summary usage</a></td><td> </td><td align="left" valign="top">plot_summary help/usage (<samp>--help</samp>)
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-usage" accesskey="1">plot_summary usage</a>:</td><td> </td><td align="left" valign="top">plot_summary help/usage (<samp>--help</samp>)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="2">plot_summary directory</a></td><td> </td><td align="left" valign="top">directory option
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="2">plot_summary directory</a>:</td><td> </td><td align="left" valign="top">directory option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="3">plot_summary identifier</a></td><td> </td><td align="left" valign="top">identifier option
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="3">plot_summary identifier</a>:</td><td> </td><td align="left" valign="top">identifier option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="4">plot_summary peer</a></td><td> </td><td align="left" valign="top">peer option
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="4">plot_summary peer</a>:</td><td> </td><td align="left" valign="top">peer option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="5">plot_summary plot-term</a></td><td> </td><td align="left" valign="top">plot-term option
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="5">plot_summary plot-term</a>:</td><td> </td><td align="left" valign="top">plot-term option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="6">plot_summary output-file</a></td><td> </td><td align="left" valign="top">output-file option
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="6">plot_summary output-file</a>:</td><td> </td><td align="left" valign="top">output-file option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="7">plot_summary exit status</a></td><td> </td><td align="left" valign="top">exit status
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="7">plot_summary exit status</a>:</td><td> </td><td align="left" valign="top">exit status
</td></tr>
</table>
<hr>
-<span id="plot_005fsummary-usage"></span><div class="header">
+<a name="plot_005fsummary-usage"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-directory" accesskey="n" rel="next">plot_summary directory</a>, Up: <a href="#plot_005fsummary-Invocation" accesskey="u" rel="up">plot_summary Invocation</a> </p>
</div>
-<span id="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3>
-<span id="index-plot_005fsummary-help"></span>
+<a name="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></a>
+<h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3>
+<a name="index-plot_005fsummary-help"></a>
<p>This is the automatically generated usage text for plot_summary.
</p>
</pre></div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">plot_summary directory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">identifier option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">plot_summary identifier</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">peer option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">plot_summary peer</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="4">plot-term option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="4">plot_summary plot-term</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="5">output-file option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="5">plot_summary output-file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="6">plot_summary exit status</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="6">plot_summary exit status</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
-<span id="plot_005fsummary-directory"></span><div class="header">
+<a name="plot_005fsummary-directory"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-identifier" accesskey="n" rel="next">plot_summary identifier</a>, Previous: <a href="#plot_005fsummary-usage" accesskey="p" rel="prev">plot_summary usage</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4>
-<span id="index-plot_005fsummary_002ddirectory"></span>
+<a name="directory-option"></a>
+<h4 class="subsection">1.1.1 directory option</h4>
+<a name="index-plot_005fsummary_002ddirectory"></a>
<p>This is the “where the summary files are” option.
This option takes a string argument.
The directory where the <code>plot_summary</code> will search for the
*_summary files generated by <code>summary</code> script.
</p><hr>
-<span id="plot_005fsummary-identifier"></span><div class="header">
+<a name="plot_005fsummary-identifier"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-peer" accesskey="n" rel="next">plot_summary peer</a>, Previous: <a href="#plot_005fsummary-directory" accesskey="p" rel="prev">plot_summary directory</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="identifier-option"></span><h4 class="subsection">1.1.2 identifier option</h4>
-<span id="index-plot_005fsummary_002didentifier"></span>
+<a name="identifier-option"></a>
+<h4 class="subsection">1.1.2 identifier option</h4>
+<a name="index-plot_005fsummary_002didentifier"></a>
<p>This is the “origin of the data” option.
This option takes a string argument.
Where does the plotted data come from, default to string "host" plus
current hostname
</p><hr>
-<span id="plot_005fsummary-peer"></span><div class="header">
+<a name="plot_005fsummary-peer"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-plot_002dterm" accesskey="n" rel="next">plot_summary plot-term</a>, Previous: <a href="#plot_005fsummary-identifier" accesskey="p" rel="prev">plot_summary identifier</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="peer-option"></span><h4 class="subsection">1.1.3 peer option</h4>
-<span id="index-plot_005fsummary_002dpeer"></span>
+<a name="peer-option"></a>
+<h4 class="subsection">1.1.3 peer option</h4>
+<a name="index-plot_005fsummary_002dpeer"></a>
<p>This is the “peers to generate plots for” option.
This option takes a string argument.
<p>By default the peer_summary plots are not generated. Use this option to
specify list of peers if you want to generate plots for them.
</p><hr>
-<span id="plot_005fsummary-plot_002dterm"></span><div class="header">
+<a name="plot_005fsummary-plot_002dterm"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-output_002dfile" accesskey="n" rel="next">plot_summary output-file</a>, Previous: <a href="#plot_005fsummary-peer" accesskey="p" rel="prev">plot_summary peer</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="plot_002dterm-option"></span><h4 class="subsection">1.1.4 plot-term option</h4>
-<span id="index-plot_005fsummary_002dplot_002dterm"></span>
+<a name="plot_002dterm-option"></a>
+<h4 class="subsection">1.1.4 plot-term option</h4>
+<a name="index-plot_005fsummary_002dplot_002dterm"></a>
<p>This is the “gnuplot terminal” option.
This option takes a string argument.
<code>dumb</code> is it’s not’. See output from (gnuplot -e "set
terminal") for the list of available options.
</p><hr>
-<span id="plot_005fsummary-output_002dfile"></span><div class="header">
+<a name="plot_005fsummary-output_002dfile"></a>
+<div class="header">
<p>
Next: <a href="#plot_005fsummary-exit-status" accesskey="n" rel="next">plot_summary exit status</a>, Previous: <a href="#plot_005fsummary-plot_002dterm" accesskey="p" rel="prev">plot_summary plot-term</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="output_002dfile-option"></span><h4 class="subsection">1.1.5 output-file option</h4>
-<span id="index-plot_005fsummary_002doutput_002dfile"></span>
+<a name="output_002dfile-option"></a>
+<h4 class="subsection">1.1.5 output-file option</h4>
+<a name="index-plot_005fsummary_002doutput_002dfile"></a>
<p>This is the “output file” option.
This option takes a str argument.
Output file for <code>gnuplot</code>, default to stdout.
</p><hr>
-<span id="plot_005fsummary-exit-status"></span><div class="header">
+<a name="plot_005fsummary-exit-status"></a>
+<div class="header">
<p>
Previous: <a href="#plot_005fsummary-output_002dfile" accesskey="p" rel="prev">plot_summary output-file</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> </p>
</div>
-<span id="plot_005fsummary-exit-status-1"></span><h4 class="subsection">1.1.6 plot_summary exit status</h4>
+<a name="plot_005fsummary-exit-status-1"></a>
+<h4 class="subsection">1.1.6 plot_summary exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH plot_summary 1plot_summaryman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH plot_summary 1plot_summaryman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:37 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:28 AM by AutoGen 5.18.16
.\" From the definitions plot_summary-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:38 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:30 AM by AutoGen 5.18.16
.\" From the definitions plot_summary-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
# EDIT THIS FILE WITH CAUTION (summary-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:35 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:33:00 AM by AutoGen 5.18.16
# From the definitions summary-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH summary 1summaryman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH summary 1summaryman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:41 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:33 AM by AutoGen 5.18.16
.\" From the definitions summary-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt SUMMARY 1summarymdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:43 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:34 AM by AutoGen 5.18.16
.\" From the definitions summary-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Summary User’s Manual</title>
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
-<span id="Top"></span><div class="header">
+<a name="Top"></a>
+<div class="header">
<p>
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>
</div>
-<span id="Summary-User-Manual"></span><h1 class="top">Summary User Manual</h1>
+<a name="Summary-User-Manual"></a>
+<h1 class="top">Summary User Manual</h1>
<p>This document describes the use of the NTP Project’s <code>summary</code> program.
This document applies to version 4.2.8p17 of <code>summary</code>.
</p>
-<span id="SEC_Overview"></span>
+<a name="SEC_Overview"></a>
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
<ul class="no-bullet">
-<li><a id="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li>
+<li><a name="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li>
</ul>
</div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• summary Description</td><td> </td><td align="left" valign="top">Description
+<tr><td align="left" valign="top">• summary Description:</td><td> </td><td align="left" valign="top">Description
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-Invocation" accesskey="2">summary Invocation</a></td><td> </td><td align="left" valign="top">Invoking summary
+<tr><td align="left" valign="top">• <a href="#summary-Invocation" accesskey="2">summary Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking summary
</td></tr>
</table>
<hr>
-<span id="summary-Invocation"></span><div class="header">
+<a name="summary-Invocation"></a>
+<div class="header">
<p>
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
</div>
-<span id="Invoking-summary"></span><h2 class="chapter">1 Invoking summary</h2>
-<span id="index-summary"></span>
-<span id="index-compute-various-stastics-from-NTP-stat-files"></span>
+<a name="Invoking-summary"></a>
+<h2 class="chapter">1 Invoking summary</h2>
+<a name="index-summary"></a>
+<a name="index-compute-various-stastics-from-NTP-stat-files"></a>
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#summary-usage" accesskey="1">summary usage</a></td><td> </td><td align="left" valign="top">summary help/usage (<samp>--help</samp>)
+<tr><td align="left" valign="top">• <a href="#summary-usage" accesskey="1">summary usage</a>:</td><td> </td><td align="left" valign="top">summary help/usage (<samp>--help</samp>)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="2">summary directory</a></td><td> </td><td align="left" valign="top">directory option
+<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="2">summary directory</a>:</td><td> </td><td align="left" valign="top">directory option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="3">summary end-date</a></td><td> </td><td align="left" valign="top">end-date option
+<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="3">summary end-date</a>:</td><td> </td><td align="left" valign="top">end-date option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a></td><td> </td><td align="left" valign="top">output-directory option
+<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a>:</td><td> </td><td align="left" valign="top">output-directory option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="5">summary start-date</a></td><td> </td><td align="left" valign="top">start-date option
+<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="5">summary start-date</a>:</td><td> </td><td align="left" valign="top">start-date option
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="6">summary exit status</a></td><td> </td><td align="left" valign="top">exit status
+<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="6">summary exit status</a>:</td><td> </td><td align="left" valign="top">exit status
</td></tr>
</table>
<hr>
-<span id="summary-usage"></span><div class="header">
+<a name="summary-usage"></a>
+<div class="header">
<p>
Next: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> </p>
</div>
-<span id="summary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3>
-<span id="index-summary-help"></span>
+<a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a>
+<h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3>
+<a name="index-summary-help"></a>
<p>This is the automatically generated usage text for summary.
</p>
</pre></div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">end-date option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">summary end-date</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">output-directory option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">summary output-directory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">start-date option</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">summary start-date</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
-<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="5">summary exit status</a></td><td> </td><td align="left" valign="top">
+<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="5">summary exit status</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
-<span id="summary-directory"></span><div class="header">
+<a name="summary-directory"></a>
+<div class="header">
<p>
Next: <a href="#summary-end_002ddate" accesskey="n" rel="next">summary end-date</a>, Previous: <a href="#summary-usage" accesskey="p" rel="prev">summary usage</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p>
</div>
-<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4>
-<span id="index-summary_002ddirectory"></span>
+<a name="directory-option"></a>
+<h4 class="subsection">1.1.1 directory option</h4>
+<a name="index-summary_002ddirectory"></a>
<p>This is the “directory containing stat files” option.
This option takes a string argument.
The directory where <code>ntpd</code> will search for .stat files generated
by <code>ntpd</code>.
</p><hr>
-<span id="summary-end_002ddate"></span><div class="header">
+<a name="summary-end_002ddate"></a>
+<div class="header">
<p>
Next: <a href="#summary-output_002ddirectory" accesskey="n" rel="next">summary output-directory</a>, Previous: <a href="#summary-directory" accesskey="p" rel="prev">summary directory</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p>
</div>
-<span id="end_002ddate-option"></span><h4 class="subsection">1.1.2 end-date option</h4>
-<span id="index-summary_002dend_002ddate"></span>
+<a name="end_002ddate-option"></a>
+<h4 class="subsection">1.1.2 end-date option</h4>
+<a name="index-summary_002dend_002ddate"></a>
<p>This is the “end date” option.
This option takes a number argument.
option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>)
to get the timestamp.
</p><hr>
-<span id="summary-output_002ddirectory"></span><div class="header">
+<a name="summary-output_002ddirectory"></a>
+<div class="header">
<p>
Next: <a href="#summary-start_002ddate" accesskey="n" rel="next">summary start-date</a>, Previous: <a href="#summary-end_002ddate" accesskey="p" rel="prev">summary end-date</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p>
</div>
-<span id="output_002ddirectory-option"></span><h4 class="subsection">1.1.3 output-directory option</h4>
-<span id="index-summary_002doutput_002ddirectory"></span>
+<a name="output_002ddirectory-option"></a>
+<h4 class="subsection">1.1.3 output-directory option</h4>
+<a name="index-summary_002doutput_002ddirectory"></a>
<p>This is the “output directory” option.
This option takes a str argument.
The output directory <code>summary</code> will write all output files to.
</p><hr>
-<span id="summary-start_002ddate"></span><div class="header">
+<a name="summary-start_002ddate"></a>
+<div class="header">
<p>
Next: <a href="#summary-exit-status" accesskey="n" rel="next">summary exit status</a>, Previous: <a href="#summary-output_002ddirectory" accesskey="p" rel="prev">summary output-directory</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p>
</div>
-<span id="start_002ddate-option"></span><h4 class="subsection">1.1.4 start-date option</h4>
-<span id="index-summary_002dstart_002ddate"></span>
+<a name="start_002ddate-option"></a>
+<h4 class="subsection">1.1.4 start-date option</h4>
+<a name="index-summary_002dstart_002ddate"></a>
<p>This is the “start date” option.
This option takes a num argument.
Process all files with the date suffix more or equal to value of
this option. Defaults to 197000101.
</p><hr>
-<span id="summary-exit-status"></span><div class="header">
+<a name="summary-exit-status"></a>
+<div class="header">
<p>
Previous: <a href="#summary-start_002ddate" accesskey="p" rel="prev">summary start-date</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p>
</div>
-<span id="summary-exit-status-1"></span><h4 class="subsection">1.1.5 summary exit status</h4>
+<a name="summary-exit-status-1"></a>
+<h4 class="subsection">1.1.5 summary exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH summary 1summaryman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH summary 1summaryman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:41 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:33 AM by AutoGen 5.18.16
.\" From the definitions summary-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 6 2024
.Dt SUMMARY 1summarymdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:43 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 03:50:34 AM by AutoGen 5.18.16
.\" From the definitions summary-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
#
# EDIT THIS FILE WITH CAUTION (invoke-update-leap.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:31 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 11:32:37 PM by AutoGen 5.18.16
# From the definitions update-leap-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
# EDIT THIS FILE WITH CAUTION (update-leap-opts)
#
-# It has been AutoGen-ed June 6, 2023 at 04:39:35 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 6, 2024 at 11:32:40 PM by AutoGen 5.18.16
# From the definitions update-leap-opts.def
# and the template file perlopt
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH update-leap 1update-leapman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH update-leap 1update-leapman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:33 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 11:32:39 PM by AutoGen 5.18.16
.\" From the definitions update-leap-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt UPDATE_LEAP 1update-leapmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (update-leap-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:30 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:59 AM by AutoGen 5.18.16
.\" From the definitions update-leap-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>update-leap User’s Manual</title>
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
-<span id="Top"></span><div class="header">
+<a name="Top"></a>
+<div class="header">
<p>
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>
</div>
</p>
<p>This document applies to version 4.2.8p17 of <code>update-leap</code>.
</p>
-<span id="SEC_Overview"></span>
+<a name="SEC_Overview"></a>
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<li><a id="stoc-Invoking-update_002dleap" href="#toc-Invoking-update_002dleap">1 Invoking update-leap</a></li>
+<li><a name="stoc-Invoking-update_002dleap" href="#toc-Invoking-update_002dleap">1 Invoking update-leap</a></li>
</div>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• update-leap Description</td><td> </td><td align="left" valign="top">Description
+<tr><td align="left" valign="top">• update-leap Description:</td><td> </td><td align="left" valign="top">Description
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-Invocation" accesskey="2">update-leap Invocation</a></td><td> </td><td align="left" valign="top">Invoking update-leap
+<tr><td align="left" valign="top">• <a href="#update_002dleap-Invocation" accesskey="2">update-leap Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking update-leap
</td></tr>
</table>
<hr>
-<span id="update_002dleap-Invocation"></span><div class="header">
+<a name="update_002dleap-Invocation"></a>
+<div class="header">
<p>
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
</div>
-<span id="Invoking-update_002dleap"></span><h3 class="section">1 Invoking update-leap</h3>
-<span id="index-update_002dleap"></span>
-<span id="index-leap_002dseconds-file-manager_002fupdater"></span>
+<a name="Invoking-update_002dleap"></a>
+<h3 class="section">1 Invoking update-leap</h3>
+<a name="index-update_002dleap"></a>
+<a name="index-leap_002dseconds-file-manager_002fupdater"></a>
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>update-leap</code> program.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#update_002dleap-usage" accesskey="1">update-leap usage</a></td><td> </td><td align="left" valign="top">update-leap help/usage (<samp>--help</samp>)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-usage" accesskey="1">update-leap usage</a>:</td><td> </td><td align="left" valign="top">update-leap help/usage (<samp>--help</samp>)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-source_002durl" accesskey="2">update-leap source-url</a></td><td> </td><td align="left" valign="top">source-url option (-s)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-source_002durl" accesskey="2">update-leap source-url</a>:</td><td> </td><td align="left" valign="top">source-url option (-s)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-ipv4" accesskey="3">update-leap ipv4</a></td><td> </td><td align="left" valign="top">ipv4 option (-4)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-ipv4" accesskey="3">update-leap ipv4</a>:</td><td> </td><td align="left" valign="top">ipv4 option (-4)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-destination" accesskey="4">update-leap destination</a></td><td> </td><td align="left" valign="top">destination option (-d)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-destination" accesskey="4">update-leap destination</a>:</td><td> </td><td align="left" valign="top">destination option (-d)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-expiration" accesskey="5">update-leap expiration</a></td><td> </td><td align="left" valign="top">expiration option (-e)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-expiration" accesskey="5">update-leap expiration</a>:</td><td> </td><td align="left" valign="top">expiration option (-e)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-ntp_002dconf_002dfile" accesskey="6">update-leap ntp-conf-file</a></td><td> </td><td align="left" valign="top">ntp-conf-file option (-f)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-ntp_002dconf_002dfile" accesskey="6">update-leap ntp-conf-file</a>:</td><td> </td><td align="left" valign="top">ntp-conf-file option (-f)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-force_002dupdate" accesskey="7">update-leap force-update</a></td><td> </td><td align="left" valign="top">force-update option (-F)
+<tr><td align="left" valign="top">• <a href="#update_002dleap-force_002dupdate" accesskey="7">update-leap force-update</a>:</td><td> </td><td align="left" valign="top">force-update option (-F)
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-exit-status" accesskey="8">update-leap exit status</a></td><td> </td><td align="left" valign="top">exit status
+<tr><td align="left" valign="top">• <a href="#update_002dleap-exit-status" accesskey="8">update-leap exit status</a>:</td><td> </td><td align="left" valign="top">exit status
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-Usage" accesskey="9">update-leap Usage</a></td><td> </td><td align="left" valign="top">Usage
+<tr><td align="left" valign="top">• <a href="#update_002dleap-Usage" accesskey="9">update-leap Usage</a>:</td><td> </td><td align="left" valign="top">Usage
</td></tr>
-<tr><td align="left" valign="top">• <a href="#update_002dleap-Authors">update-leap Authors</a></td><td> </td><td align="left" valign="top">Authors
+<tr><td align="left" valign="top">• <a href="#update_002dleap-Authors">update-leap Authors</a>:</td><td> </td><td align="left" valign="top">Authors
</td></tr>
</table>
<hr>
-<span id="update_002dleap-usage"></span><div class="header">
+<a name="update_002dleap-usage"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-source_002durl" accesskey="n" rel="next">update-leap source-url</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="update_002dleap-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1 update-leap help/usage (<samp>--help</samp>)</h4>
-<span id="index-update_002dleap-help"></span>
+<a name="update_002dleap-help_002fusage-_0028_002d_002dhelp_0029"></a>
+<h4 class="subsection">1.1 update-leap help/usage (<samp>--help</samp>)</h4>
+<a name="index-update_002dleap-help"></a>
<p>This is the automatically generated usage text for update-leap.
</p>
</pre></div>
<hr>
-<span id="update_002dleap-source_002durl"></span><div class="header">
+<a name="update_002dleap-source_002durl"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-ipv4" accesskey="n" rel="next">update-leap ipv4</a>, Previous: <a href="#update_002dleap-usage" accesskey="p" rel="prev">update-leap usage</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="source_002durl-option-_0028_002ds_0029"></span><h4 class="subsection">1.2 source-url option (-s)</h4>
-<span id="index-update_002dleap_002dsource_002durl"></span>
+<a name="source_002durl-option-_0028_002ds_0029"></a>
+<h4 class="subsection">1.2 source-url option (-s)</h4>
+<a name="index-update_002dleap_002dsource_002durl"></a>
<p>This is the “the url of the master copy of the leapseconds file” option.
This option takes a string argument.
Specify the URL of the master copy to download
$LEAPSRC
</p><hr>
-<span id="update_002dleap-ipv4"></span><div class="header">
+<a name="update_002dleap-ipv4"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-destination" accesskey="n" rel="next">update-leap destination</a>, Previous: <a href="#update_002dleap-source_002durl" accesskey="p" rel="prev">update-leap source-url</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.3 ipv4 option (-4)</h4>
-<span id="index-update_002dleap_002dipv4"></span>
+<a name="ipv4-option-_0028_002d4_0029"></a>
+<h4 class="subsection">1.3 ipv4 option (-4)</h4>
+<a name="index-update_002dleap_002dipv4"></a>
<p>This is the “use only ipv4 addresses for dns name resolution” option.
</p>
doc = <<- _EndOfDoc_
Prefer IPv4 or IPv6 (as specified) addresses, but use either.
</p><hr>
-<span id="update_002dleap-destination"></span><div class="header">
+<a name="update_002dleap-destination"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-expiration" accesskey="n" rel="next">update-leap expiration</a>, Previous: <a href="#update_002dleap-ipv4" accesskey="p" rel="prev">update-leap ipv4</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="destination-option-_0028_002dd_0029"></span><h4 class="subsection">1.4 destination option (-d)</h4>
-<span id="index-update_002dleap_002ddestination"></span>
+<a name="destination-option-_0028_002dd_0029"></a>
+<h4 class="subsection">1.4 destination option (-d)</h4>
+<a name="index-update_002dleap_002ddestination"></a>
<p>This is the “filename on the local system” option.
This option takes a string argument <samp>float</samp>.
The name to use to store the leapfile on the local system.
$LEAPFILE
</p><hr>
-<span id="update_002dleap-expiration"></span><div class="header">
+<a name="update_002dleap-expiration"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-ntp_002dconf_002dfile" accesskey="n" rel="next">update-leap ntp-conf-file</a>, Previous: <a href="#update_002dleap-destination" accesskey="p" rel="prev">update-leap destination</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="expiration-option-_0028_002de_0029"></span><h4 class="subsection">1.5 expiration option (-e)</h4>
-<span id="index-update_002dleap_002dexpiration"></span>
+<a name="expiration-option-_0028_002de_0029"></a>
+<h4 class="subsection">1.5 expiration option (-e)</h4>
+<a name="index-update_002dleap_002dexpiration"></a>
<p>This is the “refresh the leapfile this long before it expires” option.
This option takes a string argument.
imply more frequent refreshes.
"$PREFETCH"
</p><hr>
-<span id="update_002dleap-ntp_002dconf_002dfile"></span><div class="header">
+<a name="update_002dleap-ntp_002dconf_002dfile"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-force_002dupdate" accesskey="n" rel="next">update-leap force-update</a>, Previous: <a href="#update_002dleap-expiration" accesskey="p" rel="prev">update-leap expiration</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="ntp_002dconf_002dfile-option-_0028_002df_0029"></span><h4 class="subsection">1.6 ntp-conf-file option (-f)</h4>
-<span id="index-update_002dleap_002dntp_002dconf_002dfile"></span>
+<a name="ntp_002dconf_002dfile-option-_0028_002df_0029"></a>
+<h4 class="subsection">1.6 ntp-conf-file option (-f)</h4>
+<a name="index-update_002dleap_002dntp_002dconf_002dfile"></a>
<p>This is the “location of the ntp.conf file” option.
This option takes a string argument.
present and to default leapfile)
/etc/ntp.conf
</p><hr>
-<span id="update_002dleap-force_002dupdate"></span><div class="header">
+<a name="update_002dleap-force_002dupdate"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-exit-status" accesskey="n" rel="next">update-leap exit status</a>, Previous: <a href="#update_002dleap-ntp_002dconf_002dfile" accesskey="p" rel="prev">update-leap ntp-conf-file</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="force_002dupdate-option-_0028_002dF_0029"></span><h4 class="subsection">1.7 force-update option (-F)</h4>
-<span id="index-update_002dleap_002dforce_002dupdate"></span>
+<a name="force_002dupdate-option-_0028_002dF_0029"></a>
+<h4 class="subsection">1.7 force-update option (-F)</h4>
+<a name="index-update_002dleap_002dforce_002dupdate"></a>
<p>This is the “force update of the leapfile” option.
Force update even if current file is OK and not close to expiring.
</p><hr>
-<span id="update_002dleap-exit-status"></span><div class="header">
+<a name="update_002dleap-exit-status"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-Usage" accesskey="n" rel="next">update-leap Usage</a>, Previous: <a href="#update_002dleap-force_002dupdate" accesskey="p" rel="prev">update-leap force-update</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="update_002dleap-exit-status-1"></span><h4 class="subsection">1.8 update-leap exit status</h4>
+<a name="update_002dleap-exit-status-1"></a>
+<h4 class="subsection">1.8 update-leap exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
</p></dd>
</dl>
<hr>
-<span id="update_002dleap-Usage"></span><div class="header">
+<a name="update_002dleap-Usage"></a>
+<div class="header">
<p>
Next: <a href="#update_002dleap-Authors" accesskey="n" rel="next">update-leap Authors</a>, Previous: <a href="#update_002dleap-exit-status" accesskey="p" rel="prev">update-leap exit status</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="update_002dleap-Usage-1"></span><h4 class="subsection">1.9 update-leap Usage</h4>
+<a name="update_002dleap-Usage-1"></a>
+<h4 class="subsection">1.9 update-leap Usage</h4>
<hr>
-<span id="update_002dleap-Authors"></span><div class="header">
+<a name="update_002dleap-Authors"></a>
+<div class="header">
<p>
Previous: <a href="#update_002dleap-Usage" accesskey="p" rel="prev">update-leap Usage</a>, Up: <a href="#update_002dleap-Invocation" accesskey="u" rel="up">update-leap Invocation</a> </p>
</div>
-<span id="update_002dleap-Authors-1"></span><h4 class="subsection">1.10 update-leap Authors</h4>
+<a name="update_002dleap-Authors-1"></a>
+<h4 class="subsection">1.10 update-leap Authors</h4>
<hr>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH update-leap 1update-leapman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH update-leap 1update-leapman "06 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:33 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 6, 2024 at 11:32:39 PM by AutoGen 5.18.16
.\" From the definitions update-leap-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-.Dd June 6 2023
+.Dd January 7 2024
.Dt UPDATE_LEAP 1update-leapmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (update-leap-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:39:30 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:32:59 AM by AutoGen 5.18.16
.\" From the definitions update-leap-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
/* -*- Mode: Text -*- */
copyright = {
- date = "1992-2023";
+ date = "1992-2024";
owner = "The University of Delaware and Network Time Foundation";
eaddr = "https://bugs.ntp.org, bugs@ntp.org";
type = ntp;
#
# EDIT THIS FILE WITH CAUTION (invoke-sntp.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:36:12 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:33:44 AM by AutoGen 5.18.16
# From the definitions sntp-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
/*
* EDIT THIS FILE WITH CAUTION (sntp-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:35:52 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:33:32 AM by AutoGen 5.18.16
* From the definitions sntp-opts.def
* and the template file options
*
* The sntp program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const sntp_opt_strs[2567] =
/* 0 */ "sntp 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via sntpOptions.pzCopyright */
puts(_("sntp 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (sntp-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:35:52 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:33:32 AM by AutoGen 5.18.16
* From the definitions sntp-opts.def
* and the template file options
*
* The sntp program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH sntp 1sntpman "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH sntp 1sntpman "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:36:14 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:33:46 AM by AutoGen 5.18.16
.\" From the definitions sntp-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.NOP "Dave Hart"
.br
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt SNTP 1sntpmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (sntp-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:36:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:33:42 AM by AutoGen 5.18.16
.\" From the definitions sntp-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.An "Harlan Stenn"
.An "Dave Hart"
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Sntp User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#sntp-Description" rel="next" title="sntp Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">Sntp User’s Manual</h1>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-Description" accesskey="n" rel="next">
sntp 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>
+Next: <a href="#sntp-Description" accesskey="n" rel="next">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>
</div>
-<span id="Simple-Network-Time-Protocol-User-Manual"></span><h1 class="top">Simple Network Time Protocol User Manual</h1>
+<h1 class="top" id="Simple-Network-Time-Protocol-User-Manual"><span>Simple Network Time Protocol User Manual<a class="copiable-link" href="#Simple-Network-Time-Protocol-User-Manual"> ¶</a></span></h1>
-<p>This document describes the use of the NTP Project’s <code>sntp</code> program,
+<p>This document describes the use of the NTP Project’s <code class="code">sntp</code> program,
that can be used to query a Network Time Protocol (NTP) server and
display the time offset of the system clock relative to the server
clock. Run as root, it can correct the system clock to this offset as
well. It can be run as an interactive command or from a cron job.
</p>
-<p>This document applies to version 4.2.8p17 of <code>sntp</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">sntp</code>.
</p>
<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
IETF specification.
</p>
-<span id="SEC_Overview"></span>
+
+
+<div class="element-shortcontents" id="SEC_Shortcontents">
<h2 class="shortcontents-heading">Short Table of Contents</h2>
<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description" href="#sntp-Description">1 Description</a></li>
</ul>
</div>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#sntp-Description" accesskey="1">sntp Description</a></td><td> </td><td align="left" valign="top">Description
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-Invocation" accesskey="2">sntp Invocation</a></td><td> </td><td align="left" valign="top">Invoking sntp
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="3">Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-</table>
-
+</div>
<hr>
-<span id="sntp-Description"></span><div class="header">
+<div class="chapter-level-extent" id="sntp-Description">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-Invocation" accesskey="n" rel="next">sntp Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Up: <a href="#Top" accesskey="u" rel="up">Simple Network Time Protocol User Manual</a> </p>
</div>
-<span id="Description"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description"><span>1 Description<a class="copiable-link" href="#Description"> ¶</a></span></h2>
-<p>By default, <code>sntp</code> writes the local data and time (i.e., not UTC) to the
+<p>By default, <code class="code">sntp</code> writes the local data and time (i.e., not UTC) to the
standard output in the format:
</p>
<div class="example">
-<pre class="example">1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+<pre class="example-preformatted">1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
</pre></div>
<p>where
the +4.567 +/- 0.089 secs indicates the time offset and
error bound of the system clock relative to the server clock.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#sntp-Invocation" accesskey="1">Invoking sntp</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Usage" accesskey="2">Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+<ul class="mini-toc">
+<li><a href="#sntp-Invocation" accesskey="1">Invoking sntp</a></li>
+<li><a href="#Usage" accesskey="2">Usage</a></li>
+</ul>
<hr>
-<span id="sntp-Invocation"></span><div class="header">
+<div class="section-level-extent" id="sntp-Invocation">
+<div class="nav-panel">
<p>
-Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#sntp-Description" accesskey="p" rel="prev">sntp Description</a>, Up: <a href="#sntp-Description" accesskey="u" rel="up">sntp Description</a> </p>
+Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#sntp-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Invoking-sntp"></span><h3 class="section">1.1 Invoking sntp</h3>
-<span id="index-sntp"></span>
-<span id="index-standard-Simple-Network-Time-Protocol-client-program"></span>
+<h3 class="section" id="Invoking-sntp"><span>1.1 Invoking sntp<a class="copiable-link" href="#Invoking-sntp"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-sntp"></a>
+<a class="index-entry-id" id="index-standard-Simple-Network-Time-Protocol-client-program"></a>
-<p><code>sntp</code>
+<p><code class="code">sntp</code>
can be used as an SNTP client to query a NTP or SNTP server and either display
the time or set the local system’s time (given suitable privilege). It can be
run as an interactive command or from a
-<code>cron</code>
+<code class="code">cron</code>
job.
</p>
<p>NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol)
<p>The default is to write the estimated correct local date and time (i.e. not
UTC) to the standard output in a format like:
</p>
-<p><code>'1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 [host] IP sN'</code>
+<p><code class="code">'1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 [host] IP sN'</code>
</p>
<p>where the
-<code>'(+0800)'</code>
+<code class="code">'(+0800)'</code>
means that to get to UTC from the reported local time one must
add 8 hours and 0 minutes,
the
-<code>'+4.567'</code>
+<code class="code">'+4.567'</code>
indicates the local clock is 4.567 seconds behind the correct time
(so 4.567 seconds must be added to the local clock to get it to be correct).
Note that the number of decimals printed for this value will change
based on the reported precision of the server.
-<code>'+/- 0.089'</code>
+<code class="code">'+/- 0.089'</code>
is the reported
-<em>synchronization</em> <em>distance</em>
+<em class="emph">synchronization</em> <em class="emph">distance</em>
(in seconds), which represents the maximum error due to all causes.
If the server does not report valid data needed to calculate the
synchronization distance, this will be reported as
-<code>'+/- ?'</code>.
+<code class="code">'+/- ?'</code>.
If the
-<em>host</em>
+<em class="emph">host</em>
is different from the
-<em>IP</em>,
+<em class="emph">IP</em>,
both will be displayed.
Otherwise, only the
-<em>IP</em>
+<em class="emph">IP</em>
is displayed.
Finally, the
-<em>stratum</em>
+<em class="emph">stratum</em>
of the host is reported
and the leap indicator is decoded and displayed.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>sntp</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">sntp</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#sntp-usage" accesskey="1">sntp usage</a></td><td> </td><td align="left" valign="top">sntp help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-ipv4" accesskey="2">sntp ipv4</a></td><td> </td><td align="left" valign="top">ipv4 option (-4)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-ipv6" accesskey="3">sntp ipv6</a></td><td> </td><td align="left" valign="top">ipv6 option (-6)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-authentication" accesskey="4">sntp authentication</a></td><td> </td><td align="left" valign="top">authentication option (-a)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-broadcast" accesskey="5">sntp broadcast</a></td><td> </td><td align="left" valign="top">broadcast option (-b)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-concurrent" accesskey="6">sntp concurrent</a></td><td> </td><td align="left" valign="top">concurrent option (-c)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-gap" accesskey="7">sntp gap</a></td><td> </td><td align="left" valign="top">gap option (-g)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-kod" accesskey="8">sntp kod</a></td><td> </td><td align="left" valign="top">kod option (-K)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-keyfile" accesskey="9">sntp keyfile</a></td><td> </td><td align="left" valign="top">keyfile option (-k)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-logfile">sntp logfile</a></td><td> </td><td align="left" valign="top">logfile option (-l)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-steplimit">sntp steplimit</a></td><td> </td><td align="left" valign="top">steplimit option (-M)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-ntpversion">sntp ntpversion</a></td><td> </td><td align="left" valign="top">ntpversion option (-o)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-usereservedport">sntp usereservedport</a></td><td> </td><td align="left" valign="top">usereservedport option (-r)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-timeout">sntp timeout</a></td><td> </td><td align="left" valign="top">timeout option (-t)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-wait">sntp wait</a></td><td> </td><td align="left" valign="top">wait option
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-config">sntp config</a></td><td> </td><td align="left" valign="top">presetting/configuring sntp
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-exit-status">sntp exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-Usage">sntp Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#sntp-Authors">sntp Authors</a></td><td> </td><td align="left" valign="top">Authors
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#sntp-usage" accesskey="1">sntp help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#sntp-ipv4" accesskey="2">ipv4 option (-4)</a></li>
+<li><a href="#sntp-ipv6" accesskey="3">ipv6 option (-6)</a></li>
+<li><a href="#sntp-authentication" accesskey="4">authentication option (-a)</a></li>
+<li><a href="#sntp-broadcast" accesskey="5">broadcast option (-b)</a></li>
+<li><a href="#sntp-concurrent" accesskey="6">concurrent option (-c)</a></li>
+<li><a href="#sntp-gap" accesskey="7">gap option (-g)</a></li>
+<li><a href="#sntp-kod" accesskey="8">kod option (-K)</a></li>
+<li><a href="#sntp-keyfile" accesskey="9">keyfile option (-k)</a></li>
+<li><a href="#sntp-logfile">logfile option (-l)</a></li>
+<li><a href="#sntp-steplimit">steplimit option (-M)</a></li>
+<li><a href="#sntp-ntpversion">ntpversion option (-o)</a></li>
+<li><a href="#sntp-usereservedport">usereservedport option (-r)</a></li>
+<li><a href="#sntp-timeout">timeout option (-t)</a></li>
+<li><a href="#sntp-wait">wait option</a></li>
+<li><a href="#sntp-config">presetting/configuring sntp</a></li>
+<li><a href="#sntp-exit-status">sntp exit status</a></li>
+<li><a href="#sntp-Usage">sntp Usage</a></li>
+<li><a href="#sntp-Authors">sntp Authors</a></li>
+</ul>
<hr>
-<span id="sntp-usage"></span><div class="header">
+<div class="subsection-level-extent" id="sntp-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-ipv4" accesskey="n" rel="next">sntp ipv4</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-ipv4" accesskey="n" rel="next">ipv4 option (-4)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="sntp-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1.1 sntp help/usage (<samp>--help</samp>)</h4>
-<span id="index-sntp-help"></span>
+<h4 class="subsection" id="sntp-help_002fusage-_0028_002d_002dhelp_0029"><span>1.1.1 sntp help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#sntp-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp-help"></a>
<p>This is the automatically generated usage text for sntp.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">sntp - standard Simple Network Time Protocol client program - Ver. 4.2.8p17
+<pre class="example-preformatted">sntp - standard Simple Network Time Protocol client program - Ver. 4.2.8p17
Usage: sntp [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \
[ hostname-or-IP ...]
Flg Arg Option-Name Description
</pre></div>
<hr>
-<span id="sntp-ipv4"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-ipv4">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-ipv6" accesskey="n" rel="next">sntp ipv6</a>, Previous: <a href="#sntp-usage" accesskey="p" rel="prev">sntp usage</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-ipv6" accesskey="n" rel="next">ipv6 option (-6)</a>, Previous: <a href="#sntp-usage" accesskey="p" rel="prev">sntp help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<span id="index-sntp_002dipv4"></span>
+<h4 class="subsection" id="ipv4-option-_0028_002d4_0029"><span>1.1.2 ipv4 option (-4)<a class="copiable-link" href="#ipv4-option-_0028_002d4_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dipv4"></a>
<p>This is the “force ipv4 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv6.
</li></ul>
<p>Force DNS resolution of the following host names on the command line
to the IPv4 namespace.
</p><hr>
-<span id="sntp-ipv6"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-ipv6">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-authentication" accesskey="n" rel="next">sntp authentication</a>, Previous: <a href="#sntp-ipv4" accesskey="p" rel="prev">sntp ipv4</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-authentication" accesskey="n" rel="next">authentication option (-a)</a>, Previous: <a href="#sntp-ipv4" accesskey="p" rel="prev">ipv4 option (-4)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="ipv6-option-_0028_002d6_0029"></span><h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<span id="index-sntp_002dipv6"></span>
+<h4 class="subsection" id="ipv6-option-_0028_002d6_0029"><span>1.1.3 ipv6 option (-6)<a class="copiable-link" href="#ipv6-option-_0028_002d6_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dipv6"></a>
<p>This is the “force ipv6 dns name resolution” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must not appear in combination with any of the following options:
+</p><ul class="itemize mark-bullet">
+<li>must not appear in combination with any of the following options:
ipv4.
</li></ul>
<p>Force DNS resolution of the following host names on the command line
to the IPv6 namespace.
</p><hr>
-<span id="sntp-authentication"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-authentication">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-broadcast" accesskey="n" rel="next">sntp broadcast</a>, Previous: <a href="#sntp-ipv6" accesskey="p" rel="prev">sntp ipv6</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-broadcast" accesskey="n" rel="next">broadcast option (-b)</a>, Previous: <a href="#sntp-ipv6" accesskey="p" rel="prev">ipv6 option (-6)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="authentication-option-_0028_002da_0029"></span><h4 class="subsection">1.1.4 authentication option (-a)</h4>
-<span id="index-sntp_002dauthentication"></span>
+<h4 class="subsection" id="authentication-option-_0028_002da_0029"><span>1.1.4 authentication option (-a)<a class="copiable-link" href="#authentication-option-_0028_002da_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dauthentication"></a>
-<p>This is the “enable authentication with the key <var>auth-keynumber</var>” option.
-This option takes a number argument <samp>auth-keynumber</samp>.
+<p>This is the “enable authentication with the key <var class="var">auth-keynumber</var>” option.
+This option takes a number argument <samp class="file">auth-keynumber</samp>.
Enable authentication using the key specified in this option’s
-argument. The argument of this option is the <samp>keyid</samp>, a
-number specified in the <samp>keyfile</samp> as this key’s identifier.
-See the <samp>keyfile</samp> option (<samp>-k</samp>) for more details.
+argument. The argument of this option is the <samp class="option">keyid</samp>, a
+number specified in the <samp class="option">keyfile</samp> as this key’s identifier.
+See the <samp class="option">keyfile</samp> option (<samp class="option">-k</samp>) for more details.
</p><hr>
-<span id="sntp-broadcast"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-broadcast">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-concurrent" accesskey="n" rel="next">sntp concurrent</a>, Previous: <a href="#sntp-authentication" accesskey="p" rel="prev">sntp authentication</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-concurrent" accesskey="n" rel="next">concurrent option (-c)</a>, Previous: <a href="#sntp-authentication" accesskey="p" rel="prev">authentication option (-a)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="broadcast-option-_0028_002db_0029"></span><h4 class="subsection">1.1.5 broadcast option (-b)</h4>
-<span id="index-sntp_002dbroadcast"></span>
+<h4 class="subsection" id="broadcast-option-_0028_002db_0029"><span>1.1.5 broadcast option (-b)<a class="copiable-link" href="#broadcast-option-_0028_002db_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dbroadcast"></a>
<p>This is the “listen to the address specified for broadcast time sync” option.
-This option takes a string argument <samp>broadcast-address</samp>.
+This option takes a string argument <samp class="file">broadcast-address</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
-<p>If specified <code>sntp</code> will listen to the specified address
+<p>If specified <code class="code">sntp</code> will listen to the specified address
for NTP broadcasts. The default maximum wait time
-can (and probably should) be modified with <samp>-t</samp>.
+can (and probably should) be modified with <samp class="option">-t</samp>.
</p><hr>
-<span id="sntp-concurrent"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-concurrent">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-gap" accesskey="n" rel="next">sntp gap</a>, Previous: <a href="#sntp-broadcast" accesskey="p" rel="prev">sntp broadcast</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-gap" accesskey="n" rel="next">gap option (-g)</a>, Previous: <a href="#sntp-broadcast" accesskey="p" rel="prev">broadcast option (-b)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="concurrent-option-_0028_002dc_0029"></span><h4 class="subsection">1.1.6 concurrent option (-c)</h4>
-<span id="index-sntp_002dconcurrent"></span>
+<h4 class="subsection" id="concurrent-option-_0028_002dc_0029"><span>1.1.6 concurrent option (-c)<a class="copiable-link" href="#concurrent-option-_0028_002dc_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dconcurrent"></a>
<p>This is the “concurrently query all ips returned for host-name” option.
-This option takes a string argument <samp>host-name</samp>.
+This option takes a string argument <samp class="file">host-name</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
+</p><ul class="itemize mark-bullet">
+<li>may appear an unlimited number of times.
</li></ul>
<p>Requests from an NTP "client" to a "server" should never be sent
more rapidly than one every 2 seconds. By default, any IPs returned
as part of a DNS lookup are assumed to be for a single instance of
-<code>ntpd</code>, and therefore <code>sntp</code> will send queries to these IPs
+<code class="code">ntpd</code>, and therefore <code class="code">sntp</code> will send queries to these IPs
one after another, with a 2-second gap in between each query.
</p>
-<p>The <samp>-c</samp> or <samp>--concurrent</samp> flag says that any IPs
+<p>The <samp class="option">-c</samp> or <samp class="option">--concurrent</samp> flag says that any IPs
returned for the DNS lookup of the supplied host-name are on
different machines, so we can send concurrent queries.
</p><hr>
-<span id="sntp-gap"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-gap">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-kod" accesskey="n" rel="next">sntp kod</a>, Previous: <a href="#sntp-concurrent" accesskey="p" rel="prev">sntp concurrent</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-kod" accesskey="n" rel="next">kod option (-K)</a>, Previous: <a href="#sntp-concurrent" accesskey="p" rel="prev">concurrent option (-c)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="gap-option-_0028_002dg_0029"></span><h4 class="subsection">1.1.7 gap option (-g)</h4>
-<span id="index-sntp_002dgap"></span>
+<h4 class="subsection" id="gap-option-_0028_002dg_0029"><span>1.1.7 gap option (-g)<a class="copiable-link" href="#gap-option-_0028_002dg_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dgap"></a>
<p>This is the “the gap (in milliseconds) between time requests” option.
-This option takes a number argument <samp>milliseconds</samp>.
+This option takes a number argument <samp class="file">milliseconds</samp>.
Since we’re only going to use the first valid response we get and
there is benefit to specifying a good number of servers to query,
separate the queries we send out by the specified number of
milliseconds.
</p><hr>
-<span id="sntp-kod"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-kod">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-keyfile" accesskey="n" rel="next">sntp keyfile</a>, Previous: <a href="#sntp-gap" accesskey="p" rel="prev">sntp gap</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-keyfile" accesskey="n" rel="next">keyfile option (-k)</a>, Previous: <a href="#sntp-gap" accesskey="p" rel="prev">gap option (-g)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="kod-option-_0028_002dK_0029"></span><h4 class="subsection">1.1.8 kod option (-K)</h4>
-<span id="index-sntp_002dkod"></span>
+<h4 class="subsection" id="kod-option-_0028_002dK_0029"><span>1.1.8 kod option (-K)<a class="copiable-link" href="#kod-option-_0028_002dK_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dkod"></a>
<p>This is the “kod history filename” option.
-This option takes a file argument <samp>file-name</samp>.
+This option takes a file argument <samp class="file">file-name</samp>.
Specifies the filename to be used for the persistent history of KoD
responses received from servers. If the file does not exist, a
warning message will be displayed. The file will not be created.
</p><hr>
-<span id="sntp-keyfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-keyfile">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-logfile" accesskey="n" rel="next">sntp logfile</a>, Previous: <a href="#sntp-kod" accesskey="p" rel="prev">sntp kod</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-logfile" accesskey="n" rel="next">logfile option (-l)</a>, Previous: <a href="#sntp-kod" accesskey="p" rel="prev">kod option (-K)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="keyfile-option-_0028_002dk_0029"></span><h4 class="subsection">1.1.9 keyfile option (-k)</h4>
-<span id="index-sntp_002dkeyfile"></span>
+<h4 class="subsection" id="keyfile-option-_0028_002dk_0029"><span>1.1.9 keyfile option (-k)<a class="copiable-link" href="#keyfile-option-_0028_002dk_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dkeyfile"></a>
-<p>This is the “look in this file for the key specified with <samp>-a</samp>” option.
-This option takes a file argument <samp>file-name</samp>.
+<p>This is the “look in this file for the key specified with <samp class="option">-a</samp>” option.
+This option takes a file argument <samp class="file">file-name</samp>.
This option specifies the keyfile.
-<code>sntp</code> will search for the key specified with <samp>-a</samp>
-<samp>keyno</samp> in this file. See <code>ntp.keys(5)</code> for more
+<code class="code">sntp</code> will search for the key specified with <samp class="option">-a</samp>
+<samp class="file">keyno</samp> in this file. See <code class="command">ntp.keys(5)</code> for more
information.
</p><hr>
-<span id="sntp-logfile"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-logfile">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-steplimit" accesskey="n" rel="next">sntp steplimit</a>, Previous: <a href="#sntp-keyfile" accesskey="p" rel="prev">sntp keyfile</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-steplimit" accesskey="n" rel="next">steplimit option (-M)</a>, Previous: <a href="#sntp-keyfile" accesskey="p" rel="prev">keyfile option (-k)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="logfile-option-_0028_002dl_0029"></span><h4 class="subsection">1.1.10 logfile option (-l)</h4>
-<span id="index-sntp_002dlogfile"></span>
+<h4 class="subsection" id="logfile-option-_0028_002dl_0029"><span>1.1.10 logfile option (-l)<a class="copiable-link" href="#logfile-option-_0028_002dl_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dlogfile"></a>
<p>This is the “log to specified logfile” option.
-This option takes a file argument <samp>file-name</samp>.
+This option takes a file argument <samp class="file">file-name</samp>.
This option causes the client to write log messages to the specified
-<samp>logfile</samp>.
+<samp class="file">logfile</samp>.
</p><hr>
-<span id="sntp-steplimit"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-steplimit">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-ntpversion" accesskey="n" rel="next">sntp ntpversion</a>, Previous: <a href="#sntp-logfile" accesskey="p" rel="prev">sntp logfile</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-ntpversion" accesskey="n" rel="next">ntpversion option (-o)</a>, Previous: <a href="#sntp-logfile" accesskey="p" rel="prev">logfile option (-l)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="steplimit-option-_0028_002dM_0029"></span><h4 class="subsection">1.1.11 steplimit option (-M)</h4>
-<span id="index-sntp_002dsteplimit"></span>
+<h4 class="subsection" id="steplimit-option-_0028_002dM_0029"><span>1.1.11 steplimit option (-M)<a class="copiable-link" href="#steplimit-option-_0028_002dM_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dsteplimit"></a>
-<p>This is the “adjustments less than <var>steplimit</var> msec will be slewed” option.
+<p>This is the “adjustments less than <var class="var">steplimit</var> msec will be slewed” option.
This option takes a number argument.
-If the time adjustment is less than <samp>steplimit</samp> milliseconds,
-slew the amount using <code>adjtime(2)</code>. Otherwise, step the
-correction using <code>settimeofday(2)</code>. The default value is 0,
+If the time adjustment is less than <samp class="file">steplimit</samp> milliseconds,
+slew the amount using <code class="command">adjtime(2)</code>. Otherwise, step the
+correction using <code class="command">settimeofday(2)</code>. The default value is 0,
which means all adjustments will be stepped. This is a feature, as
different situations demand different values.
</p><hr>
-<span id="sntp-ntpversion"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-ntpversion">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-usereservedport" accesskey="n" rel="next">sntp usereservedport</a>, Previous: <a href="#sntp-steplimit" accesskey="p" rel="prev">sntp steplimit</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-usereservedport" accesskey="n" rel="next">usereservedport option (-r)</a>, Previous: <a href="#sntp-steplimit" accesskey="p" rel="prev">steplimit option (-M)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="ntpversion-option-_0028_002do_0029"></span><h4 class="subsection">1.1.12 ntpversion option (-o)</h4>
-<span id="index-sntp_002dntpversion"></span>
+<h4 class="subsection" id="ntpversion-option-_0028_002do_0029"><span>1.1.12 ntpversion option (-o)<a class="copiable-link" href="#ntpversion-option-_0028_002do_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dntpversion"></a>
-<p>This is the “send <var>int</var> as our ntp protocol version” option.
+<p>This is the “send <var class="var">int</var> as our ntp protocol version” option.
This option takes a number argument.
When sending requests to a remote server, tell them we are running
-NTP protocol version <samp>ntpversion</samp> .
+NTP protocol version <samp class="file">ntpversion</samp> .
</p><hr>
-<span id="sntp-usereservedport"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-usereservedport">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-timeout" accesskey="n" rel="next">sntp timeout</a>, Previous: <a href="#sntp-ntpversion" accesskey="p" rel="prev">sntp ntpversion</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-timeout" accesskey="n" rel="next">timeout option (-t)</a>, Previous: <a href="#sntp-ntpversion" accesskey="p" rel="prev">ntpversion option (-o)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="usereservedport-option-_0028_002dr_0029"></span><h4 class="subsection">1.1.13 usereservedport option (-r)</h4>
-<span id="index-sntp_002dusereservedport"></span>
+<h4 class="subsection" id="usereservedport-option-_0028_002dr_0029"><span>1.1.13 usereservedport option (-r)<a class="copiable-link" href="#usereservedport-option-_0028_002dr_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dusereservedport"></a>
<p>This is the “use the ntp reserved port (port 123)” option.
Use port 123, which is reserved for NTP, for our network
communications.
</p><hr>
-<span id="sntp-timeout"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-timeout">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-wait" accesskey="n" rel="next">sntp wait</a>, Previous: <a href="#sntp-usereservedport" accesskey="p" rel="prev">sntp usereservedport</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-wait" accesskey="n" rel="next">wait option</a>, Previous: <a href="#sntp-usereservedport" accesskey="p" rel="prev">usereservedport option (-r)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="timeout-option-_0028_002dt_0029"></span><h4 class="subsection">1.1.14 timeout option (-t)</h4>
-<span id="index-sntp_002dtimeout"></span>
+<h4 class="subsection" id="timeout-option-_0028_002dt_0029"><span>1.1.14 timeout option (-t)<a class="copiable-link" href="#timeout-option-_0028_002dt_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dtimeout"></a>
<p>This is the “the number of seconds to wait for responses” option.
-This option takes a number argument <samp>seconds</samp>.
-When waiting for a reply, <code>sntp</code> will wait the number
+This option takes a number argument <samp class="file">seconds</samp>.
+When waiting for a reply, <code class="code">sntp</code> will wait the number
of seconds specified before giving up. The default should be
-more than enough for a unicast response. If <code>sntp</code> is
+more than enough for a unicast response. If <code class="code">sntp</code> is
only waiting for a broadcast response a longer timeout is
likely needed.
</p><hr>
-<span id="sntp-wait"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-wait">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-config" accesskey="n" rel="next">sntp config</a>, Previous: <a href="#sntp-timeout" accesskey="p" rel="prev">sntp timeout</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-config" accesskey="n" rel="next">presetting/configuring sntp</a>, Previous: <a href="#sntp-timeout" accesskey="p" rel="prev">timeout option (-t)</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="wait-option"></span><h4 class="subsection">1.1.15 wait option</h4>
-<span id="index-sntp_002dwait"></span>
+<h4 class="subsection" id="wait-option"><span>1.1.15 wait option<a class="copiable-link" href="#wait-option"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-sntp_002dwait"></a>
<p>This is the “wait for pending replies (if not setting the time)” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> can be disabled with –no-wait.
-</li><li> It is enabled by default.
+</p><ul class="itemize mark-bullet">
+<li>can be disabled with –no-wait.
+</li><li>It is enabled by default.
</li></ul>
<p>If we are not setting the time, wait for all pending responses.
</p>
<hr>
-<span id="sntp-config"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-config">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-exit-status" accesskey="n" rel="next">sntp exit status</a>, Previous: <a href="#sntp-wait" accesskey="p" rel="prev">sntp wait</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-exit-status" accesskey="n" rel="next">sntp exit status</a>, Previous: <a href="#sntp-wait" accesskey="p" rel="prev">wait option</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="presetting_002fconfiguring-sntp"></span><h4 class="subsection">1.1.16 presetting/configuring sntp</h4>
+<h4 class="subsection" id="presetting_002fconfiguring-sntp"><span>1.1.16 presetting/configuring sntp<a class="copiable-link" href="#presetting_002fconfiguring-sntp"> ¶</a></span></h4>
-<p>Any option that is not marked as <i>not presettable</i> may be preset by
-loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>SNTP</code> and <code>SNTP_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
+<p>Any option that is not marked as <i class="i">not presettable</i> may be preset by
+loading values from configuration ("rc" or "ini") files, and values from environment variables named <code class="code">SNTP</code> and <code class="code">SNTP_<OPTION_NAME></code>. <code class="code"><OPTION_NAME></code> must be one of
the options listed above in upper case and segmented with underscores.
-The <code>SNTP</code> variable will be tokenized and parsed like
+The <code class="code">SNTP</code> variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
</p>
-<p><code>libopts</code> will search in 2 places for configuration files:
-</p><ul>
-<li> $HOME
-</li><li> $PWD
+<p><code class="code">libopts</code> will search in 2 places for configuration files:
+</p><ul class="itemize mark-bullet">
+<li>$HOME
+</li><li>$PWD
</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>sntp</samp> runs.
+<p>The environment variables <code class="code">HOME</code>, and <code class="code">PWD</code>
+are expanded and replaced when <samp class="file">sntp</samp> runs.
For any of these that are plain files, they are simply processed.
-For any that are directories, then a file named <samp>.ntprc</samp> is searched for
+For any that are directories, then a file named <samp class="file">.ntprc</samp> is searched for
within that directory and processed.
</p>
<p>Configuration files may be in a wide variety of formats.
Common options are collected at the top, followed by program specific
segments. The segments are separated by lines like:
</p><div class="example">
-<pre class="example">[SNTP]
+<pre class="example-preformatted">[SNTP]
</pre></div>
<p>or by
</p><div class="example">
-<pre class="example"><?program sntp>
+<pre class="example-preformatted"><?program sntp>
</pre></div>
<p>Do not mix these styles within one configuration file.
</p>
<p>Compound values and carefully constructed string values may also be
specified using XML syntax:
</p><div class="example">
-<pre class="example"><option-name>
+<pre class="example-preformatted"><option-name>
<sub-opt>...&lt;...&gt;...</sub-opt>
</option-name>
</pre></div>
-<p>yielding an <code>option-name.sub-opt</code> string value of
+<p>yielding an <code class="code">option-name.sub-opt</code> string value of
</p><div class="example">
-<pre class="example">"...<...>..."
+<pre class="example-preformatted">"...<...>..."
</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
-hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching
+<p><code class="code">AutoOpts</code> does not track suboptions. You simply note that it is a
+hierarchicly valued option. <code class="code">AutoOpts</code> does provide a means for searching
the associated name/value pair list (see: optionFindValue).
</p>
<p>The command line options relating to configuration and/or usage help are:
</p>
-<span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
+<h4 class="subsubheading" id="version-_0028_002d_0029"><span>version (-)<a class="copiable-link" href="#version-_0028_002d_0029"> ¶</a></span></h4>
<p>Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing information may be selected with an option argument.
Only the first letter of the argument is examined:
</p>
-<dl compact="compact">
-<dt>‘<samp>version</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">version</samp>’</dt>
<dd><p>Only print the version. This is the default.
</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
+<dt>‘<samp class="samp">copyright</samp>’</dt>
<dd><p>Name the copyright usage licensing terms.
</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>Print the full copyright usage licensing terms.
</p></dd>
</dl>
<hr>
-<span id="sntp-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-exit-status">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-Usage" accesskey="n" rel="next">sntp Usage</a>, Previous: <a href="#sntp-config" accesskey="p" rel="prev">sntp config</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-Usage" accesskey="n" rel="next">sntp Usage</a>, Previous: <a href="#sntp-config" accesskey="p" rel="prev">presetting/configuring sntp</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="sntp-exit-status-1"></span><h4 class="subsection">1.1.17 sntp exit status</h4>
+<h4 class="subsection" id="sntp-exit-status-1"><span>1.1.17 sntp exit status<a class="copiable-link" href="#sntp-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
-<dt>‘<samp>66 (EX_NOINPUT)</samp>’</dt>
+<dt>‘<samp class="samp">66 (EX_NOINPUT)</samp>’</dt>
<dd><p>A specified configuration file could not be loaded.
</p></dd>
-<dt>‘<samp>70 (EX_SOFTWARE)</samp>’</dt>
+<dt>‘<samp class="samp">70 (EX_SOFTWARE)</samp>’</dt>
<dd><p>libopts had an internal operational error. Please report
it to autogen-users@lists.sourceforge.net. Thank you.
</p></dd>
</dl>
<hr>
-<span id="sntp-Usage"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-Usage">
+<div class="nav-panel">
<p>
-Next: <a href="#sntp-Authors" accesskey="n" rel="next">sntp Authors</a>, Previous: <a href="#sntp-exit-status" accesskey="p" rel="prev">sntp exit status</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Next: <a href="#sntp-Authors" accesskey="n" rel="next">sntp Authors</a>, Previous: <a href="#sntp-exit-status" accesskey="p" rel="prev">sntp exit status</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="sntp-Usage-1"></span><h4 class="subsection">1.1.18 sntp Usage</h4>
+<h4 class="subsection" id="sntp-Usage-1"><span>1.1.18 sntp Usage<a class="copiable-link" href="#sntp-Usage-1"> ¶</a></span></h4>
<hr>
-<span id="sntp-Authors"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="sntp-Authors">
+<div class="nav-panel">
<p>
-Previous: <a href="#sntp-Usage" accesskey="p" rel="prev">sntp Usage</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">sntp Invocation</a> </p>
+Previous: <a href="#sntp-Usage" accesskey="p" rel="prev">sntp Usage</a>, Up: <a href="#sntp-Invocation" accesskey="u" rel="up">Invoking sntp</a> </p>
</div>
-<span id="sntp-Authors-1"></span><h4 class="subsection">1.1.19 sntp Authors</h4>
+<h4 class="subsection" id="sntp-Authors-1"><span>1.1.19 sntp Authors<a class="copiable-link" href="#sntp-Authors-1"> ¶</a></span></h4>
<hr>
-<span id="Usage"></span><div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="#sntp-Invocation" accesskey="p" rel="prev">sntp Invocation</a>, Up: <a href="#sntp-Description" accesskey="u" rel="up">sntp Description</a> </p>
+Previous: <a href="#sntp-Invocation" accesskey="p" rel="prev">Invoking sntp</a>, Up: <a href="#sntp-Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Usage-1"></span><h3 class="section">1.2 Usage</h3>
+<h3 class="section" id="Usage-1"><span>1.2 Usage<a class="copiable-link" href="#Usage-1"> ¶</a></span></h3>
<p>The simplest use of this program is as an unprivileged command to
check the current time, offset, and error in the local clock.
For example:
</p>
<div class="example">
-<pre class="example">sntp ntpserver.somewhere
+<pre class="example-preformatted">sntp ntpserver.somewhere
</pre></div>
<p>With suitable privilege, it can be run as a command or in a
-<code>crom</code> job to reset the local clock from a reliable server, like
-the <code>ntpdate</code> and <code>rdate</code> commands.
+<code class="code">crom</code> job to reset the local clock from a reliable server, like
+the <code class="code">ntpdate</code> and <code class="code">rdate</code> commands.
For example:
</p>
<div class="example">
-<pre class="example">sntp -a ntpserver.somewhere
+<pre class="example-preformatted">sntp -a ntpserver.somewhere
</pre></div>
-<hr>
+</div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH sntp @SNTP_MS@ "06 Jun 2023" "4.2.8p17" "User Commands"
+.TH sntp @SNTP_MS@ "07 Jan 2024" "4.2.8p17" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:36:14 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:33:46 AM by AutoGen 5.18.16
.\" From the definitions sntp-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.NOP "Dave Hart"
.br
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
-.Dd June 6 2023
+.Dd January 7 2024
.Dt SNTP @SNTP_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (sntp-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:36:10 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:33:42 AM by AutoGen 5.18.16
.\" From the definitions sntp-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.An "Harlan Stenn"
.An "Dave Hart"
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: https://bugs.ntp.org, bugs@ntp.org
libexec_PROGRAMS= $(NTP_KEYGEN_DL) $(NTPTIME_DL) $(TICKADJ_DL) $(TIMETRIM_DL)
sbin_PROGRAMS= $(NTP_KEYGEN_DS) $(NTPTIME_DS) $(TICKADJ_DS) $(TIMETRIM_DS)
-EXTRA_PROGRAMS= audio-pcm byteorder hist jitter kern longsize ntp-keygen \
+EXTRA_PROGRAMS= audio-pcm byteorder hist jitter kern longsize lsf-times \
+ ntp-keygen \
ntptime pps-api precision sht testrs6000 tg tg2 tickadj timetrim
AM_CFLAGS = $(CFLAGS_NTP)
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp-keygen.texi)
#
-# It has been AutoGen-ed June 6, 2023 at 04:38:29 AM by AutoGen 5.18.16
+# It has been AutoGen-ed January 7, 2024 at 12:35:07 AM by AutoGen 5.18.16
# From the definitions ntp-keygen-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
/*
* EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.c)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:24 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:36:07 AM by AutoGen 5.18.16
* From the definitions ntp-keygen-opts.def
* and the template file options
*
* The ntp-keygen program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
*/
static char const ntp_keygen_opt_strs[2443] =
/* 0 */ "ntp-keygen (ntp) 4.2.8p17\n"
- "Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n"
+ "Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"redistribution under the terms of the NTP License, copies of which\n"
"can be seen at:\n"
*/
/* referenced via ntp_keygenOptions.pzCopyright */
puts(_("ntp-keygen (ntp) 4.2.8p17\n\
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.\n\
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.\n\
This is free software. It is licensed for use, modification and\n\
redistribution under the terms of the NTP License, copies of which\n\
can be seen at:\n"));
/*
* EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.h)
*
- * It has been AutoGen-ed June 6, 2023 at 04:38:23 AM by AutoGen 5.18.16
+ * It has been AutoGen-ed January 7, 2024 at 12:36:07 AM by AutoGen 5.18.16
* From the definitions ntp-keygen-opts.def
* and the template file options
*
* The ntp-keygen program is copyrighted and licensed
* under the following terms:
*
- * Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation, all rights reserved.
+ * Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation, all rights reserved.
* This is free software. It is licensed for use, modification and
* redistribution under the terms of the NTP License, copies of which
* can be seen at:
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-keygen 1ntp-keygenman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntp-keygen 1ntp-keygenman "07 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:32 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:09 AM by AutoGen 5.18.16
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
It can take quite a while to generate some cryptographic values.
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_KEYGEN 1ntp-keygenmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:27 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:05 AM by AutoGen 5.18.16
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
It can take quite a while to generate some cryptographic values.
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html>
<html>
-<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Ntp-keygen User’s Manual</title>
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
<link href="dir.html#Top" rel="up" title="(dir)">
+<link href="#Description" rel="next" title="Description">
+<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
</head>
<body lang="en">
-<h1 class="settitle" align="center">Ntp-keygen User’s Manual</h1>
-
-<span id="SEC_Overview"></span>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a id="stoc-Description-1" href="#toc-Description-1">1 Description</a></li>
-</ul>
-</div>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#Description" accesskey="1">Description</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Invocation" accesskey="2">ntp-keygen Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntp-keygen
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Running-the-Program" accesskey="3">Running the Program</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Random-Seed-File" accesskey="4">Random Seed File</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Cryptographic-Data-Files" accesskey="5">Cryptographic Data Files</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-<span id="Top"></span><div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
Next: <a href="#Description" accesskey="n" rel="next">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>
</div>
-<span id="NTP-Key-Generation-Program-User-Manual"></span><h1 class="top">NTP Key Generation Program User Manual</h1>
+<h1 class="top" id="NTP-Key-Generation-Program-User-Manual"><span>NTP Key Generation Program User Manual<a class="copiable-link" href="#NTP-Key-Generation-Program-User-Manual"> ¶</a></span></h1>
-<p>This document describes the use of the NTP Project’s <code>ntp-keygen</code>
+<p>This document describes the use of the NTP Project’s <code class="code">ntp-keygen</code>
program, that generates cryptographic data files used by the NTPv4
authentication and identity schemes.
It can generate message digest keys used in symmetric key cryptography and,
printable ASCII format so they can be embedded as MIME attachments in
mail to other sites.
</p>
-<p>This document applies to version 4.2.8p17 of <code>ntp-keygen</code>.
+<p>This document applies to version 4.2.8p17 of <code class="code">ntp-keygen</code>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#Description" accesskey="1">Description</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
+<div class="element-shortcontents" id="SEC_Shortcontents">
+<h2 class="shortcontents-heading">Short Table of Contents</h2>
+<div class="shortcontents">
+<ul class="toc-numbered-mark">
+<li><a id="stoc-Description-1" href="#Description">1 Description</a></li>
+</ul>
+</div>
+</div>
<hr>
-<span id="Description"></span><div class="header">
+<div class="chapter-level-extent" id="Description">
+<div class="nav-panel">
<p>
-Next: <a href="#Running-the-Program" accesskey="n" rel="next">Running the Program</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Next: <a href="#Running-the-Program" accesskey="n" rel="next">Running the Program</a>, Previous: <a href="#Top" accesskey="p" rel="prev">NTP Key Generation Program User Manual</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP Key Generation Program User Manual</a> </p>
</div>
-<span id="Description-1"></span><h2 class="chapter">1 Description</h2>
+<h2 class="chapter section-level-set-chapter" id="Description-1"><span>1 Description<a class="copiable-link" href="#Description-1"> ¶</a></span></h2>
<p>This program generates cryptographic data files used by the NTPv4
authentication and identity schemes. It can generate message digest
are probably not compatible with anything other than Autokey.
</p>
<p>Some files used by this program are encrypted using a private password.
-The <code>-p</code> option specifies the password for local encrypted files and the
-<code>-q</code> option the password for encrypted files sent to remote sites.
+The <code class="code">-p</code> option specifies the password for local encrypted files and the
+<code class="code">-q</code> option the password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-<code>gethostname()</code> function, normally the DNS name of the host, is used.
+<code class="code">gethostname()</code> function, normally the DNS name of the host, is used.
</p>
-<p>The <kbd>pw</kbd> option of the <code>crypto</code> configuration command
+<p>The <kbd class="kbd">pw</kbd> option of the <code class="code">crypto</code> configuration command
specifies the read password for previously encrypted local files.
This must match the local password used by this program.
If not specified, the host name is used.
<p>Normally, encrypted files for each host are generated by that host and
used only by that host, although exceptions exist as noted later on
this page.
-The symmetric keys file, normally called <code>ntp.keys</code>, is
-usually installed in <code>/etc</code>.
+The symmetric keys file, normally called <code class="code">ntp.keys</code>, is
+usually installed in <code class="code">/etc</code>.
Other files and links are usually installed
-in <code>/usr/local/etc</code>, which is normally in a shared filesystem in
+in <code class="code">/usr/local/etc</code>, which is normally in a shared filesystem in
NFS-mounted networks and cannot be changed by shared clients.
The location of the keys directory can be changed by the keysdir
configuration command in such cases.
-Normally, this is in <code>/etc</code>.
+Normally, this is in <code class="code">/etc</code>.
</p>
<p>This program directs commentary and error messages to the standard
-error stream <code>stderr</code> and remote files to the standard output stream
-<code>stdout</code> where they can be piped to other applications or redirected to
+error stream <code class="code">stderr</code> and remote files to the standard output stream
+<code class="code">stdout</code> where they can be piped to other applications or redirected to
files.
The names used for generated files and links all begin with the
-string <code>ntpkey</code> and include the file type,
+string <code class="code">ntpkey</code> and include the file type,
generating host and filestamp,
-as described in the <a href="#Cryptographic-Data-Files">Cryptographic Data Files</a> section below.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#Running-the-Program" accesskey="1">Running the Program</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Invocation" accesskey="2">Invoking ntp-keygen</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Random-Seed-File" accesskey="3">Random Seed File</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Cryptographic-Data-Files" accesskey="4">Cryptographic Data Files</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
+as described in the <a class="ref" href="#Cryptographic-Data-Files">Cryptographic Data Files</a> section below.
+</p>
+<ul class="mini-toc">
+<li><a href="#Running-the-Program" accesskey="1">Running the Program</a></li>
+<li><a href="#ntp_002dkeygen-Invocation" accesskey="2">Invoking ntp-keygen</a></li>
+<li><a href="#Random-Seed-File" accesskey="3">Random Seed File</a></li>
+<li><a href="#Cryptographic-Data-Files" accesskey="4">Cryptographic Data Files</a></li>
+</ul>
<hr>
-<span id="Running-the-Program"></span><div class="header">
+<div class="section-level-extent" id="Running-the-Program">
+<div class="nav-panel">
<p>
-Next: <a href="#Random-Seed-File" accesskey="n" rel="next">Random Seed File</a>, Previous: <a href="#Description" accesskey="p" rel="prev">Description</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Next: <a href="#Random-Seed-File" accesskey="n" rel="next">Random Seed File</a>, Previous: <a href="#Description" accesskey="p" rel="prev">Description</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP Key Generation Program User Manual</a> </p>
</div>
-<span id="Running-the-Program-1"></span><h3 class="section">1.1 Running the Program</h3>
+<h3 class="section" id="Running-the-Program-1"><span>1.1 Running the Program<a class="copiable-link" href="#Running-the-Program-1"> ¶</a></span></h3>
<p>To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually <code>/usr/local/etc</code>.
+change to the keys directory, usually <code class="code">/usr/local/etc</code>.
When run for the
-first time, or if all files with names beginning <code>ntpkey</code>] have been
-removed, use the <code>ntp-keygen</code> command without arguments to generate a
+first time, or if all files with names beginning <code class="code">ntpkey</code>] have been
+removed, use the <code class="code">ntp-keygen</code> command without arguments to generate a
default RSA host key and matching RSA-MD5 certificate with expiration
date one year hence.
If run again without options, the program uses the
new expiration date one year hence.
</p>
<p>Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using <code>ntp-keygen</code>
-with the <code>-T</code> option and configure
+Designate one of them as the trusted host (TH) using <code class="code">ntp-keygen</code>
+with the <code class="code">-T</code> option and configure
it to synchronize from reliable Internet servers.
Then configure the other hosts to synchronize to the TH directly or indirectly.
A certificate trail is created when Autokey asks the immediately
<p>The host key is used to encrypt the cookie when required and so must be
RSA type.
By default, the host key is also the sign key used to encrypt signatures.
-A different sign key can be assigned using the <code>-S</code> option
+A different sign key can be assigned using the <code class="code">-S</code> option
and this can be either RSA or DSA type.
By default, the signature
message digest type is MD5, but any combination of sign key type and
message digest type supported by the OpenSSL library can be specified
-using the <code>-c</code> option.
+using the <code class="code">-c</code> option.
</p>
<p>The rules say cryptographic media should be generated with proventic
filestamps, which means the host should already be synchronized before
Autokey Public-Key Authentication page.
</p>
<hr>
-<span id="ntp_002dkeygen-Invocation"></span><div class="header">
+</div>
+<div class="section-level-extent" id="ntp_002dkeygen-Invocation">
+<div class="nav-panel">
<p>
Next: <a href="#Random-Seed-File" accesskey="n" rel="next">Random Seed File</a>, Previous: <a href="#Running-the-Program" accesskey="p" rel="prev">Running the Program</a>, Up: <a href="#Description" accesskey="u" rel="up">Description</a> </p>
</div>
-<span id="Invoking-ntp_002dkeygen"></span><h3 class="section">1.2 Invoking ntp-keygen</h3>
-<span id="index-ntp_002dkeygen"></span>
-<span id="index-Create-a-NTP-host-key"></span>
+<h3 class="section" id="Invoking-ntp_002dkeygen"><span>1.2 Invoking ntp-keygen<a class="copiable-link" href="#Invoking-ntp_002dkeygen"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ntp_002dkeygen"></a>
+<a class="index-entry-id" id="index-Create-a-NTP-host-key"></a>
using secure means beyond the scope of NTP itself.
Besides the keys used for ordinary NTP associations, additional keys
can be defined as passwords for the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utility programs.
</p>
<p>The remaining generated files are compatible with other OpenSSL
</p>
<p>Some files used by this program are encrypted using a private password.
The
-<code>-p</code>
+<code class="code">-p</code>
option specifies the read password for local encrypted files and the
-<code>-q</code>
+<code class="code">-q</code>
option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-<code>hostname(1)</code>
+<code class="code">hostname(1)</code>
command, normally the DNS name of the host, is used as the the default read
password, for convenience.
The
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program prompts for the password if it reads an encrypted file
and the password is missing or incorrect.
If an encrypted file is read successfully and
as the write password by default.
</p>
<p>The
-<code>pw</code>
+<code class="code">pw</code>
option of the
-<code>crypto</code>
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">crypto</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
configuration command specifies the read
password for previously encrypted local files.
This must match the local read password used by this program.
If not specified, the host name is used.
Thus, if files are generated by this program without an explicit password,
they can be read back by
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
without specifying an explicit password but only on the same host.
If the write password used for encryption is specified as the host name,
these files can be read by that host with no explicit password.
used only by that host, although exceptions exist as noted later on
this page.
The symmetric keys file, normally called
-<samp>ntp.keys</samp>,
+<samp class="file">ntp.keys</samp>,
is usually installed in
-<samp>/etc</samp>.
+<samp class="file">/etc</samp>.
Other files and links are usually installed in
-<samp>/usr/local/etc</samp>,
+<samp class="file">/usr/local/etc</samp>,
which is normally in a shared filesystem in
NFS-mounted networks and cannot be changed by shared clients.
In these cases, NFS clients can specify the files in another
directory such as
-<samp>/etc</samp>
+<samp class="file">/etc</samp>
using the
-<code>keysdir</code>
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">keysdir</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
configuration file command.
</p>
<p>This program directs commentary and error messages to the standard
error stream
-<samp>stderr</samp>
+<samp class="file">stderr</samp>
and remote files to the standard output stream
-<samp>stdout</samp>
+<samp class="file">stdout</samp>
where they can be piped to other applications or redirected to files.
The names used for generated files and links all begin with the
string
-<samp>ntpkey*</samp>
+<samp class="file">ntpkey*</samp>
and include the file type, generating host and filestamp,
as described in the
-<a href="#Cryptographic-Data-Files">Cryptographic Data Files</a>
+<a class="ref" href="#Cryptographic-Data-Files">Cryptographic Data Files</a>
section below.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-usage" accesskey="1">ntp-keygen help/usage (<samp>--help</samp>)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-imbits" accesskey="2">imbits option (-b)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-certificate" accesskey="3">certificate option (-c)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-cipher" accesskey="4">cipher option (-C)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-id_002dkey" accesskey="5">id-key option (-e)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-gq_002dparams" accesskey="6">gq-params option (-G)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-host_002dkey" accesskey="7">host-key option (-H)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-iffkey" accesskey="8">iffkey option (-I)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-ident" accesskey="9">ident option (-i)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-lifetime">lifetime option (-l)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-modulus">modulus option (-m)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-md5key">md5key option (-M)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-pvt_002dcert">pvt-cert option (-P)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-password">password option (-p)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-export_002dpasswd">export-passwd option (-q)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-subject_002dname">subject-name option (-s)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-sign_002dkey">sign-key option (-S)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-trusted_002dcert">trusted-cert option (-T)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-mv_002dparams">mv-params option (-V)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-mv_002dkeys">mv-keys option (-v)</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-config">presetting/configuring ntp-keygen</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
-<span id="Running-the-Program-2"></span><h4 class="subsection">1.2.1 Running the Program</h4>
+<ul class="mini-toc">
+<li><a href="#Running-the-Program-2" accesskey="1">Running the Program</a></li>
+<li><a href="#ntp_002dkeygen-usage" accesskey="2">ntp-keygen help/usage (<samp class="option">--help</samp>)</a></li>
+<li><a href="#ntp_002dkeygen-imbits" accesskey="3">imbits option (-b)</a></li>
+<li><a href="#ntp_002dkeygen-certificate" accesskey="4">certificate option (-c)</a></li>
+<li><a href="#ntp_002dkeygen-cipher" accesskey="5">cipher option (-C)</a></li>
+<li><a href="#ntp_002dkeygen-id_002dkey" accesskey="6">id-key option (-e)</a></li>
+<li><a href="#ntp_002dkeygen-gq_002dparams" accesskey="7">gq-params option (-G)</a></li>
+<li><a href="#ntp_002dkeygen-host_002dkey" accesskey="8">host-key option (-H)</a></li>
+<li><a href="#ntp_002dkeygen-iffkey" accesskey="9">iffkey option (-I)</a></li>
+<li><a href="#ntp_002dkeygen-ident">ident option (-i)</a></li>
+<li><a href="#ntp_002dkeygen-lifetime">lifetime option (-l)</a></li>
+<li><a href="#ntp_002dkeygen-modulus">modulus option (-m)</a></li>
+<li><a href="#ntp_002dkeygen-md5key">md5key option (-M)</a></li>
+<li><a href="#ntp_002dkeygen-pvt_002dcert">pvt-cert option (-P)</a></li>
+<li><a href="#ntp_002dkeygen-password">password option (-p)</a></li>
+<li><a href="#ntp_002dkeygen-export_002dpasswd">export-passwd option (-q)</a></li>
+<li><a href="#ntp_002dkeygen-subject_002dname">subject-name option (-s)</a></li>
+<li><a href="#ntp_002dkeygen-sign_002dkey">sign-key option (-S)</a></li>
+<li><a href="#ntp_002dkeygen-trusted_002dcert">trusted-cert option (-T)</a></li>
+<li><a href="#ntp_002dkeygen-mv_002dparams">mv-params option (-V)</a></li>
+<li><a href="#ntp_002dkeygen-mv_002dkeys">mv-keys option (-v)</a></li>
+<li><a href="#ntp_002dkeygen-config">presetting/configuring ntp-keygen</a></li>
+<li><a href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a></li>
+<li><a href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a></li>
+<li><a href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a></li>
+<li><a href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a></li>
+</ul>
+<div class="subsection-level-extent" id="Running-the-Program-2">
+<h4 class="subsection subsubsection-level-set-subsection"><span>1.2.1 Running the Program<a class="copiable-link" href="#Running-the-Program-2"> ¶</a></span></h4>
<p>The safest way to run the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program is logged in directly as root.
The recommended procedure is change to the
-<kbd>keys</kbd>
+<kbd class="kbd">keys</kbd>
directory, usually
-<samp>/usr/local/etc</samp>,
+<samp class="file">/usr/local/etc</samp>,
then run the program.
</p>
<p>To test and gain experience with Autokey concepts, log in as root and
change to the
-<kbd>keys</kbd>
+<kbd class="kbd">keys</kbd>
directory, usually
-<samp>/usr/local/etc</samp>.
+<samp class="file">/usr/local/etc</samp>.
When run for the first time, or if all files with names beginning with
-<samp>ntpkey*</samp>
+<samp class="file">ntpkey*</samp>
have been removed, use the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
command without arguments to generate a default
-<code>RSA</code>
+<code class="code">RSA</code>
host key and matching
-<code>RSA-MD5</code>
+<code class="code">RSA-MD5</code>
certificate file with expiration date one year hence,
which is all that is necessary in many cases.
The program also generates soft links from the generic names
new expiration date one year hence, and soft link.
</p>
<p>The host key is used to encrypt the cookie when required and so must be
-<code>RSA</code>
+<code class="code">RSA</code>
type.
By default, the host key is also the sign key used to encrypt signatures.
When necessary, a different sign key can be specified and this can be
either
-<code>RSA</code>
+<code class="code">RSA</code>
or
-<code>DSA</code>
+<code class="code">DSA</code>
type.
By default, the message digest type is
-<code>MD5</code>,
+<code class="code">MD5</code>,
but any combination
of sign key type and message digest type supported by the OpenSSL library
can be specified, including those using the
-<code>AES128CMAC</code>, <code>MD2</code>, <code>MD5</code>, <code>MDC2</code>, <code>SHA</code>, <code>SHA1</code>
+<code class="code">AES128CMAC</code>, <code class="code">MD2</code>, <code class="code">MD5</code>, <code class="code">MDC2</code>, <code class="code">SHA</code>, <code class="code">SHA1</code>
and
-<code>RIPE160</code>
+<code class="code">RIPE160</code>
message digest algorithms.
However, the scheme specified in the certificate must be compatible
with the sign key.
Certificates using any digest algorithm are compatible with
-<code>RSA</code>
+<code class="code">RSA</code>
sign keys;
however, only
-<code>SHA</code>
+<code class="code">SHA</code>
and
-<code>SHA1</code>
+<code class="code">SHA1</code>
certificates are compatible with
-<code>DSA</code>
+<code class="code">DSA</code>
sign keys.
</p>
<p>Private/public key files and certificates are compatible with
as the other files, are probably not compatible with anything other than Autokey.
</p>
<p>Running the program as other than root and using the Unix
-<code>su(1)</code>
+<code class="code">su(1)</code>
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-<samp>.rnd</samp>
+<samp class="file">.rnd</samp>
in the user home directory.
However, there should be only one
-<samp>.rnd</samp>,
+<samp class="file">.rnd</samp>,
most conveniently
in the root directory, so it is convenient to define the
.Ev RANDFILE
environment variable used by the OpenSSL library as the path to
-<samp>.rnd</samp>.
+<samp class="file">.rnd</samp>.
</p>
<p>Installing the keys as root might not work in NFS-mounted
shared file systems, as NFS clients may not be able to write
to the shared keys directory, even as root.
In this case, NFS clients can specify the files in another
directory such as
-<samp>/etc</samp>
+<samp class="file">/etc</samp>
using the
-<code>keysdir</code>
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">keysdir</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
configuration file command.
There is no need for one client to read the keys and certificates
of other clients or servers, as these data are obtained automatically
while the trusted name is used for the identity files.
</p>
<p>All files are installed by default in the keys directory
-<samp>/usr/local/etc</samp>,
+<samp class="file">/usr/local/etc</samp>,
which is normally in a shared filesystem
in NFS-mounted networks.
The actual location of the keys directory
and these files permitted world readable,
which simplifies maintenance in shared file systems.
Since uniqueness is insured by the
-<kbd>hostname</kbd>
+<kbd class="kbd">hostname</kbd>
and
-<kbd>filestamp</kbd>
+<kbd class="kbd">filestamp</kbd>
file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
</p>
This allows new file generations to be activated simply
by changing the link.
If a link is present,
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
follows it to the file name to extract the
-<kbd>filestamp</kbd>.
+<kbd class="kbd">filestamp</kbd>.
If a link is not present,
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
extracts the
-<kbd>filestamp</kbd>
+<kbd class="kbd">filestamp</kbd>
from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program uses the same
-<kbd>filestamp</kbd>
+<kbd class="kbd">filestamp</kbd>
extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
</p>
<p>Run the command on as many hosts as necessary.
Designate one of them as the trusted host (TH) using
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
with the
-<code>-T</code>
+<code class="code">-T</code>
option and configure it to synchronize from reliable Internet servers.
Then configure the other hosts to synchronize to the TH directly or
indirectly.
By default, the host key is also the sign key used to encrypt
signatures.
A different sign key can be assigned using the
-<code>-S</code>
+<code class="code">-S</code>
option and this can be either
-<code>RSA</code>
+<code class="code">RSA</code>
or
-<code>DSA</code>
+<code class="code">DSA</code>
type.
By default, the signature
message digest type is
-<code>MD5</code>,
+<code class="code">MD5</code>,
but any combination of sign key type and
message digest type supported by the OpenSSL library can be specified
using the
-<code>-c</code>
+<code class="code">-c</code>
option.
</p>
<p>The rules say cryptographic media should be generated with proventic
page.
</p>
<p>File names begin with the prefix
-<samp>ntpkey</samp>_
+<samp class="file">ntpkey</samp>_
and end with the suffix
-<samp>_</samp><kbd>hostname</kbd>. <kbd>filestamp</kbd>,
+<samp class="file">_</samp><kbd class="kbd">hostname</kbd>. <kbd class="kbd">filestamp</kbd>,
where
-<kbd>hostname</kbd>
+<kbd class="kbd">hostname</kbd>
is the owner name, usually the string returned
by the Unix
-<code>hostname(1)</code>
+<code class="code">hostname(1)</code>
command, and
-<kbd>filestamp</kbd>
+<kbd class="kbd">filestamp</kbd>
is the NTP seconds when the file was generated, in decimal digits.
This both guarantees uniqueness and simplifies maintenance
procedures, since all files can be quickly removed
by a
-<code>rm</code> <samp>ntpkey*</samp>
+<code class="code">rm</code> <samp class="file">ntpkey*</samp>
command or all files generated
at a specific time can be removed by a
-<code>rm</code> <samp>*</samp><kbd>filestamp</kbd>
+<code class="code">rm</code> <samp class="file">*</samp><kbd class="kbd">filestamp</kbd>
command.
To further reduce the risk of misconfiguration,
the first two lines of a file contain the file name
and generation date and time as comments.
</p>
-<span id="Trusted-Hosts-and-Groups"></span><h4 class="subsubsection">1.2.1.1 Trusted Hosts and Groups</h4>
+<ul class="mini-toc">
+<li><a href="#Trusted-Hosts-and-Groups" accesskey="1">Trusted Hosts and Groups</a></li>
+<li><a href="#Identity-Schemes" accesskey="2">Identity Schemes</a></li>
+<li><a href="#Command-Line-Options" accesskey="3">Command Line Options</a></li>
+<li><a href="#Random-Seed-File-1" accesskey="4">Random Seed File</a></li>
+<li><a href="#Cryptographic-Data-Files-1" accesskey="5">Cryptographic Data Files</a></li>
+</ul>
+<div class="subsubsection-level-extent" id="Trusted-Hosts-and-Groups">
+<h4 class="subsubsection"><span>1.2.1.1 Trusted Hosts and Groups<a class="copiable-link" href="#Trusted-Hosts-and-Groups"> ¶</a></span></h4>
<p>Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
‘Authentication Options’
section of
-<code>ntp.conf(5)</code>.
+<code class="code">ntp.conf(5)</code>.
The default cryptotype uses
-<code>RSA</code>
+<code class="code">RSA</code>
encryption,
-<code>MD5</code>
+<code class="code">MD5</code>
message digest
and
-<code>TC</code>
+<code class="code">TC</code>
identification.
First, configure a NTP subnet including one or more low-stratum
trusted hosts from which all other hosts derive synchronization
or dynamic means described on the
‘Automatic NTP Configuration Options’
section of
-<code>ntp.conf(5)</code>.
+<code class="code">ntp.conf(5)</code>.
</p>
<p>On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-<samp>ntpkey</samp>
+<samp class="file">ntpkey</samp>
files.
Then run
-<code>ntp-keygen</code>
-<code>-T</code>
+<code class="code">ntp-keygen</code>
+<code class="code">-T</code>
to generate keys and a trusted certificate.
On all other hosts do the same, but leave off the
-<code>-T</code>
+<code class="code">-T</code>
flag to generate keys and nontrusted certificates.
When complete, start the NTP daemons beginning at the lowest stratum
and working up the tree.
</p>
<p>If it is necessary to use a different sign key or different digest/signature
scheme than the default, run
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
with the
-<code>-S</code> <kbd>type</kbd>
+<code class="code">-S</code> <kbd class="kbd">type</kbd>
option, where
-<kbd>type</kbd>
+<kbd class="kbd">type</kbd>
is either
-<code>RSA</code>
+<code class="code">RSA</code>
or
-<code>DSA</code>.
+<code class="code">DSA</code>.
The most frequent need to do this is when a
-<code>DSA</code>-signed
+<code class="code">DSA</code>-signed
certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
with the
-<code>-c</code> <kbd>scheme</kbd>
+<code class="code">-c</code> <kbd class="kbd">scheme</kbd>
option and selected
-<kbd>scheme</kbd>
+<kbd class="kbd">scheme</kbd>
as needed.
If
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
is run again without these options, it generates a new certificate
using the same scheme and sign key, and soft link.
</p>
<p>After setting up the environment it is advisable to update certificates
from time to time, if only to extend the validity interval.
Simply run
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
with the same flags as before to generate new certificates
using existing keys, and soft links.
However, if the host or sign key is changed,
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
should be restarted.
When
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
is restarted, it loads any new files and restarts the protocol.
Other dependent hosts will continue as usual until signatures are refreshed,
at which time the protocol is restarted.
</p>
-<span id="Identity-Schemes"></span><h4 class="subsubsection">1.2.1.2 Identity Schemes</h4>
+</div>
+<div class="subsubsection-level-extent" id="Identity-Schemes">
+<h4 class="subsubsection"><span>1.2.1.2 Identity Schemes<a class="copiable-link" href="#Identity-Schemes"> ¶</a></span></h4>
<p>As mentioned on the Autonomous Authentication page,
the default
-<code>TC</code>
+<code class="code">TC</code>
identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
including
-<code>PC</code>, <code>IFF</code>, <code>GQ</code>
+<code class="code">PC</code>, <code class="code">IFF</code>, <code class="code">GQ</code>
and
-<code>MV</code>
+<code class="code">MV</code>
schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
</p>
<p>The PC scheme supports only one trusted host in the group.
On trusted host alice run
-<code>ntp-keygen</code>
-<code>-P</code>
-<code>-p</code> <kbd>password</kbd>
+<code class="code">ntp-keygen</code>
+<code class="code">-P</code>
+<code class="code">-p</code> <kbd class="kbd">password</kbd>
to generate the host key file
-<samp>ntpkey</samp>_ <code>RSA</code> <samp>key_alice.</samp> <kbd>filestamp</kbd>
+<samp class="file">ntpkey</samp>_ <code class="code">RSA</code> <samp class="file">key_alice.</samp> <kbd class="kbd">filestamp</kbd>
and trusted private certificate file
-<samp>ntpkey</samp>_ <code>RSA-MD5</code> <code>_</code> <samp>cert_alice.</samp> <kbd>filestamp</kbd>,
+<samp class="file">ntpkey</samp>_ <code class="code">RSA-MD5</code> <code class="code">_</code> <samp class="file">cert_alice.</samp> <kbd class="kbd">filestamp</kbd>,
and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
On each host
-<kbd>bob</kbd>
+<kbd class="kbd">bob</kbd>
install a soft link from the generic name
-<samp>ntpkey_host_</samp><kbd>bob</kbd>
+<samp class="file">ntpkey_host_</samp><kbd class="kbd">bob</kbd>
to the host key file and soft link
-<samp>ntpkey_cert_</samp><kbd>bob</kbd>
+<samp class="file">ntpkey_cert_</samp><kbd class="kbd">bob</kbd>
to the private certificate file.
Note the generic links are on bob, but point to files generated
by trusted host alice.
to all other hosts in the group, and recreating the soft links.
</p>
<p>For the
-<code>IFF</code>
+<code class="code">IFF</code>
scheme proceed as in the
-<code>TC</code>
+<code class="code">TC</code>
scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
generate the
-<code>IFF</code>
+<code class="code">IFF</code>
parameter file.
On trusted host alice run
-<code>ntp-keygen</code>
-<code>-T</code>
-<code>-I</code>
-<code>-p</code> <kbd>password</kbd>
+<code class="code">ntp-keygen</code>
+<code class="code">-T</code>
+<code class="code">-I</code>
+<code class="code">-p</code> <kbd class="kbd">password</kbd>
to produce her parameter file
-<samp>ntpkey_IFFpar_alice.</samp><kbd>filestamp</kbd>,
+<samp class="file">ntpkey_IFFpar_alice.</samp><kbd class="kbd">filestamp</kbd>,
which includes both server and client keys.
Copy this file to all group hosts that operate as both servers
and clients and install a soft link from the generic
-<samp>ntpkey_iff_alice</samp>
+<samp class="file">ntpkey_iff_alice</samp>
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
As the
-<code>IFF</code>
+<code class="code">IFF</code>
scheme is independent
of keys and certificates, these files can be refreshed as needed.
</p>
To eliminate this threat, the client keys can be extracted
from the parameter file and distributed to all restricted clients.
After generating the parameter file, on alice run
-<code>ntp-keygen</code>
-<code>-e</code>
+<code class="code">ntp-keygen</code>
+<code class="code">-e</code>
and pipe the output to a file or email program.
Copy or email this file to all restricted clients.
On these clients install a soft link from the generic
-<samp>ntpkey_iff_alice</samp>
+<samp class="file">ntpkey_iff_alice</samp>
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
</p>
<p>For the
-<code>GQ</code>
+<code class="code">GQ</code>
scheme proceed as in the
-<code>TC</code>
+<code class="code">TC</code>
scheme to generate keys
and certificates for all group hosts, then for every trusted host
in the group, generate the
-<code>IFF</code>
+<code class="code">IFF</code>
parameter file.
On trusted host alice run
-<code>ntp-keygen</code>
-<code>-T</code>
-<code>-G</code>
-<code>-p</code> <kbd>password</kbd>
+<code class="code">ntp-keygen</code>
+<code class="code">-T</code>
+<code class="code">-G</code>
+<code class="code">-p</code> <kbd class="kbd">password</kbd>
to produce her parameter file
-<samp>ntpkey_GQpar_alice.</samp><kbd>filestamp</kbd>,
+<samp class="file">ntpkey_GQpar_alice.</samp><kbd class="kbd">filestamp</kbd>,
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-<samp>ntpkey_gq_alice</samp>
+<samp class="file">ntpkey_gq_alice</samp>
to this file.
In addition, on each host
-<kbd>bob</kbd>
+<kbd class="kbd">bob</kbd>
install a soft link
from generic
-<samp>ntpkey_gq_</samp><kbd>bob</kbd>
+<samp class="file">ntpkey_gq_</samp><kbd class="kbd">bob</kbd>
to this file.
As the
-<code>GQ</code>
+<code class="code">GQ</code>
scheme updates the
-<code>GQ</code>
+<code class="code">GQ</code>
parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
</p>
<p>For the
-<code>MV</code>
+<code class="code">MV</code>
scheme, proceed as in the
-<code>TC</code>
+<code class="code">TC</code>
scheme to generate keys
and certificates for all group hosts.
For illustration assume trish is the TA, alice one of several trusted hosts
and bob one of her clients.
On TA trish run
-<code>ntp-keygen</code>
-<code>-V</code> <kbd>n</kbd>
-<code>-p</code> <kbd>password</kbd>,
+<code class="code">ntp-keygen</code>
+<code class="code">-V</code> <kbd class="kbd">n</kbd>
+<code class="code">-p</code> <kbd class="kbd">password</kbd>,
where
-<kbd>n</kbd>
+<kbd class="kbd">n</kbd>
is the number of revokable keys (typically 5) to produce
the parameter file
-<samp>ntpkeys_MVpar_trish.</samp><kbd>filestamp</kbd>
+<samp class="file">ntpkeys_MVpar_trish.</samp><kbd class="kbd">filestamp</kbd>
and client key files
-<samp>ntpkeys_MVkey</samp><kbd>d</kbd> <kbd>_</kbd> <samp>trish.</samp> <kbd>filestamp</kbd>
+<samp class="file">ntpkeys_MVkey</samp><kbd class="kbd">d</kbd> <kbd class="kbd">_</kbd> <samp class="file">trish.</samp> <kbd class="kbd">filestamp</kbd>
where
-<kbd>d</kbd>
+<kbd class="kbd">d</kbd>
is the key number (0 <
-<kbd>d</kbd>
+<kbd class="kbd">d</kbd>
<
-<kbd>n</kbd>).
+<kbd class="kbd">n</kbd>).
Copy the parameter file to alice and install a soft link
from the generic
-<samp>ntpkey_mv_alice</samp>
+<samp class="file">ntpkey_mv_alice</samp>
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
since they all work the same way.
Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-<samp>ntpkey_mvkey_bob</samp>
+<samp class="file">ntpkey_mvkey_bob</samp>
to the client key file.
As the
-<code>MV</code>
+<code class="code">MV</code>
scheme is independent of keys and certificates,
these files can be refreshed as needed.
</p>
-<span id="Command-Line-Options"></span><h4 class="subsubsection">1.2.1.3 Command Line Options</h4>
-<dl compact="compact">
-<dt><code>-b</code> <code>--imbits</code>= <kbd>modulus</kbd></dt>
+</div>
+<div class="subsubsection-level-extent" id="Command-Line-Options">
+<h4 class="subsubsection"><span>1.2.1.3 Command Line Options<a class="copiable-link" href="#Command-Line-Options"> ¶</a></span></h4>
+<dl class="table">
+<dt><code class="code">-b</code> <code class="code">--imbits</code>= <kbd class="kbd">modulus</kbd></dt>
<dd><p>Set the number of bits in the identity modulus for generating identity keys to
-<kbd>modulus</kbd>
+<kbd class="kbd">modulus</kbd>
bits.
The number of bits in the identity modulus defaults to 256, but can be set to
values from 256 to 2048 (32 to 256 octets).
Use the larger moduli with caution, as this can consume considerable computing
resources and increases the size of authenticated packets.
</p></dd>
-<dt><code>-c</code> <code>--certificate</code>= <kbd>scheme</kbd></dt>
+<dt><code class="code">-c</code> <code class="code">--certificate</code>= <kbd class="kbd">scheme</kbd></dt>
<dd><p>Select certificate signature encryption/message digest scheme.
The
-<kbd>scheme</kbd>
+<kbd class="kbd">scheme</kbd>
can be one of the following:
-<code>RSA-MD2</code>, <code>RSA-MD5</code>, <code>RSA-MDC2</code>, <code>RSA-SHA</code>, <code>RSA-SHA1</code>, <code>RSA-RIPEMD160</code>, <code>DSA-SHA</code>,
+<code class="code">RSA-MD2</code>, <code class="code">RSA-MD5</code>, <code class="code">RSA-MDC2</code>, <code class="code">RSA-SHA</code>, <code class="code">RSA-SHA1</code>, <code class="code">RSA-RIPEMD160</code>, <code class="code">DSA-SHA</code>,
or
-<code>DSA-SHA1</code>.
+<code class="code">DSA-SHA1</code>.
Note that
-<code>RSA</code>
+<code class="code">RSA</code>
schemes must be used with an
-<code>RSA</code>
+<code class="code">RSA</code>
sign key and
-<code>DSA</code>
+<code class="code">DSA</code>
schemes must be used with a
-<code>DSA</code>
+<code class="code">DSA</code>
sign key.
The default without this option is
-<code>RSA-MD5</code>.
+<code class="code">RSA-MD5</code>.
If compatibility with FIPS 140-2 is required, either the
-<code>DSA-SHA</code>
+<code class="code">DSA-SHA</code>
or
-<code>DSA-SHA1</code>
+<code class="code">DSA-SHA1</code>
scheme must be used.
</p></dd>
-<dt><code>-C</code> <code>--cipher</code>= <kbd>cipher</kbd></dt>
+<dt><code class="code">-C</code> <code class="code">--cipher</code>= <kbd class="kbd">cipher</kbd></dt>
<dd><p>Select the OpenSSL cipher to encrypt the files containing private keys.
The default without this option is three-key triple DES in CBC mode,
-<code>des-ede3-cbc</code>.
+<code class="code">des-ede3-cbc</code>.
The
-<code>openssl</code> <code>-h</code>
+<code class="code">openssl</code> <code class="code">-h</code>
command provided with OpenSSL displays available ciphers.
</p></dd>
-<dt><code>-d</code> <code>--debug-level</code></dt>
+<dt><code class="code">-d</code> <code class="code">--debug-level</code></dt>
<dd><p>Increase debugging verbosity level.
This option displays the cryptographic data produced in eye-friendly billboards.
</p></dd>
-<dt><code>-D</code> <code>--set-debug-level</code>= <kbd>level</kbd></dt>
+<dt><code class="code">-D</code> <code class="code">--set-debug-level</code>= <kbd class="kbd">level</kbd></dt>
<dd><p>Set the debugging verbosity to
-<kbd>level</kbd>.
+<kbd class="kbd">level</kbd>.
This option displays the cryptographic data produced in eye-friendly billboards.
</p></dd>
-<dt><code>-e</code> <code>--id-key</code></dt>
+<dt><code class="code">-e</code> <code class="code">--id-key</code></dt>
<dd><p>Write the
-<code>IFF</code>
+<code class="code">IFF</code>
or
-<code>GQ</code>
+<code class="code">GQ</code>
public parameters from the
-<kbd>IFFkey</kbd> <kbd>or</kbd> <kbd>GQkey</kbd>
+<kbd class="kbd">IFFkey</kbd> <kbd class="kbd">or</kbd> <kbd class="kbd">GQkey</kbd>
client keys file previously specified
as unencrypted data to the standard output stream
-<samp>stdout</samp>.
+<samp class="file">stdout</samp>.
This is intended for automatic key distribution by email.
</p></dd>
-<dt><code>-G</code> <code>--gq-params</code></dt>
+<dt><code class="code">-G</code> <code class="code">--gq-params</code></dt>
<dd><p>Generate a new encrypted
-<code>GQ</code>
+<code class="code">GQ</code>
parameters and key file for the Guillou-Quisquater (GQ) identity scheme.
This option is mutually exclusive with the
-<code>-I</code>
+<code class="code">-I</code>
and
-<code>-V</code>
+<code class="code">-V</code>
options.
</p></dd>
-<dt><code>-H</code> <code>--host-key</code></dt>
+<dt><code class="code">-H</code> <code class="code">--host-key</code></dt>
<dd><p>Generate a new encrypted
-<code>RSA</code>
+<code class="code">RSA</code>
public/private host key file.
</p></dd>
-<dt><code>-I</code> <code>--iffkey</code></dt>
+<dt><code class="code">-I</code> <code class="code">--iffkey</code></dt>
<dd><p>Generate a new encrypted
-<code>IFF</code>
+<code class="code">IFF</code>
key file for the Schnorr (IFF) identity scheme.
This option is mutually exclusive with the
-<code>-G</code>
+<code class="code">-G</code>
and
Fl V
options.
</p></dd>
-<dt><code>-i</code> <code>--ident</code>= <kbd>group</kbd></dt>
+<dt><code class="code">-i</code> <code class="code">--ident</code>= <kbd class="kbd">group</kbd></dt>
<dd><p>Set the optional Autokey group name to
-<kbd>group</kbd>.
+<kbd class="kbd">group</kbd>.
This is used in the identity scheme parameter file names of
-<code>IFF</code>, <code>GQ</code>,
+<code class="code">IFF</code>, <code class="code">GQ</code>,
and
-<code>MV</code>
+<code class="code">MV</code>
client parameters files.
In that role, the default is the host name if no group is provided.
The group name, if specified using
-<code>-i</code>
+<code class="code">-i</code>
or
-<code>-s</code>
+<code class="code">-s</code>
following an
‘@’
character, is also used in certificate subject and issuer names in the form
-<kbd>host</kbd> <kbd>@</kbd> <kbd>group</kbd>
+<kbd class="kbd">host</kbd> <kbd class="kbd">@</kbd> <kbd class="kbd">group</kbd>
and should match the group specified via
-<code>crypto</code> <code>ident</code>
+<code class="code">crypto</code> <code class="code">ident</code>
or
-<code>server</code> <code>ident</code>
+<code class="code">server</code> <code class="code">ident</code>
in the ntpd configuration file.
</p></dd>
-<dt><code>-l</code> <code>--lifetime</code>= <kbd>days</kbd></dt>
+<dt><code class="code">-l</code> <code class="code">--lifetime</code>= <kbd class="kbd">days</kbd></dt>
<dd><p>Set the lifetime for certificate expiration to
-<kbd>days</kbd>.
+<kbd class="kbd">days</kbd>.
The default lifetime is one year (365 days).
</p></dd>
-<dt><code>-m</code> <code>--modulus</code>= <kbd>bits</kbd></dt>
+<dt><code class="code">-m</code> <code class="code">--modulus</code>= <kbd class="kbd">bits</kbd></dt>
<dd><p>Set the number of bits in the prime modulus for generating files to
-<kbd>bits</kbd>.
+<kbd class="kbd">bits</kbd>.
The modulus defaults to 512, but can be set from 256 to 2048 (32 to 256 octets).
Use the larger moduli with caution, as this can consume considerable computing
resources and increases the size of authenticated packets.
</p></dd>
-<dt><code>-M</code> <code>--md5key</code></dt>
+<dt><code class="code">-M</code> <code class="code">--md5key</code></dt>
<dd><p>Generate a new symmetric keys file containing 10
-<code>MD5</code>
+<code class="code">MD5</code>
keys, and if OpenSSL is available, 10
-<code>SHA</code>
+<code class="code">SHA</code>
keys.
An
-<code>MD5</code>
+<code class="code">MD5</code>
key is a string of 20 random printable ASCII characters, while a
-<code>SHA</code>
+<code class="code">SHA</code>
key is a string of 40 random hex digits.
The file can be edited using a text editor to change the key type or key content.
This option is mutually exclusive with all other options.
</p></dd>
-<dt><code>-p</code> <code>--password</code>= <kbd>passwd</kbd></dt>
+<dt><code class="code">-p</code> <code class="code">--password</code>= <kbd class="kbd">passwd</kbd></dt>
<dd><p>Set the password for reading and writing encrypted files to
-<kbd>passwd</kbd>.
+<kbd class="kbd">passwd</kbd>.
These include the host, sign and identify key files.
By default, the password is the string returned by the Unix
-<code>hostname</code>
+<code class="code">hostname</code>
command.
</p></dd>
-<dt><code>-P</code> <code>--pvt-cert</code></dt>
+<dt><code class="code">-P</code> <code class="code">--pvt-cert</code></dt>
<dd><p>Generate a new private certificate used by the
-<code>PC</code>
+<code class="code">PC</code>
identity scheme.
By default, the program generates public certificates.
Note: the PC identity scheme is not recommended for new installations.
</p></dd>
-<dt><code>-q</code> <code>--export-passwd</code>= <kbd>passwd</kbd></dt>
+<dt><code class="code">-q</code> <code class="code">--export-passwd</code>= <kbd class="kbd">passwd</kbd></dt>
<dd><p>Set the password for writing encrypted
-<code>IFF</code>, <code>GQ</code> <code>and</code> <code>MV</code>
+<code class="code">IFF</code>, <code class="code">GQ</code> <code class="code">and</code> <code class="code">MV</code>
identity files redirected to
-<samp>stdout</samp>
+<samp class="file">stdout</samp>
to
-<kbd>passwd</kbd>.
+<kbd class="kbd">passwd</kbd>.
In effect, these files are decrypted with the
-<code>-p</code>
+<code class="code">-p</code>
password, then encrypted with the
-<code>-q</code>
+<code class="code">-q</code>
password.
By default, the password is the string returned by the Unix
-<code>hostname</code>
+<code class="code">hostname</code>
command.
</p></dd>
-<dt><code>-s</code> <code>--subject-key</code>= <code>[host]</code> <code>[@ <kbd>group</kbd>]</code></dt>
+<dt><code class="code">-s</code> <code class="code">--subject-key</code>= <code class="code">[host]</code> <code class="code">[@ <kbd class="kbd">group</kbd>]</code></dt>
<dd><p>Specify the Autokey host name, where
-<kbd>host</kbd>
+<kbd class="kbd">host</kbd>
is the optional host name and
-<kbd>group</kbd>
+<kbd class="kbd">group</kbd>
is the optional group name.
The host name, and if provided, group name are used in
-<kbd>host</kbd> <kbd>@</kbd> <kbd>group</kbd>
+<kbd class="kbd">host</kbd> <kbd class="kbd">@</kbd> <kbd class="kbd">group</kbd>
form as certificate subject and issuer.
Specifying
-<code>-s</code> <code>-@</code> <kbd>group</kbd>
+<code class="code">-s</code> <code class="code">-@</code> <kbd class="kbd">group</kbd>
is allowed, and results in leaving the host name unchanged, as with
-<code>-i</code> <kbd>group</kbd>.
+<code class="code">-i</code> <kbd class="kbd">group</kbd>.
The group name, or if no group is provided, the host name are also used in the
file names of
-<code>IFF</code>, <code>GQ</code>,
+<code class="code">IFF</code>, <code class="code">GQ</code>,
and
-<code>MV</code>
+<code class="code">MV</code>
identity scheme client parameter files.
If
-<kbd>host</kbd>
+<kbd class="kbd">host</kbd>
is not specified, the default host name is the string returned by the Unix
-<code>hostname</code>
+<code class="code">hostname</code>
command.
</p></dd>
-<dt><code>-S</code> <code>--sign-key</code>= <code>[<code>RSA</code> | <code>DSA</code>]</code></dt>
+<dt><code class="code">-S</code> <code class="code">--sign-key</code>= <code class="code">[<code class="code">RSA</code> | <code class="code">DSA</code>]</code></dt>
<dd><p>Generate a new encrypted public/private sign key file of the specified type.
By default, the sign key is the host key and has the same type.
If compatibility with FIPS 140-2 is required, the sign key type must be
-<code>DSA</code>.
+<code class="code">DSA</code>.
</p></dd>
-<dt><code>-T</code> <code>--trusted-cert</code></dt>
+<dt><code class="code">-T</code> <code class="code">--trusted-cert</code></dt>
<dd><p>Generate a trusted certificate.
By default, the program generates a non-trusted certificate.
</p></dd>
-<dt><code>-V</code> <code>--mv-params</code> <kbd>nkeys</kbd></dt>
+<dt><code class="code">-V</code> <code class="code">--mv-params</code> <kbd class="kbd">nkeys</kbd></dt>
<dd><p>Generate
-<kbd>nkeys</kbd>
+<kbd class="kbd">nkeys</kbd>
encrypted server keys and parameters for the Mu-Varadharajan (MV)
identity scheme.
This option is mutually exclusive with the
-<code>-I</code>
+<code class="code">-I</code>
and
-<code>-G</code>
+<code class="code">-G</code>
options.
Note: support for this option should be considered a work in progress.
</p></dd>
</dl>
-<span id="Random-Seed-File-1"></span><h4 class="subsubsection">1.2.1.4 Random Seed File</h4>
+</div>
+<div class="subsubsection-level-extent" id="Random-Seed-File-1">
+<h4 class="subsubsection"><span>1.2.1.4 Random Seed File<a class="copiable-link" href="#Random-Seed-File-1"> ¶</a></span></h4>
<p>All cryptographically sound key generation schemes must have means
to randomize the entropy seed used to initialize
the internal pseudo-random number generator used
by the library routines.
The OpenSSL library uses a designated random seed file for this purpose.
The file must be available when starting the NTP daemon and
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program.
If a site supports OpenSSL or its companion OpenSSH,
it is very likely that means to do this are already available.
</p>
<p>The entropy seed used by the OpenSSL library is contained in a file,
usually called
-<samp>.rnd</samp>,
+<samp class="file">.rnd</samp>,
which must be available when starting the NTP daemon
or the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program.
The NTP daemon will first look for the file
using the path specified by the
-<code>randfile</code>
+<code class="code">randfile</code>
subcommand of the
-<code>crypto</code>
+<code class="code">crypto</code>
configuration command.
If not specified in this way, or when starting the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program,
the OpenSSL library will look for the file using the path specified
by the
.Ev RANDFILE
environment variable is not present,
the library will look for the
-<samp>.rnd</samp>
+<samp class="file">.rnd</samp>
file in the user home directory.
Since both the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program and
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
daemon must run as root, the logical place to put this file is in
-<samp>/.rnd</samp>
+<samp class="file">/.rnd</samp>
or
-<samp>/root/.rnd</samp>.
+<samp class="file">/root/.rnd</samp>.
If the file is not available or cannot be written,
the daemon exits with a message to the system log and the program
exits with a suitable error message.
</p>
-<span id="Cryptographic-Data-Files-1"></span><h4 class="subsubsection">1.2.1.5 Cryptographic Data Files</h4>
+</div>
+<div class="subsubsection-level-extent" id="Cryptographic-Data-Files-1">
+<h4 class="subsubsection"><span>1.2.1.5 Cryptographic Data Files<a class="copiable-link" href="#Cryptographic-Data-Files-1"> ¶</a></span></h4>
<p>All file formats begin with two nonencrypted lines.
The first line contains the file name, including the generated host name
and filestamp, in the format
-<samp>ntpkey_</samp><kbd>key</kbd> <kbd>_</kbd> <kbd>name</kbd>. <kbd>filestamp</kbd>,
+<samp class="file">ntpkey_</samp><kbd class="kbd">key</kbd> <kbd class="kbd">_</kbd> <kbd class="kbd">name</kbd>. <kbd class="kbd">filestamp</kbd>,
where
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
is the key or parameter type,
-<kbd>name</kbd>
+<kbd class="kbd">name</kbd>
is the host or group name and
-<kbd>filestamp</kbd>
+<kbd class="kbd">filestamp</kbd>
is the filestamp (NTP seconds) when the file was created.
By convention,
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
names in generated file names include both upper and lower case
characters, while
-<kbd>key</kbd>
+<kbd class="kbd">key</kbd>
names in generated link names include only lower case characters.
The filestamp is not used in generated link names.
The second line contains the datestamp in conventional Unix
-<samp>date</samp>
+<samp class="file">date</samp>
format.
Lines beginning with
‘#’
are considered comments and ignored by the
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program and
-<code>ntpd(1ntpdmdoc)</code>
+<code class="code">ntpd(1ntpdmdoc)</code>
daemon.
</p>
<p>The remainder of the file contains cryptographic data, encoded first using ASN.1
printable ASCII text, preceded and followed by MIME content identifier lines.
</p>
<p>The format of the symmetric keys file, ordinarily named
-<samp>ntp.keys</samp>,
+<samp class="file">ntp.keys</samp>,
is somewhat different than the other files in the interest of backward compatibility.
Ordinarily, the file is generated by this program, but it can be constructed
and edited using an ordinary text editor.
19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
</pre><div class="example">
-<pre class="example">Figure 1. Typical Symmetric Key File
+<pre class="example-preformatted">Figure 1. Typical Symmetric Key File
</pre></div>
<p>Figure 1 shows a typical symmetric keys file used by the reference
implementation.
Following the header the keys are entered one per line in the format
</p><div class="example">
-<pre class="example"><kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd>
+<pre class="example-preformatted"><kbd class="kbd">keyno</kbd> <kbd class="kbd">type</kbd> <kbd class="kbd">key</kbd>
</pre></div>
<p>where
-<kbd>keyno</kbd>
+<kbd class="kbd">keyno</kbd>
is a positive integer in the range 1-65535;
-<kbd>type</kbd>
+<kbd class="kbd">type</kbd>
is the key type for the message digest algorithm, which in the absence of the
OpenSSL library must be
-<code>MD5</code>
+<code class="code">MD5</code>
to designate the MD5 message digest algorithm;
if the OpenSSL library is installed, the key type can be any
message digest algorithm supported by that library;
however, if compatibility with FIPS 140-2 is required,
the key type must be either
-<code>SHA</code>
+<code class="code">SHA</code>
or
-<code>SHA1</code>;
-<kbd>key</kbd>
+<code class="code">SHA1</code>;
+<kbd class="kbd">key</kbd>
is the key itself,
which is a printable ASCII string 20 characters or less in length:
each character is chosen from the 93 printable characters
is truncated as necessary.
</p>
<p>Note that the keys used by the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
programs
are checked against passwords requested by the programs
and entered by hand, so it is generally appropriate to specify these keys
in human readable ASCII format.
</p>
<p>The
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
program generates a symmetric keys file
-<samp>ntpkey_MD5key_</samp><kbd>hostname</kbd>. <kbd>filestamp</kbd>.
+<samp class="file">ntpkey_MD5key_</samp><kbd class="kbd">hostname</kbd>. <kbd class="kbd">filestamp</kbd>.
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
The NTP daemon loads the file
-<samp>ntp.keys</samp>,
+<samp class="file">ntp.keys</samp>,
so
-<code>ntp-keygen</code>
+<code class="code">ntp-keygen</code>
installs a soft link from this name to the generated file.
Subsequently, similar soft links must be installed by manual
or automated means on the other subnet hosts.
While this file is not used with the Autokey Version 2 protocol,
it is needed to authenticate some remote configuration commands
used by the
-<code>ntpq(1ntpqmdoc)</code>
+<code class="code">ntpq(1ntpqmdoc)</code>
and
-<code>ntpdc(1ntpdcmdoc)</code>
+<code class="code">ntpdc(1ntpdcmdoc)</code>
utilities.
</p>
-<p>This section was generated by <strong>AutoGen</strong>,
-using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp-keygen</code> program.
+<p>This section was generated by <strong class="strong">AutoGen</strong>,
+using the <code class="code">agtexi-cmd</code> template and the option descriptions for the <code class="code">ntp-keygen</code> program.
This software is released under the NTP license, <http://ntp.org/license>.
</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-usage" accesskey="1">ntp-keygen usage</a></td><td> </td><td align="left" valign="top">ntp-keygen help/usage (<samp>--help</samp>)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-imbits" accesskey="2">ntp-keygen imbits</a></td><td> </td><td align="left" valign="top">imbits option (-b)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-certificate" accesskey="3">ntp-keygen certificate</a></td><td> </td><td align="left" valign="top">certificate option (-c)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-cipher" accesskey="4">ntp-keygen cipher</a></td><td> </td><td align="left" valign="top">cipher option (-C)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-id_002dkey" accesskey="5">ntp-keygen id-key</a></td><td> </td><td align="left" valign="top">id-key option (-e)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-gq_002dparams" accesskey="6">ntp-keygen gq-params</a></td><td> </td><td align="left" valign="top">gq-params option (-G)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-host_002dkey" accesskey="7">ntp-keygen host-key</a></td><td> </td><td align="left" valign="top">host-key option (-H)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-iffkey" accesskey="8">ntp-keygen iffkey</a></td><td> </td><td align="left" valign="top">iffkey option (-I)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-ident" accesskey="9">ntp-keygen ident</a></td><td> </td><td align="left" valign="top">ident option (-i)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a></td><td> </td><td align="left" valign="top">lifetime option (-l)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a></td><td> </td><td align="left" valign="top">modulus option (-m)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a></td><td> </td><td align="left" valign="top">md5key option (-M)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a></td><td> </td><td align="left" valign="top">pvt-cert option (-P)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-password">ntp-keygen password</a></td><td> </td><td align="left" valign="top">password option (-p)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a></td><td> </td><td align="left" valign="top">export-passwd option (-q)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a></td><td> </td><td align="left" valign="top">subject-name option (-s)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a></td><td> </td><td align="left" valign="top">sign-key option (-S)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a></td><td> </td><td align="left" valign="top">trusted-cert option (-T)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a></td><td> </td><td align="left" valign="top">mv-params option (-V)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a></td><td> </td><td align="left" valign="top">mv-keys option (-v)
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-config">ntp-keygen config</a></td><td> </td><td align="left" valign="top">presetting/configuring ntp-keygen
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a></td><td> </td><td align="left" valign="top">exit status
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a></td><td> </td><td align="left" valign="top">Usage
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a></td><td> </td><td align="left" valign="top">Notes
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a></td><td> </td><td align="left" valign="top">Bugs
-</td></tr>
-</table>
<hr>
-<span id="ntp_002dkeygen-usage"></span><div class="header">
+</div>
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-imbits" accesskey="n" rel="next">ntp-keygen imbits</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-imbits" accesskey="n" rel="next">imbits option (-b)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ntp_002dkeygen-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.2.2 ntp-keygen help/usage (<samp>--help</samp>)</h4>
-<span id="index-ntp_002dkeygen-help"></span>
+<h4 class="subsection" id="ntp_002dkeygen-help_002fusage-_0028_002d_002dhelp_0029"><span>1.2.2 ntp-keygen help/usage (<samp class="option">--help</samp>)<a class="copiable-link" href="#ntp_002dkeygen-help_002fusage-_0028_002d_002dhelp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen-help"></a>
<p>This is the automatically generated usage text for ntp-keygen.
</p>
-<p>The text printed is the same whether selected with the <code>help</code> option
-(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
+<p>The text printed is the same whether selected with the <code class="code">help</code> option
+(<samp class="option">--help</samp>) or the <code class="code">more-help</code> option (<samp class="option">--more-help</samp>). <code class="code">more-help</code> will print
the usage text by passing it through a pager program.
-<code>more-help</code> is disabled on platforms without a working
-<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
-used to select the program, defaulting to <samp>more</samp>. Both will exit
+<code class="code">more-help</code> is disabled on platforms without a working
+<code class="code">fork(2)</code> function. The <code class="code">PAGER</code> environment variable is
+used to select the program, defaulting to <samp class="file">more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
-<pre class="example">ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p17
+<pre class="example-preformatted">ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p17
Usage: ntp-keygen [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
Flg Arg Option-Name Description
-b Num imbits identity modulus bits
</pre></div>
<hr>
-<span id="ntp_002dkeygen-imbits"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-imbits">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-certificate" accesskey="n" rel="next">ntp-keygen certificate</a>, Previous: <a href="#ntp_002dkeygen-usage" accesskey="p" rel="prev">ntp-keygen usage</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-certificate" accesskey="n" rel="next">certificate option (-c)</a>, Previous: <a href="#ntp_002dkeygen-usage" accesskey="p" rel="prev">ntp-keygen help/usage (<samp class="option">--help</samp>)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="imbits-option-_0028_002db_0029"></span><h4 class="subsection">1.2.3 imbits option (-b)</h4>
-<span id="index-ntp_002dkeygen_002dimbits"></span>
+<h4 class="subsection" id="imbits-option-_0028_002db_0029"><span>1.2.3 imbits option (-b)<a class="copiable-link" href="#imbits-option-_0028_002db_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dimbits"></a>
<p>This is the “identity modulus bits” option.
-This option takes a number argument <samp>imbits</samp>.
+This option takes a number argument <samp class="file">imbits</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>The number of bits in the identity modulus. The default is 512.
</p><hr>
-<span id="ntp_002dkeygen-certificate"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-certificate">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-cipher" accesskey="n" rel="next">ntp-keygen cipher</a>, Previous: <a href="#ntp_002dkeygen-imbits" accesskey="p" rel="prev">ntp-keygen imbits</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-cipher" accesskey="n" rel="next">cipher option (-C)</a>, Previous: <a href="#ntp_002dkeygen-imbits" accesskey="p" rel="prev">imbits option (-b)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="certificate-option-_0028_002dc_0029"></span><h4 class="subsection">1.2.4 certificate option (-c)</h4>
-<span id="index-ntp_002dkeygen_002dcertificate"></span>
+<h4 class="subsection" id="certificate-option-_0028_002dc_0029"><span>1.2.4 certificate option (-c)<a class="copiable-link" href="#certificate-option-_0028_002dc_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dcertificate"></a>
<p>This is the “certificate scheme” option.
-This option takes a string argument <samp>scheme</samp>.
+This option takes a string argument <samp class="file">scheme</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>scheme is one of
schemes must be used with a DSA sign key. The default without
this option is RSA-MD5.
</p><hr>
-<span id="ntp_002dkeygen-cipher"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-cipher">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-id_002dkey" accesskey="n" rel="next">ntp-keygen id-key</a>, Previous: <a href="#ntp_002dkeygen-certificate" accesskey="p" rel="prev">ntp-keygen certificate</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-id_002dkey" accesskey="n" rel="next">id-key option (-e)</a>, Previous: <a href="#ntp_002dkeygen-certificate" accesskey="p" rel="prev">certificate option (-c)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="cipher-option-_0028_002dC_0029"></span><h4 class="subsection">1.2.5 cipher option (-C)</h4>
-<span id="index-ntp_002dkeygen_002dcipher"></span>
+<h4 class="subsection" id="cipher-option-_0028_002dC_0029"><span>1.2.5 cipher option (-C)<a class="copiable-link" href="#cipher-option-_0028_002dC_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dcipher"></a>
<p>This is the “privatekey cipher” option.
-This option takes a string argument <samp>cipher</samp>.
+This option takes a string argument <samp class="file">cipher</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Select the cipher which is used to encrypt the files containing
private keys. The default is three-key triple DES in CBC mode,
-equivalent to "<code>-C des-ede3-cbc</code>". The openssl tool lists ciphers
-available in "<code>openssl -h</code>" output.
+equivalent to "<code class="code">-C des-ede3-cbc</code>". The openssl tool lists ciphers
+available in "<code class="code">openssl -h</code>" output.
</p><hr>
-<span id="ntp_002dkeygen-id_002dkey"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-id_002dkey">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-gq_002dparams" accesskey="n" rel="next">ntp-keygen gq-params</a>, Previous: <a href="#ntp_002dkeygen-cipher" accesskey="p" rel="prev">ntp-keygen cipher</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-gq_002dparams" accesskey="n" rel="next">gq-params option (-G)</a>, Previous: <a href="#ntp_002dkeygen-cipher" accesskey="p" rel="prev">cipher option (-C)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="id_002dkey-option-_0028_002de_0029"></span><h4 class="subsection">1.2.6 id-key option (-e)</h4>
-<span id="index-ntp_002dkeygen_002did_002dkey"></span>
+<h4 class="subsection" id="id_002dkey-option-_0028_002de_0029"><span>1.2.6 id-key option (-e)<a class="copiable-link" href="#id_002dkey-option-_0028_002de_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002did_002dkey"></a>
<p>This is the “write iff or gq identity keys” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Write the public parameters from the IFF or GQ client keys to
the standard output.
This is intended for automatic key distribution by email.
</p><hr>
-<span id="ntp_002dkeygen-gq_002dparams"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-gq_002dparams">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-host_002dkey" accesskey="n" rel="next">ntp-keygen host-key</a>, Previous: <a href="#ntp_002dkeygen-id_002dkey" accesskey="p" rel="prev">ntp-keygen id-key</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-host_002dkey" accesskey="n" rel="next">host-key option (-H)</a>, Previous: <a href="#ntp_002dkeygen-id_002dkey" accesskey="p" rel="prev">id-key option (-e)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="gq_002dparams-option-_0028_002dG_0029"></span><h4 class="subsection">1.2.7 gq-params option (-G)</h4>
-<span id="index-ntp_002dkeygen_002dgq_002dparams"></span>
+<h4 class="subsection" id="gq_002dparams-option-_0028_002dG_0029"><span>1.2.7 gq-params option (-G)<a class="copiable-link" href="#gq_002dparams-option-_0028_002dG_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dgq_002dparams"></a>
<p>This is the “generate gq parameters and keys” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate parameters and keys for the GQ identification scheme,
obsoleting any that may exist.
</p><hr>
-<span id="ntp_002dkeygen-host_002dkey"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-host_002dkey">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-iffkey" accesskey="n" rel="next">ntp-keygen iffkey</a>, Previous: <a href="#ntp_002dkeygen-gq_002dparams" accesskey="p" rel="prev">ntp-keygen gq-params</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-iffkey" accesskey="n" rel="next">iffkey option (-I)</a>, Previous: <a href="#ntp_002dkeygen-gq_002dparams" accesskey="p" rel="prev">gq-params option (-G)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="host_002dkey-option-_0028_002dH_0029"></span><h4 class="subsection">1.2.8 host-key option (-H)</h4>
-<span id="index-ntp_002dkeygen_002dhost_002dkey"></span>
+<h4 class="subsection" id="host_002dkey-option-_0028_002dH_0029"><span>1.2.8 host-key option (-H)<a class="copiable-link" href="#host_002dkey-option-_0028_002dH_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dhost_002dkey"></a>
<p>This is the “generate rsa host key” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate new host keys, obsoleting any that may exist.
</p><hr>
-<span id="ntp_002dkeygen-iffkey"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-iffkey">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-ident" accesskey="n" rel="next">ntp-keygen ident</a>, Previous: <a href="#ntp_002dkeygen-host_002dkey" accesskey="p" rel="prev">ntp-keygen host-key</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-ident" accesskey="n" rel="next">ident option (-i)</a>, Previous: <a href="#ntp_002dkeygen-host_002dkey" accesskey="p" rel="prev">host-key option (-H)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="iffkey-option-_0028_002dI_0029"></span><h4 class="subsection">1.2.9 iffkey option (-I)</h4>
-<span id="index-ntp_002dkeygen_002diffkey"></span>
+<h4 class="subsection" id="iffkey-option-_0028_002dI_0029"><span>1.2.9 iffkey option (-I)<a class="copiable-link" href="#iffkey-option-_0028_002dI_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002diffkey"></a>
<p>This is the “generate iff parameters” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate parameters for the IFF identification scheme, obsoleting
any that may exist.
</p><hr>
-<span id="ntp_002dkeygen-ident"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-ident">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-lifetime" accesskey="n" rel="next">ntp-keygen lifetime</a>, Previous: <a href="#ntp_002dkeygen-iffkey" accesskey="p" rel="prev">ntp-keygen iffkey</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-lifetime" accesskey="n" rel="next">lifetime option (-l)</a>, Previous: <a href="#ntp_002dkeygen-iffkey" accesskey="p" rel="prev">iffkey option (-I)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ident-option-_0028_002di_0029"></span><h4 class="subsection">1.2.10 ident option (-i)</h4>
-<span id="index-ntp_002dkeygen_002dident"></span>
+<h4 class="subsection" id="ident-option-_0028_002di_0029"><span>1.2.10 ident option (-i)<a class="copiable-link" href="#ident-option-_0028_002di_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dident"></a>
<p>This is the “set autokey group name” option.
-This option takes a string argument <samp>group</samp>.
+This option takes a string argument <samp class="file">group</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Set the optional Autokey group name to name. This is used in
the file name of IFF, GQ, and MV client parameters files. In
that role, the default is the host name if this option is not
-provided. The group name, if specified using <code>-i/--ident</code> or
-using <code>-s/--subject-name</code> following an ’<code>@</code>’ character,
+provided. The group name, if specified using <code class="code">-i/--ident</code> or
+using <code class="code">-s/--subject-name</code> following an ’<code class="code">@</code>’ character,
is also a part of the self-signed host certificate subject and
-issuer names in the form <code>host@group</code> and should match the
-’<code>crypto ident</code>’ or ’<code>server ident</code>’ configuration in the
-<code>ntpd</code> configuration file.
+issuer names in the form <code class="code">host@group</code> and should match the
+’<code class="code">crypto ident</code>’ or ’<code class="code">server ident</code>’ configuration in the
+<code class="code">ntpd</code> configuration file.
</p><hr>
-<span id="ntp_002dkeygen-lifetime"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-lifetime">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-modulus" accesskey="n" rel="next">ntp-keygen modulus</a>, Previous: <a href="#ntp_002dkeygen-ident" accesskey="p" rel="prev">ntp-keygen ident</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-modulus" accesskey="n" rel="next">modulus option (-m)</a>, Previous: <a href="#ntp_002dkeygen-ident" accesskey="p" rel="prev">ident option (-i)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="lifetime-option-_0028_002dl_0029"></span><h4 class="subsection">1.2.11 lifetime option (-l)</h4>
-<span id="index-ntp_002dkeygen_002dlifetime"></span>
+<h4 class="subsection" id="lifetime-option-_0028_002dl_0029"><span>1.2.11 lifetime option (-l)<a class="copiable-link" href="#lifetime-option-_0028_002dl_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dlifetime"></a>
<p>This is the “set certificate lifetime” option.
-This option takes a number argument <samp>lifetime</samp>.
+This option takes a number argument <samp class="file">lifetime</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Set the certificate expiration to lifetime days from now.
</p><hr>
-<span id="ntp_002dkeygen-modulus"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-modulus">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-md5key" accesskey="n" rel="next">ntp-keygen md5key</a>, Previous: <a href="#ntp_002dkeygen-lifetime" accesskey="p" rel="prev">ntp-keygen lifetime</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-md5key" accesskey="n" rel="next">md5key option (-M)</a>, Previous: <a href="#ntp_002dkeygen-lifetime" accesskey="p" rel="prev">lifetime option (-l)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="modulus-option-_0028_002dm_0029"></span><h4 class="subsection">1.2.12 modulus option (-m)</h4>
-<span id="index-ntp_002dkeygen_002dmodulus"></span>
+<h4 class="subsection" id="modulus-option-_0028_002dm_0029"><span>1.2.12 modulus option (-m)<a class="copiable-link" href="#modulus-option-_0028_002dm_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dmodulus"></a>
<p>This is the “prime modulus” option.
-This option takes a number argument <samp>modulus</samp>.
+This option takes a number argument <samp class="file">modulus</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>The number of bits in the prime modulus. The default is 512.
</p><hr>
-<span id="ntp_002dkeygen-md5key"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-md5key">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-pvt_002dcert" accesskey="n" rel="next">ntp-keygen pvt-cert</a>, Previous: <a href="#ntp_002dkeygen-modulus" accesskey="p" rel="prev">ntp-keygen modulus</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-pvt_002dcert" accesskey="n" rel="next">pvt-cert option (-P)</a>, Previous: <a href="#ntp_002dkeygen-modulus" accesskey="p" rel="prev">modulus option (-m)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="md5key-option-_0028_002dM_0029"></span><h4 class="subsection">1.2.13 md5key option (-M)</h4>
-<span id="index-ntp_002dkeygen_002dmd5key"></span>
+<h4 class="subsection" id="md5key-option-_0028_002dM_0029"><span>1.2.13 md5key option (-M)<a class="copiable-link" href="#md5key-option-_0028_002dM_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dmd5key"></a>
<p>This is the “generate symmetric keys” option.
Generate symmetric keys, obsoleting any that may exist.
</p><hr>
-<span id="ntp_002dkeygen-pvt_002dcert"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-pvt_002dcert">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-password" accesskey="n" rel="next">ntp-keygen password</a>, Previous: <a href="#ntp_002dkeygen-md5key" accesskey="p" rel="prev">ntp-keygen md5key</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-password" accesskey="n" rel="next">password option (-p)</a>, Previous: <a href="#ntp_002dkeygen-md5key" accesskey="p" rel="prev">md5key option (-M)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="pvt_002dcert-option-_0028_002dP_0029"></span><h4 class="subsection">1.2.14 pvt-cert option (-P)</h4>
-<span id="index-ntp_002dkeygen_002dpvt_002dcert"></span>
+<h4 class="subsection" id="pvt_002dcert-option-_0028_002dP_0029"><span>1.2.14 pvt-cert option (-P)<a class="copiable-link" href="#pvt_002dcert-option-_0028_002dP_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dpvt_002dcert"></a>
<p>This is the “generate pc private certificate” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate a private certificate. By default, the program generates
public certificates.
</p><hr>
-<span id="ntp_002dkeygen-password"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-password">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-export_002dpasswd" accesskey="n" rel="next">ntp-keygen export-passwd</a>, Previous: <a href="#ntp_002dkeygen-pvt_002dcert" accesskey="p" rel="prev">ntp-keygen pvt-cert</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-export_002dpasswd" accesskey="n" rel="next">export-passwd option (-q)</a>, Previous: <a href="#ntp_002dkeygen-pvt_002dcert" accesskey="p" rel="prev">pvt-cert option (-P)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="password-option-_0028_002dp_0029"></span><h4 class="subsection">1.2.15 password option (-p)</h4>
-<span id="index-ntp_002dkeygen_002dpassword"></span>
+<h4 class="subsection" id="password-option-_0028_002dp_0029"><span>1.2.15 password option (-p)<a class="copiable-link" href="#password-option-_0028_002dp_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dpassword"></a>
<p>This is the “local private password” option.
-This option takes a string argument <samp>passwd</samp>.
+This option takes a string argument <samp class="file">passwd</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Local files containing private data are encrypted with the
configuration command. The default password is the local
hostname.
</p><hr>
-<span id="ntp_002dkeygen-export_002dpasswd"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-export_002dpasswd">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-subject_002dname" accesskey="n" rel="next">ntp-keygen subject-name</a>, Previous: <a href="#ntp_002dkeygen-password" accesskey="p" rel="prev">ntp-keygen password</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-subject_002dname" accesskey="n" rel="next">subject-name option (-s)</a>, Previous: <a href="#ntp_002dkeygen-password" accesskey="p" rel="prev">password option (-p)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="export_002dpasswd-option-_0028_002dq_0029"></span><h4 class="subsection">1.2.16 export-passwd option (-q)</h4>
-<span id="index-ntp_002dkeygen_002dexport_002dpasswd"></span>
+<h4 class="subsection" id="export_002dpasswd-option-_0028_002dq_0029"><span>1.2.16 export-passwd option (-q)<a class="copiable-link" href="#export_002dpasswd-option-_0028_002dq_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dexport_002dpasswd"></a>
<p>This is the “export iff or gq group keys with password” option.
-This option takes a string argument <samp>passwd</samp>.
+This option takes a string argument <samp class="file">passwd</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Export IFF or GQ identity group keys to the standard output,
"crypto pw password" configuration command. See also the option
–id-key (-e) for unencrypted exports.
</p><hr>
-<span id="ntp_002dkeygen-subject_002dname"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-subject_002dname">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-sign_002dkey" accesskey="n" rel="next">ntp-keygen sign-key</a>, Previous: <a href="#ntp_002dkeygen-export_002dpasswd" accesskey="p" rel="prev">ntp-keygen export-passwd</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-sign_002dkey" accesskey="n" rel="next">sign-key option (-S)</a>, Previous: <a href="#ntp_002dkeygen-export_002dpasswd" accesskey="p" rel="prev">export-passwd option (-q)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="subject_002dname-option-_0028_002ds_0029"></span><h4 class="subsection">1.2.17 subject-name option (-s)</h4>
-<span id="index-ntp_002dkeygen_002dsubject_002dname"></span>
+<h4 class="subsection" id="subject_002dname-option-_0028_002ds_0029"><span>1.2.17 subject-name option (-s)<a class="copiable-link" href="#subject_002dname-option-_0028_002ds_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dsubject_002dname"></a>
<p>This is the “set host and optionally group name” option.
-This option takes a string argument <samp>host@group</samp>.
+This option takes a string argument <samp class="file">host@group</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Set the Autokey host name, and optionally, group name specified
-following an ’<code>@</code>’ character. The host name is used in the file
+following an ’<code class="code">@</code>’ character. The host name is used in the file
name of generated host and signing certificates, without the
group name. The host name, and if provided, group name are used
-in <code>host@group</code> form for the host certificate subject and issuer
-fields. Specifying ’<code>-s @group</code>’ is allowed, and results in
-leaving the host name unchanged while appending <code>@group</code> to the
-subject and issuer fields, as with <code>-i group</code>. The group name, or
+in <code class="code">host@group</code> form for the host certificate subject and issuer
+fields. Specifying ’<code class="code">-s @group</code>’ is allowed, and results in
+leaving the host name unchanged while appending <code class="code">@group</code> to the
+subject and issuer fields, as with <code class="code">-i group</code>. The group name, or
if not provided, the host name are also used in the file names
of IFF, GQ, and MV client parameter files.
</p><hr>
-<span id="ntp_002dkeygen-sign_002dkey"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-sign_002dkey">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-trusted_002dcert" accesskey="n" rel="next">ntp-keygen trusted-cert</a>, Previous: <a href="#ntp_002dkeygen-subject_002dname" accesskey="p" rel="prev">ntp-keygen subject-name</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-trusted_002dcert" accesskey="n" rel="next">trusted-cert option (-T)</a>, Previous: <a href="#ntp_002dkeygen-subject_002dname" accesskey="p" rel="prev">subject-name option (-s)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="sign_002dkey-option-_0028_002dS_0029"></span><h4 class="subsection">1.2.18 sign-key option (-S)</h4>
-<span id="index-ntp_002dkeygen_002dsign_002dkey"></span>
+<h4 class="subsection" id="sign_002dkey-option-_0028_002dS_0029"><span>1.2.18 sign-key option (-S)<a class="copiable-link" href="#sign_002dkey-option-_0028_002dS_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dsign_002dkey"></a>
<p>This is the “generate sign key (rsa or dsa)” option.
-This option takes a string argument <samp>sign</samp>.
+This option takes a string argument <samp class="file">sign</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate a new sign key of the designated type, obsoleting any
that may exist. By default, the program uses the host key as the
sign key.
</p><hr>
-<span id="ntp_002dkeygen-trusted_002dcert"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-trusted_002dcert">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-mv_002dparams" accesskey="n" rel="next">ntp-keygen mv-params</a>, Previous: <a href="#ntp_002dkeygen-sign_002dkey" accesskey="p" rel="prev">ntp-keygen sign-key</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-mv_002dparams" accesskey="n" rel="next">mv-params option (-V)</a>, Previous: <a href="#ntp_002dkeygen-sign_002dkey" accesskey="p" rel="prev">sign-key option (-S)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="trusted_002dcert-option-_0028_002dT_0029"></span><h4 class="subsection">1.2.19 trusted-cert option (-T)</h4>
-<span id="index-ntp_002dkeygen_002dtrusted_002dcert"></span>
+<h4 class="subsection" id="trusted_002dcert-option-_0028_002dT_0029"><span>1.2.19 trusted-cert option (-T)<a class="copiable-link" href="#trusted_002dcert-option-_0028_002dT_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dtrusted_002dcert"></a>
<p>This is the “trusted certificate (tc scheme)” option.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate a trusted certificate. By default, the program generates
a non-trusted certificate.
</p><hr>
-<span id="ntp_002dkeygen-mv_002dparams"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-mv_002dparams">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-mv_002dkeys" accesskey="n" rel="next">ntp-keygen mv-keys</a>, Previous: <a href="#ntp_002dkeygen-trusted_002dcert" accesskey="p" rel="prev">ntp-keygen trusted-cert</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-mv_002dkeys" accesskey="n" rel="next">mv-keys option (-v)</a>, Previous: <a href="#ntp_002dkeygen-trusted_002dcert" accesskey="p" rel="prev">trusted-cert option (-T)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="mv_002dparams-option-_0028_002dV_0029"></span><h4 class="subsection">1.2.20 mv-params option (-V)</h4>
-<span id="index-ntp_002dkeygen_002dmv_002dparams"></span>
+<h4 class="subsection" id="mv_002dparams-option-_0028_002dV_0029"><span>1.2.20 mv-params option (-V)<a class="copiable-link" href="#mv_002dparams-option-_0028_002dV_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dmv_002dparams"></a>
<p>This is the “generate <num> mv parameters” option.
-This option takes a number argument <samp>num</samp>.
+This option takes a number argument <samp class="file">num</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
<p>Generate parameters and keys for the Mu-Varadharajan (MV)
identification scheme.
</p><hr>
-<span id="ntp_002dkeygen-mv_002dkeys"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-mv_002dkeys">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-config" accesskey="n" rel="next">ntp-keygen config</a>, Previous: <a href="#ntp_002dkeygen-mv_002dparams" accesskey="p" rel="prev">ntp-keygen mv-params</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-config" accesskey="n" rel="next">presetting/configuring ntp-keygen</a>, Previous: <a href="#ntp_002dkeygen-mv_002dparams" accesskey="p" rel="prev">mv-params option (-V)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="mv_002dkeys-option-_0028_002dv_0029"></span><h4 class="subsection">1.2.21 mv-keys option (-v)</h4>
-<span id="index-ntp_002dkeygen_002dmv_002dkeys"></span>
+<h4 class="subsection" id="mv_002dkeys-option-_0028_002dv_0029"><span>1.2.21 mv-keys option (-v)<a class="copiable-link" href="#mv_002dkeys-option-_0028_002dv_0029"> ¶</a></span></h4>
+<a class="index-entry-id" id="index-ntp_002dkeygen_002dmv_002dkeys"></a>
<p>This is the “update <num> mv keys” option.
-This option takes a number argument <samp>num</samp>.
+This option takes a number argument <samp class="file">num</samp>.
</p>
<p>This option has some usage constraints. It:
-</p><ul>
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</p><ul class="itemize mark-bullet">
+<li>must be compiled in by defining <code class="code">AUTOKEY</code> during the compilation.
</li></ul>
-<p>This option has no ‘<samp>doc</samp>’ documentation.
+<p>This option has no ‘<samp class="samp">doc</samp>’ documentation.
</p>
<hr>
-<span id="ntp_002dkeygen-config"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-config">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-exit-status" accesskey="n" rel="next">ntp-keygen exit status</a>, Previous: <a href="#ntp_002dkeygen-mv_002dkeys" accesskey="p" rel="prev">ntp-keygen mv-keys</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-exit-status" accesskey="n" rel="next">ntp-keygen exit status</a>, Previous: <a href="#ntp_002dkeygen-mv_002dkeys" accesskey="p" rel="prev">mv-keys option (-v)</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="presetting_002fconfiguring-ntp_002dkeygen"></span><h4 class="subsection">1.2.22 presetting/configuring ntp-keygen</h4>
+<h4 class="subsection" id="presetting_002fconfiguring-ntp_002dkeygen"><span>1.2.22 presetting/configuring ntp-keygen<a class="copiable-link" href="#presetting_002fconfiguring-ntp_002dkeygen"> ¶</a></span></h4>
-<p>Any option that is not marked as <i>not presettable</i> may be preset by
-loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTP-KEYGEN</code> and <code>NTP-KEYGEN_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
+<p>Any option that is not marked as <i class="i">not presettable</i> may be preset by
+loading values from configuration ("rc" or "ini") files, and values from environment variables named <code class="code">NTP-KEYGEN</code> and <code class="code">NTP-KEYGEN_<OPTION_NAME></code>. <code class="code"><OPTION_NAME></code> must be one of
the options listed above in upper case and segmented with underscores.
-The <code>NTP-KEYGEN</code> variable will be tokenized and parsed like
+The <code class="code">NTP-KEYGEN</code> variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
</p>
-<p><code>libopts</code> will search in 2 places for configuration files:
-</p><ul>
-<li> $HOME
-</li><li> $PWD
+<p><code class="code">libopts</code> will search in 2 places for configuration files:
+</p><ul class="itemize mark-bullet">
+<li>$HOME
+</li><li>$PWD
</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>ntp-keygen</samp> runs.
+<p>The environment variables <code class="code">HOME</code>, and <code class="code">PWD</code>
+are expanded and replaced when <samp class="file">ntp-keygen</samp> runs.
For any of these that are plain files, they are simply processed.
-For any that are directories, then a file named <samp>.ntprc</samp> is searched for
+For any that are directories, then a file named <samp class="file">.ntprc</samp> is searched for
within that directory and processed.
</p>
<p>Configuration files may be in a wide variety of formats.
Common options are collected at the top, followed by program specific
segments. The segments are separated by lines like:
</p><div class="example">
-<pre class="example">[NTP-KEYGEN]
+<pre class="example-preformatted">[NTP-KEYGEN]
</pre></div>
<p>or by
</p><div class="example">
-<pre class="example"><?program ntp-keygen>
+<pre class="example-preformatted"><?program ntp-keygen>
</pre></div>
<p>Do not mix these styles within one configuration file.
</p>
<p>Compound values and carefully constructed string values may also be
specified using XML syntax:
</p><div class="example">
-<pre class="example"><option-name>
+<pre class="example-preformatted"><option-name>
<sub-opt>...&lt;...&gt;...</sub-opt>
</option-name>
</pre></div>
-<p>yielding an <code>option-name.sub-opt</code> string value of
+<p>yielding an <code class="code">option-name.sub-opt</code> string value of
</p><div class="example">
-<pre class="example">"...<...>..."
+<pre class="example-preformatted">"...<...>..."
</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
-hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching
+<p><code class="code">AutoOpts</code> does not track suboptions. You simply note that it is a
+hierarchicly valued option. <code class="code">AutoOpts</code> does provide a means for searching
the associated name/value pair list (see: optionFindValue).
</p>
<p>The command line options relating to configuration and/or usage help are:
</p>
-<span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
+<h4 class="subsubheading" id="version-_0028_002d_0029"><span>version (-)<a class="copiable-link" href="#version-_0028_002d_0029"> ¶</a></span></h4>
<p>Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing information may be selected with an option argument.
Only the first letter of the argument is examined:
</p>
-<dl compact="compact">
-<dt>‘<samp>version</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">version</samp>’</dt>
<dd><p>Only print the version. This is the default.
</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
+<dt>‘<samp class="samp">copyright</samp>’</dt>
<dd><p>Name the copyright usage licensing terms.
</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>Print the full copyright usage licensing terms.
</p></dd>
</dl>
<hr>
-<span id="ntp_002dkeygen-exit-status"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-exit-status">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-Usage" accesskey="n" rel="next">ntp-keygen Usage</a>, Previous: <a href="#ntp_002dkeygen-config" accesskey="p" rel="prev">ntp-keygen config</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-Usage" accesskey="n" rel="next">ntp-keygen Usage</a>, Previous: <a href="#ntp_002dkeygen-config" accesskey="p" rel="prev">presetting/configuring ntp-keygen</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ntp_002dkeygen-exit-status-1"></span><h4 class="subsection">1.2.23 ntp-keygen exit status</h4>
+<h4 class="subsection" id="ntp_002dkeygen-exit-status-1"><span>1.2.23 ntp-keygen exit status<a class="copiable-link" href="#ntp_002dkeygen-exit-status-1"> ¶</a></span></h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
+</p><dl class="table">
+<dt>‘<samp class="samp">0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
+<dt>‘<samp class="samp">1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
-<dt>‘<samp>66 (EX_NOINPUT)</samp>’</dt>
+<dt>‘<samp class="samp">66 (EX_NOINPUT)</samp>’</dt>
<dd><p>A specified configuration file could not be loaded.
</p></dd>
-<dt>‘<samp>70 (EX_SOFTWARE)</samp>’</dt>
+<dt>‘<samp class="samp">70 (EX_SOFTWARE)</samp>’</dt>
<dd><p>libopts had an internal operational error. Please report
it to autogen-users@lists.sourceforge.net. Thank you.
</p></dd>
</dl>
<hr>
-<span id="ntp_002dkeygen-Usage"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-Usage">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-Notes" accesskey="n" rel="next">ntp-keygen Notes</a>, Previous: <a href="#ntp_002dkeygen-exit-status" accesskey="p" rel="prev">ntp-keygen exit status</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-Notes" accesskey="n" rel="next">ntp-keygen Notes</a>, Previous: <a href="#ntp_002dkeygen-exit-status" accesskey="p" rel="prev">ntp-keygen exit status</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ntp_002dkeygen-Usage-1"></span><h4 class="subsection">1.2.24 ntp-keygen Usage</h4>
+<h4 class="subsection" id="ntp_002dkeygen-Usage-1"><span>1.2.24 ntp-keygen Usage<a class="copiable-link" href="#ntp_002dkeygen-Usage-1"> ¶</a></span></h4>
<hr>
-<span id="ntp_002dkeygen-Notes"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-Notes">
+<div class="nav-panel">
<p>
-Next: <a href="#ntp_002dkeygen-Bugs" accesskey="n" rel="next">ntp-keygen Bugs</a>, Previous: <a href="#ntp_002dkeygen-Usage" accesskey="p" rel="prev">ntp-keygen Usage</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Next: <a href="#ntp_002dkeygen-Bugs" accesskey="n" rel="next">ntp-keygen Bugs</a>, Previous: <a href="#ntp_002dkeygen-Usage" accesskey="p" rel="prev">ntp-keygen Usage</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ntp_002dkeygen-Notes-1"></span><h4 class="subsection">1.2.25 ntp-keygen Notes</h4>
+<h4 class="subsection" id="ntp_002dkeygen-Notes-1"><span>1.2.25 ntp-keygen Notes<a class="copiable-link" href="#ntp_002dkeygen-Notes-1"> ¶</a></span></h4>
<hr>
-<span id="ntp_002dkeygen-Bugs"></span><div class="header">
+</div>
+<div class="subsection-level-extent" id="ntp_002dkeygen-Bugs">
+<div class="nav-panel">
<p>
-Previous: <a href="#ntp_002dkeygen-Notes" accesskey="p" rel="prev">ntp-keygen Notes</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">ntp-keygen Invocation</a> </p>
+Previous: <a href="#ntp_002dkeygen-Notes" accesskey="p" rel="prev">ntp-keygen Notes</a>, Up: <a href="#ntp_002dkeygen-Invocation" accesskey="u" rel="up">Invoking ntp-keygen</a> </p>
</div>
-<span id="ntp_002dkeygen-Bugs-1"></span><h4 class="subsection">1.2.26 ntp-keygen Bugs</h4>
+<h4 class="subsection" id="ntp_002dkeygen-Bugs-1"><span>1.2.26 ntp-keygen Bugs<a class="copiable-link" href="#ntp_002dkeygen-Bugs-1"> ¶</a></span></h4>
<hr>
-<span id="Random-Seed-File"></span><div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Random-Seed-File">
+<div class="nav-panel">
<p>
-Next: <a href="#Cryptographic-Data-Files" accesskey="n" rel="next">Cryptographic Data Files</a>, Previous: <a href="#Running-the-Program" accesskey="p" rel="prev">Running the Program</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Next: <a href="#Cryptographic-Data-Files" accesskey="n" rel="next">Cryptographic Data Files</a>, Previous: <a href="#Running-the-Program" accesskey="p" rel="prev">Running the Program</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP Key Generation Program User Manual</a> </p>
</div>
-<span id="Random-Seed-File-2"></span><h3 class="section">1.3 Random Seed File</h3>
+<h3 class="section" id="Random-Seed-File-2"><span>1.3 Random Seed File<a class="copiable-link" href="#Random-Seed-File-2"> ¶</a></span></h3>
<p>All cryptographically sound key generation schemes must have means to
randomize the entropy seed used to initialize the internal
If a site supports ssh, it is very likely that means to do this are
already available.
The entropy seed used by the OpenSSL library is contained in a file,
-usually called <code>.rnd</code>, which must be available when
-starting the <code>ntp-keygen</code> program or <code>ntpd</code> daemon.
+usually called <code class="code">.rnd</code>, which must be available when
+starting the <code class="code">ntp-keygen</code> program or <code class="code">ntpd</code> daemon.
</p>
<p>The OpenSSL library looks for the file using the path specified by the
-<code>RANDFILE</code> environment variable in the user home directory, whether root
+<code class="code">RANDFILE</code> environment variable in the user home directory, whether root
or some other user.
-If the <code>RANDFILE</code> environment variable is not
-present, the library looks for the <code>.rnd</code> file in the user home
+If the <code class="code">RANDFILE</code> environment variable is not
+present, the library looks for the <code class="code">.rnd</code> file in the user home
directory.
-Since both the <code>ntp-keygen</code> program and <code>ntpd</code> daemon must run
-as root, the logical place to put this file is in <code>/.rnd</code> or
-<code>/root/.rnd</code>.
+Since both the <code class="code">ntp-keygen</code> program and <code class="code">ntpd</code> daemon must run
+as root, the logical place to put this file is in <code class="code">/.rnd</code> or
+<code class="code">/root/.rnd</code>.
If the file is not available or cannot be written, the program exits
with a message to the system log.
</p>
<hr>
-<span id="Cryptographic-Data-Files"></span><div class="header">
+</div>
+<div class="section-level-extent" id="Cryptographic-Data-Files">
+<div class="nav-panel">
<p>
-Previous: <a href="#Random-Seed-File" accesskey="p" rel="prev">Random Seed File</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+Previous: <a href="#Random-Seed-File" accesskey="p" rel="prev">Random Seed File</a>, Up: <a href="#Top" accesskey="u" rel="up">NTP Key Generation Program User Manual</a> </p>
</div>
-<span id="Cryptographic-Data-Files-2"></span><h3 class="section">1.4 Cryptographic Data Files</h3>
+<h3 class="section" id="Cryptographic-Data-Files-2"><span>1.4 Cryptographic Data Files<a class="copiable-link" href="#Cryptographic-Data-Files-2"> ¶</a></span></h3>
-<p>File and link names are in the <code>form ntpkey_key_name.fstamp</code>,
-where <code>key</code> is the key or parameter type,
-<code>name</code> is the host or group name and
-<code>fstamp</code> is the filestamp (NTP seconds) when the file was created).
+<p>File and link names are in the <code class="code">form ntpkey_key_name.fstamp</code>,
+where <code class="code">key</code> is the key or parameter type,
+<code class="code">name</code> is the host or group name and
+<code class="code">fstamp</code> is the filestamp (NTP seconds) when the file was created).
By convention, key names in generated file names include both upper and
lower case characters, while key names in generated link names include
only lower case characters. The filestamp is not used in generated link
GQkey.
</p>
<p>All files begin with two nonencrypted lines. The first line contains
-the file name in the format <code>ntpkey_key_host.fstamp</code>.
+the file name in the format <code class="code">ntpkey_key_host.fstamp</code>.
The second line contains the datestamp in conventional Unix date format.
-Lines beginning with <code>#</code> are ignored.
+Lines beginning with <code class="code">#</code> are ignored.
</p>
<p>The remainder of the file contains cryptographic data encoded first
using ASN.1 rules, then encrypted using the DES-CBC algorithm with
given password and finally written in PEM-encoded printable ASCII text
preceded and followed by MIME content identifier lines.
</p>
-<p>The format of the symmetric keys file, ordinarily named <code>ntp.keys</code>,
+<p>The format of the symmetric keys file, ordinarily named <code class="code">ntp.keys</code>,
is somewhat different than the other files in the interest of backward
compatibility.
Ordinarily, the file is generated by this program, but
it can be constructed and edited using an ordinary text editor.
</p>
<div class="example">
-<pre class="example"># ntpkey_MD5key_hms.local.3564038757
+<pre class="example-preformatted"># ntpkey_MD5key_hms.local.3564038757
# Sun Dec 9 02:45:57 2012
1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key
key consists of a hex-encoded ASCII string of 40 characters, which is
truncated as necessary.
</p>
-<p>Note that the keys used by the <code>ntpq</code> and <code>ntpdc</code> programs are
+<p>Note that the keys used by the <code class="code">ntpq</code> and <code class="code">ntpdc</code> programs are
checked against passwords requested by the programs and entered by hand,
so it
is generally appropriate to specify these keys in human readable ASCII
format.
</p>
-<p>The <code>ntp-keygen</code> program generates a MD5 symmetric keys file
-<code>ntpkey_MD5key_hostname.filestamp</code>.
+<p>The <code class="code">ntp-keygen</code> program generates a MD5 symmetric keys file
+<code class="code">ntpkey_MD5key_hostname.filestamp</code>.
Since the file contains private
shared keys, it should be visible only to root and distributed by
secure means to other subnet hosts.
-The NTP daemon loads the file <code>ntp.keys</code>, so <code>ntp-keygen</code>
+The NTP daemon loads the file <code class="code">ntp.keys</code>, so <code class="code">ntp-keygen</code>
installs a soft link from this name to the generated file.
Subsequently, similar soft links must be installed by
manual or automated means on the other subnet hosts.
While this file is
not used with the Autokey Version 2 protocol, it is needed to
-authenticate some remote configuration commands used by the <code>ntpq</code> and
-<code>ntpdc</code> utilities.
-</p><hr>
+authenticate some remote configuration commands used by the <code class="code">ntpq</code> and
+<code class="code">ntpdc</code> utilities.
+</p></div>
+</div>
+</div>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-keygen @NTP_KEYGEN_MS@ "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"
+.TH ntp-keygen @NTP_KEYGEN_MS@ "07 Jan 2024" "ntp (4.2.8p17)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:32 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:09 AM by AutoGen 5.18.16
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH "AUTHORS"
The University of Delaware and Network Time Foundation
.SH "COPYRIGHT"
-Copyright (C) 1992-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.SH BUGS
It can take quite a while to generate some cryptographic values.
-.Dd June 6 2023
+.Dd January 7 2024
.Dt NTP_KEYGEN @NTP_KEYGEN_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.mdoc)
.\"
-.\" It has been AutoGen-ed June 6, 2023 at 04:38:27 AM by AutoGen 5.18.16
+.\" It has been AutoGen-ed January 7, 2024 at 12:35:05 AM by AutoGen 5.18.16
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh "AUTHORS"
The University of Delaware and Network Time Foundation
.Sh "COPYRIGHT"
-Copyright (C) 1992\-2023 The University of Delaware and Network Time Foundation all rights reserved.
+Copyright (C) 1992\-2024 The University of Delaware and Network Time Foundation all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh BUGS
It can take quite a while to generate some cryptographic values.
projects / thirdparty / ntp.git / commitdiff
