-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>NTP Configuration File User’s Manual</title>
-
-<meta name="description" content="NTP Configuration File User’s Manual">
-<meta name="keywords" content="NTP Configuration File User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>NTP Configuration File User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="NTP Configuration File User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">NTP Configuration File User's Manual</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002econf-Description">ntp.conf Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">NTP Configuration File User’s Manual</h1>
-
-
+</div>
+<h2 class="unnumbered">NTP's Configuration File User Manual</h2>
+<p>This document describes the configuration file for the NTP Project's
+<code>ntpd</code> program.
-<a name="Top"></a>
-<div class="header">
-<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>
-</div>
-<a name="NTP_0027s-Configuration-File-User-Manual"></a>
-<h1 class="top">NTP’s Configuration File User Manual</h1>
+ <p>This document applies to version 4.2.8p9 of <code>ntp.conf</code>.
-<p>This document describes the configuration file for the NTP Project’s
-<code>ntpd</code> program.
-</p>
-<p>This document applies to version 4.2.8p9-win of <code>ntp.conf</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">NTP's Configuration File User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002econf-Description">ntp.conf Description</a>
+<li><a accesskey="2" href="#ntp_002econf-Notes">ntp.conf Notes</a>
+</ul>
-<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>
-
-<hr>
+<div class="node">
+<a name="ntp.conf-Description"></a>
<a name="ntp_002econf-Description"></a>
-<div class="header">
-<p>
-Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>The behavior of <code>ntpd</code> can be changed by a configuration file,
by default <code>ntp.conf</code>.
-</p>
-<hr>
+
+<div class="node">
+<a name="ntp.conf-Notes"></a>
<a name="ntp_002econf-Notes"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Notes-about-ntp_002econf"></a>
-<h3 class="section">1.1 Notes about ntp.conf</h3>
-<a name="index-ntp_002econf"></a>
-<a name="index-Network-Time-Protocol-_0028NTP_0029-daemon-configuration-file-format"></a>
+<h3 class="section">Notes about ntp.conf</h3>
+<p><a name="index-ntp_002econf-1"></a><a name="index-Network-Time-Protocol-_0028NTP_0029-daemon-configuration-file-format-2"></a>
-<p>The
<code>ntp.conf</code>
configuration file is read at initial startup by the
<code>ntpd(1ntpdmdoc)</code>
daemon in order to specify the synchronization sources,
-modes and other related information.
+modes and other related information.
Usually, it is installed in the
-<samp>/etc</samp>
+<samp><span class="file">/etc</span></samp>
directory,
but could be installed elsewhere
-(see the daemon’s
+(see the daemon's
<code>-c</code>
command line option).
-</p>
-<p>The file format is similar to other
-<small>UNIX</small>
-configuration files.
+
+
<p>The file format is similar to other
+<span class="sc">unix</span>
+configuration files.
Comments begin with a
‘#’
character and extend to the end of the line;
-blank lines are ignored.
+blank lines are ignored.
Configuration commands consist of an initial keyword
followed by a list of arguments,
-some of which may be optional, separated by whitespace.
-Commands may not be continued over multiple lines.
+some of which may be optional, separated by whitespace.
+Commands may not be continued over multiple lines.
Arguments may be host names,
host addresses written in numeric, dotted-quad form,
integers, floating point numbers (when specifying times in seconds)
and text strings.
-</p>
-<p>The rest of this page describes the configuration and control options.
+
+ <p>The rest of this page describes the configuration and control options.
The
-"Notes on Configuring NTP and Setting up an NTP Subnet"
+"Notes on Configuring NTP and Setting up an NTP Subnet"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
-contains an extended discussion of these options.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>)
+contains an extended discussion of these options.
In addition to the discussion of general
-‘Configuration Options’,
+<a href="#Configuration-Options">Configuration Options</a>,
there are sections describing the following supported functionality
and the options used to control it:
-<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>
-</li></ul>
-
-<p>Following these is a section describing
-<a href="#Miscellaneous-Options">Miscellaneous Options</a>.
+<li><a href="#Authentication-Support">Authentication Support</a>
+<
li><a href="#Monitoring-Support">Monitoring Support</a>
+<
li><a href="#Access-Control-Support">Access Control Support</a>
+<
li><a href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
+<
li><a href="#Reference-Clock-Support">Reference Clock Support</a>
+<
li><a href="#Miscellaneous-Options">Miscellaneous Options</a>
+</ul>
+
+
<p>Following these is a section describing
+<a 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>broadcast</code>
or
<code>manycastclient</code>
-commands.
-</p><hr>
+commands.
+<div class="node">
<a name="Configuration-Support"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Configuration-Support-1"></a>
-<h4 class="subsection">1.1.1 Configuration Support</h4>
+
+<h4 class="subsection">Configuration Support</h4>
+
<p>Following is a description of the configuration commands in
-NTPv4.
+NTPv4.
These commands have the same basic functions as in NTPv3 and
-in some cases new functions and new arguments.
+in some cases new functions and new arguments.
There are two
classes of commands, configuration commands that configure a
persistent association with a remote server or peer or reference
clock, and auxiliary commands that specify environmental variables
that control various related operations.
-</p><a name="Configuration-Commands"></a>
-<h4 class="subsubsection">1.1.1.1 Configuration Commands</h4>
+
+<h5 class="subsubsection">Configuration Commands</h5>
+
<p>The various modes are determined by the command keyword and the
-type of the required IP address.
+type of the required IP address.
Addresses are classed by type as
(s) a remote server or peer (IPv4 class A, B and C), (b) the
broadcast address of a local interface, (m) a multicast address (IPv4
-class D), or (r) a reference clock address (127.127.x.x).
+class D), or (r) a reference clock address (127.127.x.x).
Note that
-only those options applicable to each command are listed below.
+only those options applicable to each command are listed below.
Use
of options not listed may not be caught as an error, but may result
in some weird and even destructive behavior.
-</p>
-<p>If the Basic Socket Interface Extensions for IPv6 (RFC-2553)
+
+
<p>If the Basic Socket Interface Extensions for IPv6 (RFC-2553)
is detected, support for the IPv6 address family is generated
-in addition to the default support of the IPv4 address family.
+in addition to the default support of the IPv4 address family.
In a few cases, including the
<code>reslist</code>
billboard generated
<code>ntpq(1ntpqmdoc)</code>
or
<code>ntpdc(1ntpdcmdoc)</code>,
-IPv6 addresses are automatically generated.
+IPv6 addresses are automatically generated.
IPv6 addresses can be identified by the presence of colons
“:”
-in the address field.
+in the address field.
IPv6 addresses can be used almost everywhere where
IPv4 addresses can be used,
with the exception of reference clock addresses,
which are always IPv4.
-</p>
-<p>Note that in contexts where a host name is expected, a
+
+
<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.
+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></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></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>
-</dl>
+ <dl>
+<dt><code>pool</code> <kbd>address</kbd> <code>[burst]</code> <code>[iburst]</code> <code>[version </code><kbd>version</kbd><code>]</code> <code>[prefer]</code> <code>[minpoll </code><kbd>minpoll</kbd><code>]</code> <code>[maxpoll </code><kbd>maxpoll</kbd><code>]</code><br><dt><code>server</code> <kbd>address</kbd> <code>[key </code><kbd>key</kbd> <kbd>|</kbd><code> autokey]</code> <code>[burst]</code> <code>[iburst]</code> <code>[version </code><kbd>version</kbd><code>]</code> <code>[prefer]</code> <code>[minpoll </code><kbd>minpoll</kbd><code>]</code> <code>[maxpoll </code><kbd>maxpoll</kbd><code>]</code> <code>[true]</code><br><dt><code>peer</code> <kbd>address</kbd> <code>[key </code><kbd>key</kbd> <kbd>|</kbd><code> autokey]</code> <code>[version </code><kbd>version</kbd><code>]</code> <code>[prefer]</code> <code>[minpoll </code><kbd>minpoll</kbd><code>]</code> <code>[maxpoll </code><kbd>maxpoll</kbd><code>]</code> <code>[true]</code> <code>[xleave]</code><br><dt><code>broadcast</code> <kbd>address</kbd> <code>[key </code><kbd>key</kbd> <kbd>|</kbd><code> autokey]</code> <code>[version </code><kbd>version</kbd><code>]</code> <code>[prefer]</code> <code>[minpoll </code><kbd>minpoll</kbd><code>]</code> <code>[ttl </code><kbd>ttl</kbd><code>]</code> <code>[xleave]</code><br><dt><code>manycastclient</code> <kbd>address</kbd> <code>[key </code><kbd>key</kbd> <kbd>|</kbd><code> autokey]</code> <code>[version </code><kbd>version</kbd><code>]</code> <code>[prefer]</code> <code>[minpoll </code><kbd>minpoll</kbd><code>]</code> <code>[maxpoll </code><kbd>maxpoll</kbd><code>]</code> <code>[ttl </code><kbd>ttl</kbd><code>]</code><dd></dl>
-<p>These five commands specify the time server name or address to
-be used and the mode in which to operate.
+
<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>
can be
-either a DNS name or an IP address in dotted-quad notation.
+either a DNS name or an IP address in dotted-quad notation.
Additional information on association behavior can be found in the
-"Association Management"
+"Association Management"
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>
-<dd><p>For type s addresses, this command mobilizes a persistent
-client mode association with a number of remote servers.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
+ <dl>
+<dt><code>pool</code><dd>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>
-<dd><p>For type s and r addresses, this command mobilizes a persistent
+the local clock.
+<br><dt><code>server</code><dd>For type s and r addresses, this command mobilizes a persistent
client mode association with the specified remote server or local
-radio clock.
+radio clock.
In this mode the local clock can synchronized to the
remote server, but the remote server can never be synchronized to
-the local clock.
+the local clock.
This command should
<em>not</em>
be used for type
-b or m addresses.
-</p></dd>
-<dt><code>peer</code></dt>
-<dd><p>For type s addresses (only), this command mobilizes a
+b or m addresses.
+<br><dt><code>peer</code><dd>For type s addresses (only), this command mobilizes a
persistent symmetric-active mode association with the specified
-remote peer.
+remote peer.
In this mode the local clock can be synchronized to
the remote peer or the remote peer can be synchronized to the local
-clock.
+clock.
This is useful in a network of servers where, depending on
various failure scenarios, either the local or remote peer may be
-the better source of time.
+the better source of time.
This command should NOT be used for type
-b, m or r addresses.
-</p></dd>
-<dt><code>broadcast</code></dt>
-<dd><p>For type b and m addresses (only), this
-command mobilizes a persistent broadcast mode association.
+b, m or r addresses.
+<br><dt><code>broadcast</code><dd>For type b and m addresses (only), this
+command mobilizes a persistent broadcast mode association.
Multiple
commands can be used to specify multiple local broadcast interfaces
-(subnets) and/or multiple multicast groups.
+(subnets) and/or multiple multicast groups.
Note that local
broadcast messages go only to the interface associated with the
-subnet specified, but multicast messages go to all interfaces.
+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>
specified, which is usually the broadcast address on (one of) the
-local network(s) or a multicast address assigned to NTP.
+local network(s) or a multicast address assigned to NTP.
The IANA
has assigned the multicast group address IPv4 224.0.1.1 and
IPv6 ff05::101 (site local) exclusively to
NTP, but other nonconflicting addresses can be used to contain the
-messages within administrative boundaries.
+messages within administrative boundaries.
Ordinarily, this
specification applies only to the local server operating as a
sender; for operation as a broadcast client, see the
or
<code>multicastclient</code>
commands
-below.
-</p></dd>
-<dt><code>manycastclient</code></dt>
-<dd><p>For type m addresses (only), this command mobilizes a
+below.
+<br><dt><code>manycastclient</code><dd>For type m addresses (only), this command mobilizes a
manycast client mode association for the multicast address
-specified.
+specified.
In this case a specific address must be supplied which
matches the address used on the
<code>manycastserver</code>
command for
-the designated manycast servers.
+the designated manycast servers.
The NTP multicast address
224.0.1.1 assigned by the IANA should NOT be used, unless specific
means are taken to avoid spraying large areas of the Internet with
these messages and causing a possibly massive implosion of replies
-at the sender.
+at the sender.
The
<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.
+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>
and specifically enabled
-servers respond to these messages.
+servers respond to these messages.
The client selects the servers
providing the best time and continues as with the
<code>server</code>
-command.
+command.
The remaining servers are discarded as if never
-heard.
-</p></dd>
+heard.
</dl>
-<p>Options:
-</p><dl compact="compact">
-<dt><code>autokey</code></dt>
-<dd><p>All packets sent to and received from the server or peer are to
+ <p>Options:
+ <dl>
+<dt><code>autokey</code><dd>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>
-<dd><p>when the server is reachable, send a burst of eight packets
-instead of the usual one.
+<a href="#Authentication-Options">Authentication Options</a>.
+<br><dt><code>burst</code><dd>when the server is reachable, send a burst of eight packets
+instead of the usual one.
The packet spacing is normally 2 s;
however, the spacing between the first and second packets
can be changed with the
<code>calldelay</code>
command to allow
-additional time for a modem or ISDN call to complete.
+additional time for a modem or ISDN call to complete.
This is designed to improve timekeeping quality
with the
<code>server</code>
-command and s addresses.
-</p></dd>
-<dt><code>iburst</code></dt>
-<dd><p>When the server is unreachable, send a burst of eight packets
-instead of the usual one.
+command and s addresses.
+<br><dt><code>iburst</code><dd>When the server is unreachable, send a burst of eight packets
+instead of the usual one.
The packet spacing is normally 2 s;
however, the spacing between the first two packets can be
changed with the
<code>calldelay</code>
command to allow
-additional time for a modem or ISDN call to complete.
+additional time for a modem or ISDN call to complete.
This is designed to speed the initial synchronization
acquisition with the
<code>server</code>
<code>ntpd(1ntpdmdoc)</code>
is started with the
<code>-q</code>
-option.
-</p></dd>
-<dt><code>key</code> <kbd>key</kbd></dt>
-<dd><p>All packets sent to and received from the server or peer are to
+option.
+<br><dt><code>key</code> <kbd>key</kbd><dd>All packets sent to and received from the server or peer are to
include authentication fields encrypted using the specified
<kbd>key</kbd>
-identifier with values from 1 to 65534, inclusive.
+identifier with values from 1 to 65534, 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>
-<dd><p>These options specify the minimum and maximum poll intervals
+default is to include no encryption field.
+<br><dt><code>minpoll</code> <kbd>minpoll</kbd><br><dt><code>maxpoll</code> <kbd>maxpoll</kbd><dd>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>
-option to an upper limit of 17 (36.4 h).
+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>
-option to a lower limit of 4 (16 s).
-</p></dd>
-<dt><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>
-<dd><p>Says the association can be preempted.
-</p></dd>
-<dt><code>true</code></dt>
-<dd><p>Marks the server as a truechimer.
-Use this option only for testing.
-</p></dd>
-<dt><code>prefer</code></dt>
-<dd><p>Marks the server as preferred.
+option to a lower limit of 4 (16 s).
+<br><dt><code>noselect</code><dd>Marks the server as unused, except for display purposes.
+The server is discarded by the selection algroithm.
+<br><dt><code>preempt</code><dd>Says the association can be preempted.
+<br><dt><code>true</code><dd>Marks the server as a truechimer.
+Use this option only for testing.
+<br><dt><code>prefer</code><dd>Marks the server as preferred.
All other things being equal,
this host will be chosen for synchronization among a set of
-correctly operating hosts.
+correctly operating hosts.
See the
-"Mitigation Rules and the prefer Keyword"
+"Mitigation Rules and the prefer Keyword"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
-for further information.
-</p></dd>
-<dt><code>true</code></dt>
-<dd><p>Forces the association to always survive the selection and clustering algorithms.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>)
+for further information.
+<br><dt><code>true</code><dd>Forces the association to always survive the selection and clustering algorithms.
This option should almost certainly
<em>only</em>
-be used while testing an association.
-</p></dd>
-<dt><code>ttl</code> <kbd>ttl</kbd></dt>
-<dd><p>This option is used only with broadcast server and manycast
-client modes.
+be used while testing an association.
+<br><dt><code>ttl</code> <kbd>ttl</kbd><dd>This option is used only with broadcast server and manycast
+client modes.
It specifies the time-to-live
<kbd>ttl</kbd>
to
use on broadcast server and multicast server and the maximum
<kbd>ttl</kbd>
for the expanding ring search with manycast
-client packets.
+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>
-<dd><p>Specifies the version number to be used for outgoing NTP
-packets.
+network administrator.
+<br><dt><code>version</code> <kbd>version</kbd><dd>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>
-<dd><p>Valid in
+default.
+<br><dt><code>xleave</code><dd>Valid in
<code>peer</code>
and
<code>broadcast</code>
-modes only, this flag enables interleave mode.
-</p></dd>
+modes only, this flag enables interleave mode.
</dl>
-<a name="Auxiliary-Commands"></a>
-<h4 class="subsubsection">1.1.1.2 Auxiliary Commands</h4>
-<dl compact="compact">
-<dt><code>broadcastclient</code></dt>
-<dd><p>This command enables reception of broadcast server messages to
-any local interface (type b) address.
+
+<h5 class="subsubsection">Auxiliary Commands</h5>
+
+ <dl>
+<dt><code>broadcastclient</code><dd>This command enables reception of broadcast server messages to
+any local interface (type b) address.
Upon receiving a message for
the first time, the broadcast client measures the nominal server
propagation delay using a brief client/server exchange with the
server, then enters the broadcast client mode, in which it
-synchronizes to succeeding broadcast messages.
+synchronizes to succeeding broadcast messages.
Note that, in order
to avoid accidental or malicious disruption in this mode, both the
server and client should operate using symmetric-key or public-key
authentication as described in
-‘Authentication Options’.
-</p></dd>
-<dt><code>manycastserver</code> <kbd>address</kbd> <kbd>...</kbd></dt>
-<dd><p>This command enables reception of manycast client messages to
-the multicast group address(es) (type m) specified.
+<a href="#Authentication-Options">Authentication Options</a>.
+<br><dt><code>manycastserver</code> <kbd>address</kbd> <kbd>...</kbd><dd>This command enables reception of manycast client messages to
+the multicast group address(es) (type m) specified.
At least one
address is required, but the NTP multicast address 224.0.1.1
assigned by the IANA should NOT be used, unless specific means are
taken to limit the span of the reply and avoid a possibly massive
-implosion at the original sender.
+implosion at the original sender.
Note that, in order to avoid
accidental or malicious disruption in this mode, both the server
and client should operate using symmetric-key or public-key
authentication as described in
-‘Authentication Options’.
-</p></dd>
-<dt><code>multicastclient</code> <kbd>address</kbd> <kbd>...</kbd></dt>
-<dd><p>This command enables reception of multicast server messages to
-the multicast group address(es) (type m) specified.
+<a href="#Authentication-Options">Authentication Options</a>.
+<br><dt><code>multicastclient</code> <kbd>address</kbd> <kbd>...</kbd><dd>This command enables reception of multicast server messages to
+the multicast group address(es) (type m) specified.
Upon receiving
a message for the first time, the multicast client measures the
nominal server propagation delay using a brief client/server
exchange with the server, then enters the broadcast client mode, in
-which it synchronizes to succeeding multicast messages.
+which it synchronizes to succeeding multicast messages.
Note that,
in order to avoid accidental or malicious disruption in this mode,
both the server and client should operate using symmetric-key or
public-key authentication as described in
-‘Authentication Options’.
-</p></dd>
-<dt><code>mdnstries</code> <kbd>number</kbd></dt>
-<dd><p>If we are participating in mDNS,
+<a href="#Authentication-Options">Authentication Options</a>.
+<br><dt><code>mdnstries</code> <kbd>number</kbd><dd>If we are participating in mDNS,
after we have synched for the first time
-we attempt to register with the mDNS system.
+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>
-times.
+times.
After all,
<code>ntpd</code>
-may be starting before mDNS.
+may be starting before mDNS.
The default value for
<code>mdnstries</code>
-is 5.
-</p></dd>
+is 5.
</dl>
-<hr>
+<div class="node">
<a name="Authentication-Support"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Authentication-Support-1"></a>
-<h4 class="subsection">1.1.2 Authentication Support</h4>
+
+<h4 class="subsection">Authentication Support</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.
+accidentally or on purpose to masquerade as that server.
The NTPv3
specification RFC-1305 defines a scheme which provides
-cryptographic authentication of received NTP packets.
+cryptographic authentication of received NTP packets.
Originally,
this was done using the Data Encryption Standard (DES) algorithm
operating in Cipher Block Chaining (CBC) mode, commonly called
-DES-CBC.
+DES-CBC.
Subsequently, this was replaced by the RSA Message Digest
-5 (MD5) algorithm using a private key, commonly called keyed-MD5.
+5 (MD5) algorithm using a private key, commonly called keyed-MD5.
Either algorithm computes a message digest, or one-way hash, which
can be used to verify the server has the correct private key and
key identifier.
-</p>
-<p>NTPv4 retains the NTPv3 scheme, properly described as symmetric key
+
+
<p>NTPv4 retains the NTPv3 scheme, properly described as symmetric key
cryptography and, in addition, provides a new Autokey scheme
-based on public key cryptography.
+based on public key cryptography.
Public key cryptography is generally considered more secure
than symmetric key cryptography, since the security is based
on a private value which is generated by each server and
-never revealed.
+never revealed.
With Autokey all key distribution and
management functions involve only public values, which
-considerably simplifies key distribution and storage.
+considerably simplifies key distribution and storage.
Public key management is based on X.509 certificates,
which can be provided by commercial services or
produced by utility programs in the OpenSSL software library
or the NTPv4 distribution.
-</p>
-<p>While the algorithms for symmetric key cryptography are
+
+
<p>While the algorithms for symmetric key cryptography are
included in the NTPv4 distribution, public key cryptography
requires the OpenSSL software library to be installed
-before building the NTP distribution.
+before building the NTP distribution.
Directions for doing that
are on the Building and Installing the Distribution page.
-</p>
-<p>Authentication is configured separately for each association
+
+
<p>Authentication is configured separately for each association
using the
<code>key</code>
or
and
<code>manycastclient</code>
configuration commands as described in
-‘Configuration Options’
-page.
+<a href="#Configuration-Options">Configuration Options</a>
+page.
The authentication
options described below specify the locations of the key files,
if other than default, which symmetric keys are trusted
and the interval between various operations, if other than default.
-</p>
-<p>Authentication is always enabled,
+
+
<p>Authentication is always enabled,
although ineffective if not configured as
-described below.
+described below.
If a NTP packet arrives
including a message authentication
code (MAC), it is accepted only if it
-passes all cryptographic checks.
+passes all cryptographic checks.
The
checks require correct key ID, key value
-and message digest.
+and message digest.
If the packet has
been modified in any way or replayed
by an intruder, it will fail one or more
-of these checks and be discarded.
+of these checks and be discarded.
Furthermore, the Autokey scheme requires a
preliminary protocol exchange to obtain
the server certificate, verify its
credentials and initialize the protocol
-</p>
-<p>The
+
<code>auth</code>
flag controls whether new associations or
-remote configuration commands require cryptographic authentication.
+remote configuration commands require cryptographic authentication.
This flag can be set or reset by the
<code>enable</code>
and
configuration commands sent by a
<code>ntpdc(1ntpdcmdoc)</code>
program running on
-another machine.
+another machine.
If this flag is enabled, which is the default
case, new broadcast client and symmetric passive associations and
remote configuration commands must be cryptographically
-authenticated using either symmetric key or public key cryptography.
+authenticated using either symmetric key or public key cryptography.
If this
flag is disabled, these operations are effective
even if not cryptographic
-authenticated.
+authenticated.
It should be understood
that operating with the
<code>auth</code>
flag disabled invites a significant vulnerability
where a rogue hacker can
masquerade as a falseticker and seriously
-disrupt system timekeeping.
+disrupt system timekeeping.
It is
important to note that this flag has no purpose
other than to allow or disallow
and remote configuration commands and, in particular,
the flag has no effect on
the authentication process itself.
-</p>
-<p>An attractive alternative where multicast support is available
+
+
<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>
-page.
+page.
Either symmetric key or public key
-cryptographic authentication can be used in this mode.
+cryptographic authentication can be used in this mode.
The principle advantage
of manycast mode is that potential servers need not be
configured in advance,
since the client finds them during regular operation,
and the configuration
files for all clients can be identical.
-</p>
-<p>The security model and protocol schemes for
+
+
<p>The security model and protocol schemes for
both symmetric key and public key
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><a name="Symmetric_002dKey-Cryptography"></a>
-<h4 class="subsubsection">1.1.2.1 Symmetric-Key Cryptography</h4>
+
+<h5 class="subsubsection">Symmetric-Key Cryptography</h5>
+
<p>The original RFC-1305 specification allows any one of possibly
65,534 keys, each distinguished by a 32-bit key identifier, to
-authenticate an association.
+authenticate an association.
The servers and clients involved must
agree on the key and key identifier to
-authenticate NTP packets.
+authenticate NTP packets.
Keys and
related information are specified in a key
file, usually called
-<samp>ntp.keys</samp>,
+<samp><span class="file">ntp.keys</span></samp>,
which must be distributed and stored using
-secure means beyond the scope of the NTP protocol itself.
+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
and
<code>ntpdc(1ntpdcmdoc)</code>
utility programs.
-</p>
-<p>When
+
<code>ntpd(1ntpdmdoc)</code>
is first started, it reads the key file specified in the
<code>keys</code>
configuration command and installs the keys
-in the key cache.
+in the key cache.
However,
individual keys must be activated with the
<code>trusted</code>
-command before use.
+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>ntpdc(1ntpdcmdoc)</code>.
This also provides a revocation capability that can be used
-if a key becomes compromised.
+if a key becomes compromised.
The
<code>requestkey</code>
command selects the key used as the password for the
command selects the key used as the password for the
<code>ntpq(1ntpqmdoc)</code>
utility.
-</p><a name="Public-Key-Cryptography"></a>
-<h4 class="subsubsection">1.1.2.2 Public Key Cryptography</h4>
+
+<h5 class="subsubsection">Public Key Cryptography</h5>
+
<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.
+which is based on public key cryptography.
The Autokey Version 2 protocol described on the Autokey Protocol
page verifies packet integrity using MD5 message digests
and verifies the source with digital signatures and any of several
-digest/signature schemes.
+digest/signature schemes.
Optional identity schemes described on the Identity Schemes
page and based on cryptographic challenge/response algorithms
-are also available.
+are also available.
Using all of these schemes provides strong security against
replay with or without modification, spoofing, masquerade
and most forms of clogging attacks.
-</p>
-<p>The Autokey protocol has several modes of operation
-corresponding to the various NTP modes supported.
+
+
<p>The Autokey protocol has several modes of operation
+corresponding to the various NTP modes supported.
Most modes use a special cookie which can be
computed independently by the client and server,
-but encrypted in transmission.
+but encrypted in transmission.
All modes use in addition a variant of the S-KEY scheme,
in which a pseudo-random key list is generated and used
-in reverse order.
+in reverse order.
These schemes are described along with an executive summary,
current status, briefing slides and reading list on the
-‘Autonomous Authentication’
+<a href="#Autonomous-Authentication">Autonomous Authentication</a>
page.
-</p>
-<p>The specific cryptographic environment used by Autokey servers
+
+
<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>
-program.
+program.
This includes a required host key file,
required certificate file and optional sign key file,
-leapsecond file and identity scheme files.
+leapsecond file and identity scheme files.
The
digest/signature scheme is specified in the X.509 certificate
-along with the matching sign key.
+along with the matching sign key.
There are several schemes
available in the OpenSSL software library, each identified
by a specific string such as
<code>md5WithRSAEncryption</code>,
which stands for the MD5 message digest with RSA
-encryption scheme.
+encryption scheme.
The current NTP distribution supports
all the schemes in the OpenSSL library, including
those based on RSA and DSA digital signatures.
-</p>
-<p>NTP secure groups can be used to define cryptographic compartments
-and security hierarchies.
+
+
<p>NTP secure groups can be used to define cryptographic compartments
+and security hierarchies.
It is important that every host
in the group be able to construct a certificate trail to one
-or more trusted hosts in the same group.
+or more trusted hosts in the same group.
Each group
host runs the Autokey protocol to obtain the certificates
-for all hosts along the trail to one or more trusted hosts.
+for all hosts along the trail to one or more trusted hosts.
This requires the configuration file in all hosts to be
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><a name="Naming-and-Addressing"></a>
-<h4 class="subsubsection">1.1.2.3 Naming and Addressing</h4>
+
+<h5 class="subsubsection">Naming and Addressing</h5>
+
<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.
+resolve addresses, since DNS can't be completely trusted
+until the name servers have synchronized clocks.
The cryptographic name used by Autokey to bind the host identity
credentials and cryptographic values must be independent
-of interface, network and any other naming convention.
+of interface, network and any other naming convention.
The name appears in the host certificate in either or both
the subject and issuer fields, so protection against
DNS compromise is essential.
-</p>
-<p>By convention, the name of an Autokey host is the name returned
+
+
<p>By convention, the name of an Autokey host is the name returned
by the Unix
<code>gethostname(2)</code>
-system call or equivalent in other systems.
+system call or equivalent in other systems.
By the system design
-model, there are no provisions to allow alternate names or aliases.
+model, there are no provisions to allow alternate names or aliases.
However, this is not to say that DNS aliases, different names
for each interface, etc., are constrained in any way.
-</p>
-<p>It is also important to note that Autokey verifies authenticity
+
+
<p>It is also important to note that Autokey verifies authenticity
using the host name, network address and public keys,
all of which are bound together by the protocol specifically
-to deflect masquerade attacks.
+to deflect masquerade attacks.
For this reason Autokey
includes the source and destination IP addresses in message digest
computations and so the same addresses must be available
-at both the server and client.
+at both the server and client.
For this reason operation
-with network address translation schemes is not possible.
+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><a name="Operation"></a>
-<h4 class="subsubsection">1.1.2.4 Operation</h4>
+
+<h5 class="subsubsection">Operation</h5>
+
<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.
+a cryptotype, although not all combinations are compatible.
There may be management configurations where the clients,
-servers and peers may not all support the same cryptotypes.
+servers and peers may not all support the same cryptotypes.
A secure NTPv4 subnet can be configured in many ways while
keeping in mind the principles explained above and
-in this section.
+in this section.
Note however that some cryptotype
combinations may successfully interoperate with each other,
but may not represent good security practice.
-</p>
-<p>The cryptotype of an association is determined at the time
+
+
<p>The cryptotype of an association is determined at the time
of mobilization, either at configuration time or some time
-later when a message of appropriate cryptotype arrives.
+later when a message of appropriate cryptotype arrives.
When mobilized by a
<code>server</code>
or
<code>autokey</code>
subcommand is present, the association is authenticated
using Autokey.
-</p>
-<p>When multiple identity schemes are supported in the Autokey
-protocol, the first message exchange determines which one is used.
+
+
<p>When multiple identity schemes are supported in the Autokey
+protocol, the first message exchange determines which one is used.
The client request message contains bits corresponding
-to which schemes it has available.
+to which schemes it has available.
The server response message
-contains bits corresponding to which schemes it has available.
+contains bits corresponding to which schemes it has available.
Both server and client match the received bits with their own
and select a common scheme.
-</p>
-<p>Following the principle that time is a public value,
+
+
<p>Following the principle that time is a public value,
a server responds to any client packet that matches
-its cryptotype capabilities.
+its cryptotype capabilities.
Thus, a server receiving
an unauthenticated packet will respond with an unauthenticated
packet, while the same server receiving a packet of a cryptotype
-it supports will respond with packets of that cryptotype.
+it supports will respond with packets of that cryptotype.
However, unconfigured broadcast or manycast client
associations or symmetric passive associations will not be
mobilized unless the server supports a cryptotype compatible
-with the first packet received.
+with the first packet received.
By default, unauthenticated associations will not be mobilized
unless overridden in a decidedly dangerous way.
-</p>
-<p>Some examples may help to reduce confusion.
-Client Alice has no specific cryptotype selected.
-Server Bob has both a symmetric key file and minimal Autokey files.
-Alice’s unauthenticated messages arrive at Bob, who replies with
-unauthenticated messages.
-Cathy has a copy of Bob’s symmetric
-key file and has selected key ID 4 in messages to Bob.
-Bob verifies the message with his key ID 4.
-If it’s the
+
+ <p>Some examples may help to reduce confusion.
+Client Alice has no specific cryptotype selected.
+Server Bob has both a symmetric key file and minimal Autokey files.
+Alice's unauthenticated messages arrive at Bob, who replies with
+unauthenticated messages.
+Cathy has a copy of Bob's symmetric
+key file and has selected key ID 4 in messages to Bob.
+Bob verifies the message with his key ID 4.
+If it's the
same key and the message is verified, Bob sends Cathy a reply
-authenticated with that key.
+authenticated with that key.
If verification fails,
Bob sends Cathy a thing called a crypto-NAK, which tells her
-something broke.
+something broke.
She can see the evidence using the
<code>ntpq(1ntpqmdoc)</code>
program.
-</p>
-<p>Denise has rolled her own host key and certificate.
-She also uses one of the identity schemes as Bob.
+
+ <p>Denise has rolled her own host key and certificate.
+She also uses one of the identity schemes as Bob.
She sends the first Autokey message to Bob and they
-both dance the protocol authentication and identity steps.
+both dance the protocol authentication and identity steps.
If all comes out okay, Denise and Bob continue as described above.
-</p>
-<p>It should be clear from the above that Bob can support
+
+
<p>It should be clear from the above that Bob can support
all the girls at the same time, as long as he has compatible
-authentication and identity credentials.
+authentication and identity credentials.
Now, Bob can act just like the girls in his own choice of servers;
he can run multiple configured associations with multiple different
-servers (or the same server, although that might not be useful).
+servers (or the same server, although that might not be useful).
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><a name="Key-Management"></a>
-<h4 class="subsubsection">1.1.2.5 Key Management</h4>
+
+<h5 class="subsubsection">Key Management</h5>
+
<p>The cryptographic values used by the Autokey protocol are
incorporated as a set of files generated by the
<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 leapseconds files.
Alternatively, host and sign keys and
certificate files can be generated by the OpenSSL utilities
and certificates can be imported from public certificate
-authorities.
+authorities.
Note that symmetric keys are necessary for the
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
-utility programs.
+utility programs.
The remaining files are necessary only for the
Autokey protocol.
-</p>
-<p>Certificates imported from OpenSSL or public certificate
-authorities have certian limitations.
+
+
<p>Certificates imported from OpenSSL or public certificate
+authorities have certian limitations.
The certificate should be in ASN.1 syntax, X.509 Version 3
format and encoded in PEM, which is the same format
-used by OpenSSL.
+used by OpenSSL.
The overall length of the certificate encoded
-in ASN.1 must not exceed 1024 bytes.
+in ASN.1 must not exceed 1024 bytes.
The subject distinguished
name field (CN) is the fully qualified name of the host
-on which it is used; the remaining subject fields are ignored.
+on which it is used; the remaining subject fields are ignored.
The certificate extension fields must not contain either
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>trustRoot</code>;.
Other extension fields are ignored.
-</p><a name="Authentication-Commands"></a>
-<h4 class="subsubsection">1.1.2.6 Authentication Commands</h4>
-<dl compact="compact">
-<dt><code>autokey</code> <code>[<kbd>logsec</kbd>]</code></dt>
-<dd><p>Specifies the interval between regenerations of the session key
-list used with the Autokey protocol.
+
+<h5 class="subsubsection">Authentication Commands</h5>
+
+ <dl>
+<dt><code>autokey</code> <code>[</code><kbd>logsec</kbd><code>]</code><dd>Specifies the interval between regenerations of the session key
+list used with the Autokey protocol.
Note that the size of the key
list for each association depends on this interval and the current
-poll interval.
-The default value is 12 (4096 s or about 1.1 hours).
+poll interval.
+The default value is 12 (4096 s or about 1.1 hours).
For poll intervals above the specified interval, a session key list
with a single entry will be regenerated for every message
-sent.
-</p></dd>
-<dt><code>controlkey</code> <kbd>key</kbd></dt>
-<dd><p>Specifies the key identifier to use with the
+sent.
+<br><dt><code>controlkey</code> <kbd>key</kbd><dd>Specifies the key identifier to use with the
<code>ntpq(1ntpqmdoc)</code>
utility, which uses the standard
-protocol defined in RFC-1305.
+protocol defined in RFC-1305.
The
<kbd>key</kbd>
argument is
the key identifier for a trusted key, where the value can be in the
-range 1 to 65,534, 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>sign</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>
-<dd><p>This command requires the OpenSSL library.
+range 1 to 65,534, inclusive.
+<br><dt><code>crypto</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>[sign </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>]</code><dd>This command requires the OpenSSL library.
It activates public key
cryptography, selects the message digest and signature
encryption scheme and loads the required private and public
-values described above.
+values described above.
If one or more files are left unspecified,
-the default names are used as described above.
+the default names are used as described above.
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>
command or default
-<samp>/usr/local/etc</samp>.
+<samp><span class="file">/usr/local/etc</span></samp>.
Following are the subcommands:
-</p><dl compact="compact">
-<dt><code>cert</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the required host public certificate file.
+ <dl>
+<dt><code>cert</code> <kbd>file</kbd><dd>Specifies the location of the required host public certificate file.
This overrides the link
-<samp>ntpkey_cert_</samp><kbd>hostname</kbd>
-in the keys directory.
-</p></dd>
-<dt><code>gqpar</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the optional GQ parameters file.
+<samp><span class="file">ntpkey_cert_</span></samp><kbd>hostname</kbd>
+in the keys directory.
+<br><dt><code>gqpar</code> <kbd>file</kbd><dd>Specifies the location of the optional GQ parameters file.
This
overrides the link
-<samp>ntpkey_gq_</samp><kbd>hostname</kbd>
-in the keys directory.
-</p></dd>
-<dt><code>host</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the required host key file.
+<samp><span class="file">ntpkey_gq_</span></samp><kbd>hostname</kbd>
+in the keys directory.
+<br><dt><code>host</code> <kbd>file</kbd><dd>Specifies the location of the required host key file.
This overrides
the link
-<samp>ntpkey_key_</samp><kbd>hostname</kbd>
-in the keys directory.
-</p></dd>
-<dt><code>iffpar</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the optional IFF parameters file.
+<samp><span class="file">ntpkey_key_</span></samp><kbd>hostname</kbd>
+in the keys directory.
+<br><dt><code>iffpar</code> <kbd>file</kbd><dd>Specifies the location of the optional IFF parameters file.
This overrides the link
-<samp>ntpkey_iff_</samp><kbd>hostname</kbd>
-in the keys directory.
-</p></dd>
-<dt><code>leap</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the optional leapsecond file.
+<samp><span class="file">ntpkey_iff_</span></samp><kbd>hostname</kbd>
+in the keys directory.
+<br><dt><code>leap</code> <kbd>file</kbd><dd>Specifies the location of the optional leapsecond file.
This overrides the link
-<samp>ntpkey_leap</samp>
-in the keys directory.
-</p></dd>
-<dt><code>mvpar</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the optional MV parameters file.
+<samp><span class="file">ntpkey_leap</span></samp>
+in the keys directory.
+<br><dt><code>mvpar</code> <kbd>file</kbd><dd>Specifies the location of the optional MV parameters file.
This overrides the link
-<samp>ntpkey_mv_</samp><kbd>hostname</kbd>
-in the keys directory.
-</p></dd>
-<dt><code>pw</code> <kbd>password</kbd></dt>
-<dd><p>Specifies the password to decrypt files containing private keys and
-identity parameters.
+<samp><span class="file">ntpkey_mv_</span></samp><kbd>hostname</kbd>
+in the keys directory.
+<br><dt><code>pw</code> <kbd>password</kbd><dd>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>
-<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>
-<dt><code>sign</code> <kbd>file</kbd></dt>
-<dd><p>Specifies the location of the optional sign key file.
+encrypted.
+<br><dt><code>randfile</code> <kbd>file</kbd><dd>Specifies the location of the random seed file used by the OpenSSL
+library.
+The defaults are described in the main text above.
+<br><dt><code>sign</code> <kbd>file</kbd><dd>Specifies the location of the optional sign key file.
This overrides
the link
-<samp>ntpkey_sign_</samp><kbd>hostname</kbd>
-in the keys directory.
+<samp><span class="file">ntpkey_sign_</span></samp><kbd>hostname</kbd>
+in the keys directory.
If this file is
-not found, the host key is also the sign key.
-</p></dd>
+not found, the host key is also the sign key.
</dl>
-</dd>
-<dt><code>keys</code> <kbd>keyfile</kbd></dt>
-<dd><p>Specifies the complete path and location of the MD5 key file
+ <br><dt><code>keys</code> <kbd>keyfile</kbd><dd>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>
and
<code>ntpdc(1ntpdcmdoc)</code>
-when operating with symmetric key cryptography.
+when operating with symmetric key cryptography.
This is the same operation as the
<code>-k</code>
-command line option.
-</p></dd>
-<dt><code>keysdir</code> <kbd>path</kbd></dt>
-<dd><p>This command specifies the default directory path for
-cryptographic keys, parameters and certificates.
+command line option.
+<br><dt><code>keysdir</code> <kbd>path</kbd><dd>This command specifies the default directory path for
+cryptographic keys, parameters and certificates.
The default is
-<samp>/usr/local/etc/</samp>.
-</p></dd>
-<dt><code>requestkey</code> <kbd>key</kbd></dt>
-<dd><p>Specifies the key identifier to use with the
+<samp><span class="file">/usr/local/etc/</span></samp>.
+<br><dt><code>requestkey</code> <kbd>key</kbd><dd>Specifies the key identifier to use with the
<code>ntpdc(1ntpdcmdoc)</code>
utility program, which uses a
proprietary protocol specific to this implementation of
-<code>ntpd(1ntpdmdoc)</code>.
+<code>ntpd(1ntpdmdoc)</code>.
The
<kbd>key</kbd>
argument is a key identifier
for the trusted key, where the value can be in the range 1 to
-65,534, inclusive.
-</p></dd>
-<dt><code>revoke</code> <kbd>logsec</kbd></dt>
-<dd><p>Specifies the interval between re-randomization of certain
+65,534, inclusive.
+<br><dt><code>revoke</code> <kbd>logsec</kbd><dd>Specifies the interval between re-randomization of certain
cryptographic values used by the Autokey scheme, as a power of 2 in
-seconds.
+seconds.
These values need to be updated frequently in order to
deflect brute-force attacks on the algorithms of the scheme;
-however, updating some values is a relatively expensive operation.
-The default interval is 16 (65,536 s or about 18 hours).
+however, updating some values is a relatively expensive operation.
+The default interval is 16 (65,536 s or about 18 hours).
For poll
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>
-<dd><p>Specifies the key identifiers which are trusted for the
+for every message sent.
+<br><dt><code>trustedkey</code> <kbd>key</kbd> <kbd>...</kbd><dd>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>
and
<code>ntpdc(1ntpdcmdoc)</code>
-programs.
+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.
+servers.
The
<kbd>key</kbd>
arguments are 32-bit unsigned
-integers with values from 1 to 65,534.
-</p></dd>
+integers with values from 1 to 65,534.
</dl>
-<a name="Error-Codes"></a>
-<h4 class="subsubsection">1.1.2.7 Error Codes</h4>
+
+<h5 class="subsubsection">Error Codes</h5>
+
<p>The following error codes are reported via the NTP control
and monitoring protocol trap mechanism.
-</p><dl compact="compact">
-<dt>101</dt>
-<dd><p>(bad field format or length)
-The packet has invalid version, length or format.
-</p></dd>
-<dt>102</dt>
-<dd><p>(bad timestamp)
-The packet timestamp is the same or older than the most recent received.
-This could be due to a replay or a server clock time step.
-</p></dd>
-<dt>103</dt>
-<dd><p>(bad filestamp)
-The packet filestamp is the same or older than the most recent received.
-This could be due to a replay or a key file generation error.
-</p></dd>
-<dt>104</dt>
-<dd><p>(bad or missing public key)
-The public key is missing, has incorrect format or is an unsupported type.
-</p></dd>
-<dt>105</dt>
-<dd><p>(unsupported digest type)
-The server requires an unsupported digest/signature scheme.
-</p></dd>
-<dt>106</dt>
-<dd><p>(mismatched digest types)
-Not used.
-</p></dd>
-<dt>107</dt>
-<dd><p>(bad signature length)
-The signature length does not match the current public key.
-</p></dd>
-<dt>108</dt>
-<dd><p>(signature not verified)
-The message fails the signature check.
+ <dl>
+<dt>101<dd>(bad field format or length)
+The packet has invalid version, length or format.
+<br><dt>102<dd>(bad timestamp)
+The packet timestamp is the same or older than the most recent received.
+This could be due to a replay or a server clock time step.
+<br><dt>103<dd>(bad filestamp)
+The packet filestamp is the same or older than the most recent received.
+This could be due to a replay or a key file generation error.
+<br><dt>104<dd>(bad or missing public key)
+The public key is missing, has incorrect format or is an unsupported type.
+<br><dt>105<dd>(unsupported digest type)
+The server requires an unsupported digest/signature scheme.
+<br><dt>106<dd>(mismatched digest types)
+Not used.
+<br><dt>107<dd>(bad signature length)
+The signature length does not match the current public key.
+<br><dt>108<dd>(signature not verified)
+The message fails the signature check.
It could be bogus or signed by a
-different private key.
-</p></dd>
-<dt>109</dt>
-<dd><p>(certificate not verified)
-The certificate is invalid or signed with the wrong key.
-</p></dd>
-<dt>110</dt>
-<dd><p>(certificate not verified)
+different private key.
+<br><dt>109<dd>(certificate not verified)
+The certificate is invalid or signed with the wrong key.
+<br><dt>110<dd>(certificate not verified)
The certificate is not yet valid or has expired or the signature could not
-be verified.
-</p></dd>
-<dt>111</dt>
-<dd><p>(bad or missing cookie)
-The cookie is missing, corrupted or bogus.
-</p></dd>
-<dt>112</dt>
-<dd><p>(bad or missing leapseconds table)
-The leapseconds table is missing, corrupted or bogus.
-</p></dd>
-<dt>113</dt>
-<dd><p>(bad or missing certificate)
-The certificate is missing, corrupted or bogus.
-</p></dd>
-<dt>114</dt>
-<dd><p>(bad or missing identity)
-The identity key is missing, corrupt or bogus.
-</p></dd>
+be verified.
+<br><dt>111<dd>(bad or missing cookie)
+The cookie is missing, corrupted or bogus.
+<br><dt>112<dd>(bad or missing leapseconds table)
+The leapseconds table is missing, corrupted or bogus.
+<br><dt>113<dd>(bad or missing certificate)
+The certificate is missing, corrupted or bogus.
+<br><dt>114<dd>(bad or missing identity)
+The identity key is missing, corrupt or bogus.
</dl>
-<hr>
+ <div class="node">
<a name="Monitoring-Support"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Monitoring-Support-1"></a>
-<h4 class="subsection">1.1.3 Monitoring Support</h4>
+
+<h4 class="subsection">Monitoring Support</h4>
+
<p><code>ntpd(1ntpdmdoc)</code>
includes a comprehensive monitoring facility suitable
for continuous, long term recording of server and client
-timekeeping performance.
+timekeeping performance.
See the
<code>statistics</code>
command below
for a listing and example of each type of statistics currently
-supported.
+supported.
Statistic files are managed using file generation sets
and scripts in the
-<samp>./scripts</samp>
-directory of the source code distribution.
+<samp><span class="file">./scripts</span></samp>
+directory of the source code distribution.
Using
these facilities and
-<small>UNIX</small>
+<span class="sc">unix</span>
<code>cron(8)</code>
jobs, the data can be
automatically summarized and archived for retrospective analysis.
-</p><a name="Monitoring-Commands"></a>
-<h4 class="subsubsection">1.1.3.1 Monitoring Commands</h4>
-<dl compact="compact">
-<dt><code>statistics</code> <kbd>name</kbd> <kbd>...</kbd></dt>
-<dd><p>Enables writing of statistics records.
+
+<h5 class="subsubsection">Monitoring Commands</h5>
+
+ <dl>
+<dt><code>statistics</code> <kbd>name</kbd> <kbd>...</kbd><dd>Enables writing of statistics records.
Currently, eight kinds of
<kbd>name</kbd>
statistics are supported.
-</p><dl compact="compact">
-<dt><code>clockstats</code></dt>
-<dd><p>Enables recording of clock driver statistics information.
+ <dl>
+<dt><code>clockstats</code><dd>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>:
-</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
-(seconds and fraction past UTC midnight).
+<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
+(seconds and fraction past UTC midnight).
The next field shows the
-clock address in dotted-quad notation.
+clock address in dotted-quad notation.
The final field shows the last
timecode received from the clock in decoded ASCII format, where
-meaningful.
+meaningful.
In some clock drivers a good deal of additional information
-can be gathered and displayed as well.
+can be gathered and displayed as well.
See information specific to each
-clock for further details.
-</p></dd>
-<dt><code>cryptostats</code></dt>
-<dd><p>This option requires the OpenSSL cryptographic software library.
+clock for further details.
+<br><dt><code>cryptostats</code><dd>This option requires the OpenSSL cryptographic software library.
It
-enables recording of cryptographic public key protocol information.
+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>:
-</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
-(seconds and fraction past UTC midnight).
+<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
+(seconds and fraction past UTC midnight).
The next field shows the peer
address in dotted-quad notation, The final message field includes the
-message type and certain ancillary information.
+message type and certain ancillary information.
See the
-‘Authentication Options’
-section for further information.
-</p></dd>
-<dt><code>loopstats</code></dt>
-<dd><p>Enables recording of loop filter statistics information.
+<a href="#Authentication-Options">Authentication Options</a>
+section for further information.
+<br><dt><code>loopstats</code><dd>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>:
-</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
-time (seconds and fraction past UTC midnight).
+<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
+time (seconds and fraction past UTC midnight).
The next five fields
show time offset (seconds), frequency offset (parts per million -
PPM), RMS jitter (seconds), Allan deviation (PPM) and clock
-discipline time constant.
-</p></dd>
-<dt><code>peerstats</code></dt>
-<dd><p>Enables recording of peer statistics information.
+discipline time constant.
+<br><dt><code>peerstats</code><dd>Enables recording of peer statistics information.
This includes
statistics records of all peers of a NTP server and of special
-signals, where present and configured.
+signals, where present and configured.
Each valid update appends a
line of the following form to the current element of a file
generation set named
<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
-time (seconds and fraction past UTC midnight).
+<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
+time (seconds and fraction past UTC midnight).
The next two fields
show the peer address in dotted-quad notation and status,
-respectively.
+respectively.
The status field is encoded in hex in the format
-described in Appendix A of the NTP specification RFC 1305.
+described in Appendix A of the NTP specification RFC 1305.
The final four fields show the offset,
-delay, dispersion and RMS jitter, all in seconds.
-</p></dd>
-<dt><code>rawstats</code></dt>
-<dd><p>Enables recording of raw-timestamp statistics information.
+delay, dispersion and RMS jitter, all in seconds.
+<br><dt><code>rawstats</code><dd>Enables recording of raw-timestamp statistics information.
This
includes statistics records of all peers of a NTP server and of
-special signals, where present and configured.
+special signals, where present and configured.
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>:
-</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
-time (seconds and fraction past UTC midnight).
+<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
+time (seconds and fraction past UTC midnight).
The next two fields
show the remote peer or clock address followed by the local address
-in dotted-quad notation.
+in dotted-quad notation.
The final four fields show the originate,
-receive, transmit and final NTP timestamps in order.
+receive, transmit and final NTP timestamps in order.
The timestamp
values are as received and before processing by the various data
-smoothing and mitigation algorithms.
-</p></dd>
-<dt><code>sysstats</code></dt>
-<dd><p>Enables recording of ntpd statistics counters on a periodic basis.
+smoothing and mitigation algorithms.
+<br><dt><code>sysstats</code><dd>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>:
-</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
-(seconds and fraction past UTC midnight).
+<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
+(seconds and fraction past UTC midnight).
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>
-<dd><p>Time in hours since the system was last rebooted.
-</p></dd>
-<dt>Packets received <code>81965</code></dt>
-<dd><p>Total number of packets received.
-</p></dd>
-<dt>Packets processed <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>
-<dd><p>Number of packets matching the current NTP version.
-</p></dd>
-<dt>Previous version <code>56</code></dt>
-<dd><p>Number of packets matching the previous NTP version.
-</p></dd>
-<dt>Bad version <code>71793</code></dt>
-<dd><p>Number of packets matching neither NTP version.
-</p></dd>
-<dt>Access denied <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>
-<dd><p>Number of packets with invalid length, format or port number.
-</p></dd>
-<dt>Bad authentication <code>10</code></dt>
-<dd><p>Number of packets not verified as authentic.
-</p></dd>
-<dt>Rate exceeded <code>147</code></dt>
-<dd><p>Number of packets discarded due to rate limitation.
-</p></dd>
+ <dl>
+<dt>Time since restart <code>36000</code><dd>Time in hours since the system was last rebooted.
+<br><dt>Packets received <code>81965</code><dd>Total number of packets received.
+<br><dt>Packets processed <code>0</code><dd>Number of packets received in response to previous packets sent
+<br><dt>Current version <code>9546</code><dd>Number of packets matching the current NTP version.
+<br><dt>Previous version <code>56</code><dd>Number of packets matching the previous NTP version.
+<br><dt>Bad version <code>71793</code><dd>Number of packets matching neither NTP version.
+<br><dt>Access denied <code>512</code><dd>Number of packets denied access for any reason.
+<br><dt>Bad length or format <code>540</code><dd>Number of packets with invalid length, format or port number.
+<br><dt>Bad authentication <code>10</code><dd>Number of packets not verified as authentic.
+<br><dt>Rate exceeded <code>147</code><dd>Number of packets discarded due to rate limitation.
</dl>
-</dd>
-<dt><code>statsdir</code> <kbd>directory_path</kbd></dt>
-<dd><p>Indicates the full path of a directory where statistics files
-should be created (see below).
+ <br><dt><code>statsdir</code> <kbd>directory_path</kbd><dd>Indicates the full path of a directory where statistics files
+should be created (see below).
This keyword allows
the (otherwise constant)
<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>
-<dd><p>Configures setting of generation file set name.
+is useful for handling statistics logs.
+<br><dt><code>filegen</code> <kbd>name</kbd> <code>[file </code><kbd>filename</kbd><code>]</code> <code>[type </code><kbd>typename</kbd><code>]</code> <code>[link | nolink]</code> <code>[enable | disable]</code><dd>Configures setting of generation file set name.
Generation
file sets provide a means for handling files that are
-continuously growing during the lifetime of a server.
-Server statistics are a typical example for such files.
+continuously growing during the lifetime of a server.
+Server statistics are a typical example for such files.
Generation file sets provide access to a set of files used
-to store the actual data.
+to store the actual data.
At any time at most one element
-of the set is being written to.
+of the set is being written to.
The type given specifies
-when and how data will be directed to a new element of the set.
+when and how data will be directed to a new element of the set.
This way, information stored in elements of a file set
that are currently unused are available for administrational
-operations without the risk of disturbing the operation of ntpd.
+operations without the risk of disturbing the operation of ntpd.
(Most important: they can be removed to free space for new data
produced.)
-</p>
-<p>Note that this command can be sent from the
+
+
<p>Note that this command can be sent from the
<code>ntpdc(1ntpdcmdoc)</code>
program running at a remote location.
-</p><dl compact="compact">
-<dt><code>name</code></dt>
-<dd><p>This is the type of the statistics records, as shown in the
+ <dl>
+<dt><code>name</code><dd>This is the type of the statistics records, as shown in the
<code>statistics</code>
-command.
-</p></dd>
-<dt><code>file</code> <kbd>filename</kbd></dt>
-<dd><p>This is the file name for the statistics records.
+command.
+<br><dt><code>file</code> <kbd>filename</kbd><dd>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>
and
<code>suffix</code>:
-</p><dl compact="compact">
-<dt><code>prefix</code></dt>
-<dd><p>This is a constant filename path.
+ <dl>
+<dt><code>prefix</code><dd>This is a constant filename path.
It is not subject to
modifications via the
<kbd>filegen</kbd>
-option.
+option.
It is defined by the
-server, usually specified as a compile-time constant.
+server, usually specified as a compile-time constant.
It may,
however, be configurable for individual file generation sets
-via other commands.
+via other commands.
For example, the prefix used with
<kbd>loopstats</kbd>
and
<kbd>peerstats</kbd>
generation can be configured using the
<kbd>statsdir</kbd>
-option explained above.
-</p></dd>
-<dt><code>filename</code></dt>
-<dd><p>This string is directly concatenated to the prefix mentioned
+option explained above.
+<br><dt><code>filename</code><dd>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>
-statement.
+statement.
No
-<samp>..</samp>
+<samp><span class="file">..</span></samp>
elements are
allowed in this component to prevent filenames referring to
parts outside the filesystem hierarchy denoted by
-<kbd>prefix</kbd>.
-</p></dd>
-<dt><code>suffix</code></dt>
-<dd><p>This part is reflects individual elements of a file set.
+<kbd>prefix</kbd>.
+<br><dt><code>suffix</code><dd>This part is reflects individual elements of a file set.
It is
-generated according to the type of a file set.
-</p></dd>
+generated according to the type of a file set.
</dl>
-</dd>
-<dt><code>type</code> <kbd>typename</kbd></dt>
-<dd><p>A file generation set is characterized by its type.
+ <br><dt><code>type</code> <kbd>typename</kbd><dd>A file generation set is characterized by its type.
The following
types are supported:
-</p><dl compact="compact">
-<dt><code>none</code></dt>
-<dd><p>The file set is actually a single plain file.
-</p></dd>
-<dt><code>pid</code></dt>
-<dd><p>One element of file set is used per incarnation of a ntpd
-server.
+ <dl>
+<dt><code>none</code><dd>The file set is actually a single plain file.
+<br><dt><code>pid</code><dd>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>
-server incarnations.
+server incarnations.
The set member filename is built by appending a
‘.’
to concatenated
strings, and
appending the decimal representation of the process ID of the
<code>ntpd(1ntpdmdoc)</code>
-server process.
-</p></dd>
-<dt><code>day</code></dt>
-<dd><p>One file generation set element is created per day.
+server process.
+<br><dt><code>day</code><dd>One file generation set element is created per day.
A day is
-defined as the period between 00:00 and 24:00 UTC.
+defined as the period between 00:00 and 24:00 UTC.
The file set
member suffix consists of a
‘.’
and a day specification in
the form
-<code>YYYYMMdd</code>.
+<code>YYYYMMdd</code>.
<code>YYYY</code>
-is a 4-digit year number (e.g., 1992).
+is a 4-digit year number (e.g., 1992).
<code>MM</code>
-is a two digit month number.
+is a two digit month number.
<code>dd</code>
-is a two digit day number.
+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.
-</p></dd>
-<dt><code>week</code></dt>
-<dd><p>Any file set member contains data related to a certain week of
-a year.
+<kbd>filename</kbd>.19921210.
+<br><dt><code>week</code><dd>Any file set member contains data related to a certain week of
+a year.
The term week is defined by computing day-of-year
-modulo 7.
+modulo 7.
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>,
-and a 2-digit week number.
+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>
-<dd><p>One generation file set element is generated per month.
+.No . Ns Ar 1992W1 .
+<br><dt><code>month</code><dd>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>
-<dd><p>One generation file element is generated per year.
+a 2-digit month.
+<br><dt><code>year</code><dd>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>
-<dd><p>This type of file generation sets changes to a new element of
-the file set every 24 hours of server operation.
+suffix consists of a dot and a 4 digit year number.
+<br><dt><code>age</code><dd>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>,
-and an 8-digit number.
+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.
+running at the start of the corresponding 24-hour period.
Information is only written to a file generation by specifying
<code>enable</code>;
output is prevented by specifying
-<code>disable</code>.
-</p></dd>
+<code>disable</code>.
</dl>
-</dd>
-<dt><code>link</code> | <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.
+ <br><dt><code>link</code> | <code>nolink</code><dd>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>
and disabled using
-<code>nolink</code>.
+<code>nolink</code>.
If link is specified, a
hard link from the current file set element to a file without
-suffix is created.
+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>,
and the pid of the
<code>ntpd(1ntpdmdoc)</code>
-server process.
+server process.
When the
-number of links is greater than one, the file is unlinked.
+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>
-<dd><p>Enables or disables the recording function.
-</p></dd>
-</dl>
-</dd>
+allows the current file to be accessed by a constant name.
+<br><dt><code>enable</code> <code>|</code> <code>disable</code><dd>Enables or disables the recording function.
</dl>
-</dd>
-</dl>
-<hr>
+ </dl>
+ </dl>
+<div class="node">
<a name="Access-Control-Support"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Access-Control-Support-1"></a>
-<h4 class="subsection">1.1.4 Access Control Support</h4>
+
+<h4 class="subsection">Access Control Support</h4>
+
<p>The
<code>ntpd(1ntpdmdoc)</code>
daemon implements a general purpose address/mask based restriction
-list.
+list.
The list contains address/match entries sorted first
-by increasing address values and and then by increasing mask values.
+by increasing address values and and then by increasing mask values.
A match occurs when the bitwise AND of the mask and the packet
source address is equal to the bitwise AND of the mask and
-address in the list.
+address in the list.
The list is searched in order with the
last match found defining the restriction flags associated
-with the entry.
+with the entry.
Additional information and examples can be found in the
-"Notes on Configuring NTP and Setting up a NTP Subnet"
+"Notes on Configuring NTP and Setting up a NTP Subnet"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
-</p>
-<p>The restriction facility was implemented in conformance
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
+
+
<p>The restriction facility was implemented in conformance
with the access policies for the original NSFnet backbone
-time servers.
+time servers.
Later the facility was expanded to deflect
-cryptographic and clogging attacks.
+cryptographic and clogging attacks.
While this facility may
be useful for keeping unwanted or broken or malicious clients
from congesting innocent servers, it should not be considered
-an alternative to the NTP authentication facilities.
+an alternative to the NTP authentication facilities.
Source address based restrictions are easily circumvented
by a determined cracker.
-</p>
-<p>Clients can be denied service because they are explicitly
+
+
<p>Clients can be denied service because they are explicitly
included in the restrict list created by the
<code>restrict</code>
command
or implicitly as the result of cryptographic or rate limit
-violations.
+violations.
Cryptographic violations include certificate
or identity verification failure; rate limit violations generally
result from defective NTP implementations that send packets
-at abusive rates.
+at abusive rates.
Some violations cause denied service
only for the offending packet, others cause denied service
for a timed period and others cause the denied service for
-an indefinite period.
+an indefinite period.
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><a name="The-Kiss_002dof_002dDeath-Packet"></a>
-<h4 class="subsubsection">1.1.4.1 The Kiss-of-Death Packet</h4>
+
+<h5 class="subsubsection">The Kiss-of-Death Packet</h5>
+
<p>Ordinarily, packets denied service are simply dropped with no
-further action except incrementing statistics counters.
+further action except incrementing statistics counters.
Sometimes a
more proactive response is needed, such as a server message that
explicitly requests the client to stop sending and leave a message
-for the system operator.
+for the system operator.
A special packet format has been created
-for this purpose called the "kiss-of-death" (KoD) packet.
+for this purpose called the "kiss-of-death" (KoD) packet.
KoD packets have the leap bits set unsynchronized and stratum set
to zero and the reference identifier field set to a four-byte
-ASCII code.
+ASCII code.
If the
<code>noserve</code>
or
<code>notrust</code>
flag of the matching restrict list entry is set,
-the code is "DENY"; if the
+the code is "DENY"; if the
<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".
-</p>
-<p>A client receiving a KoD performs a set of sanity checks to
+is exceeded, the code is "RATE".
+Finally, if a cryptographic violation occurs, the code is "CRYP".
+
+
<p>A client receiving a KoD performs a set of sanity checks to
minimize security exposure, then updates the stratum and
reference identifier peer variables, sets the access
denied (TEST4) bit in the peer flash variable and sends
-a message to the log.
+a message to the log.
As long as the TEST4 bit is set,
-the client will send no further packets to the server.
+the client will send no further packets to the server.
The only way at present to recover from this condition is
-to restart the protocol at both the client and server.
+to restart the protocol at both the client and server.
This
-happens automatically at the client when the association times out.
+happens automatically at the client when the association times out.
It will happen at the server only if the server operator cooperates.
-</p><a name="Access-Control-Commands"></a>
-<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>
-<dd><p>Set the parameters of the
+
+<h5 class="subsubsection">Access Control Commands</h5>
+
+ <dl>
+<dt><code>discard</code> <code>[average </code><kbd>avg</kbd><code>]</code> <code>[minimum </code><kbd>min</kbd><code>]</code> <code>[monitor </code><kbd>prob</kbd><code>]</code><dd>Set the parameters of the
<code>limited</code>
facility which protects the server from
-client abuse.
+client abuse.
The
<code>average</code>
subcommand specifies the minimum average packet
spacing, while the
<code>minimum</code>
-subcommand specifies the minimum packet spacing.
+subcommand specifies the minimum packet spacing.
Packets that violate these minima are discarded
-and a kiss-o’-death packet returned if enabled.
+and a kiss-o'-death packet returned if enabled.
The default
-minimum average and minimum are 5 and 2, respectively.
+minimum average and minimum are 5 and 2, respectively.
The
<code>monitor</code>
subcommand specifies the probability of discard
-for packets that overflow the rate-control window.
-</p></dd>
-<dt><code>restrict</code> <code>address</code> <code>[<code>mask</code> <kbd>mask</kbd>]</code> <code>[<kbd>flag</kbd> <kbd>...</kbd>]</code></dt>
-<dd><p>The
+for packets that overflow the rate-control window.
+<br><dt><code>restrict</code> <code>address</code> <code>[mask </code><kbd>mask</kbd><code>]</code> <code>[</code><kbd>flag</kbd> <kbd>...</kbd><code>]</code><dd>The
<kbd>address</kbd>
argument expressed in
-dotted-quad form is the address of a host or network.
+dotted-quad form is the address of a host or network.
Alternatively, the
<kbd>address</kbd>
-argument can be a valid host DNS name.
+argument can be a valid host DNS name.
The
<kbd>mask</kbd>
argument expressed in dotted-quad form defaults to
<code>255.255.255.255</code>,
meaning that the
<kbd>address</kbd>
-is treated as the address of an individual host.
+is treated as the address of an individual host.
A default entry (address
<code>0.0.0.0</code>,
mask
<code>0.0.0.0</code>)
-is always included and is always the first entry in the list.
+is always included and is always the first entry in the list.
Note that text string
<code>default</code>,
with no mask option, may
-be used to indicate the default entry.
+be used to indicate the default entry.
In the current implementation,
<code>flag</code>
always
restricts access, i.e., an entry with no flags indicates that free
-access to the server is to be given.
+access to the server is to be given.
The flags are not orthogonal,
in that more restrictive flags will often make less restrictive
-ones redundant.
+ones redundant.
The flags can generally be classed into two
categories, those which restrict time service and those which
restrict informational queries and attempts to do run-time
-reconfiguration of the server.
+reconfiguration of the server.
One or more of the following flags
may be specified:
-</p><dl compact="compact">
-<dt><code>ignore</code></dt>
-<dd><p>Deny packets of all kinds, including
+ <dl>
+<dt><code>ignore</code><dd>Deny packets of all kinds, including
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
-queries.
-</p></dd>
-<dt><code>kod</code></dt>
-<dd><p>If this flag is set when an access violation occurs, a kiss-o’-death
-(KoD) packet is sent.
+queries.
+<br><dt><code>kod</code><dd>If this flag is set when an access violation occurs, a kiss-o'-death
+(KoD) packet is sent.
KoD packets are rate limited to no more than one
-per second.
+per second.
If another KoD packet occurs within one second after the
-last one, the packet is dropped.
-</p></dd>
-<dt><code>limited</code></dt>
-<dd><p>Deny service if the packet spacing violates the lower limits specified
+last one, the packet is dropped.
+<br><dt><code>limited</code><dd>Deny service if the packet spacing violates the lower limits specified
in the
<code>discard</code>
-command.
+command.
A history of clients is kept using the
monitoring capability of
-<code>ntpd(1ntpdmdoc)</code>.
+<code>ntpd(1ntpdmdoc)</code>.
Thus, monitoring is always active as
long as there is a restriction entry with the
<code>limited</code>
-flag.
-</p></dd>
-<dt><code>lowpriotrap</code></dt>
-<dd><p>Declare traps set by matching hosts to be low priority.
+flag.
+<br><dt><code>lowpriotrap</code><dd>Declare traps set by matching hosts to be low priority.
The
number of traps a server can maintain is limited (the current limit
-is 3).
+is 3).
Traps are usually assigned on a first come, first served
-basis, with later trap requestors being denied service.
+basis, with later trap requestors being denied service.
This flag
modifies the assignment algorithm by allowing low priority traps to
-be overridden by later requests for normal priority traps.
-</p></dd>
-<dt><code>nomodify</code></dt>
-<dd><p>Deny
+be overridden by later requests for normal priority traps.
+<br><dt><code>nomodify</code><dd>Deny
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
queries which attempt to modify the state of the
-server (i.e., run time reconfiguration).
+server (i.e., run time reconfiguration).
Queries which return
-information are permitted.
-</p></dd>
-<dt><code>noquery</code></dt>
-<dd><p>Deny
+information are permitted.
+<br><dt><code>noquery</code><dd>Deny
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
-queries.
-Time service is not affected.
-</p></dd>
-<dt><code>nopeer</code></dt>
-<dd><p>Deny packets which would result in mobilizing a new association.
+queries.
+Time service is not affected.
+<br><dt><code>nopeer</code><dd>Deny packets which would result in mobilizing a new association.
This
includes broadcast and symmetric active packets when a configured
-association does not exist.
+association does not exist.
It also includes
<code>pool</code>
-associations, so if you want to use servers from a
+associations, so if you want to use servers from a
<code>pool</code>
directive and also want to use
<code>nopeer</code>
-by default, you’ll want a
+by default, you'll want a
<code>restrict source ...</code> <code>line</code> <code>as</code> <code>well</code> <code>that</code> <code>does</code>
-</p></dd>
-<dt>not</dt>
-<dd><p>include the
+<br><dt>not<dd>include the
<code>nopeer</code>
-directive.
-</p></dd>
-<dt><code>noserve</code></dt>
-<dd><p>Deny all packets except
+directive.
+<br><dt><code>noserve</code><dd>Deny all packets except
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
-queries.
-</p></dd>
-<dt><code>notrap</code></dt>
-<dd><p>Decline to provide mode 6 control message trap service to matching
-hosts.
+queries.
+<br><dt><code>notrap</code><dd>Decline to provide mode 6 control message trap service to matching
+hosts.
The trap service is a subsystem of the
<code>ntpq(1ntpqmdoc)</code>
control message
-protocol which is intended for use by remote event logging programs.
-</p></dd>
-<dt><code>notrust</code></dt>
-<dd><p>Deny service unless the packet is cryptographically authenticated.
-</p></dd>
-<dt><code>ntpport</code></dt>
-<dd><p>This is actually a match algorithm modifier, rather than a
-restriction flag.
+protocol which is intended for use by remote event logging programs.
+<br><dt><code>notrust</code><dd>Deny service unless the packet is cryptographically authenticated.
+<br><dt><code>ntpport</code><dd>This is actually a match algorithm modifier, rather than a
+restriction flag.
Its presence causes the restriction entry to be
matched only if the source port in the packet is the standard NTP
-UDP port (123).
+UDP port (123).
Both
<code>ntpport</code>
and
<code>non-ntpport</code>
may
-be specified.
+be specified.
The
<code>ntpport</code>
is considered more specific and
-is sorted later in the list.
-</p></dd>
-<dt><code>version</code></dt>
-<dd><p>Deny packets that do not match the current NTP version.
-</p></dd>
+is sorted later in the list.
+<br><dt><code>version</code><dd>Deny packets that do not match the current NTP version.
</dl>
-<p>Default restriction list entries with the flags ignore, interface,
-ntpport, for each of the local host’s interface addresses are
+
<p>Default restriction list entries with the flags ignore, interface,
+ntpport, for each of the local host's interface addresses are
inserted into the table at startup to prevent the server
-from attempting to synchronize to its own time.
+from attempting to synchronize to its own time.
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>
+NTP server is unrestricted).
</dl>
-<hr>
+<div class="node">
<a name="Automatic-NTP-Configuration-Options"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Automatic-NTP-Configuration-Options-1"></a>
-<h4 class="subsection">1.1.5 Automatic NTP Configuration Options</h4>
-<a name="Manycasting"></a>
-<h4 class="subsubsection">1.1.5.1 Manycasting</h4>
+
+<h4 class="subsection">Automatic NTP Configuration Options</h4>
+
+<h5 class="subsubsection">Manycasting</h5>
+
<p>Manycasting is a automatic discovery and configuration paradigm
-new to NTPv4.
+new to NTPv4.
It is intended as a means for a multicast client
to troll the nearby network neighborhood to find cooperating
manycast servers, validate them using cryptographic means
and evaluate their time values with respect to other servers
-that might be lurking in the vicinity.
+that might be lurking in the vicinity.
The intended result is that each manycast client mobilizes
-client associations with some number of the "best"
+client associations with some number of the "best"
of the nearby manycast servers, yet automatically reconfigures
to sustain this number of servers should one or another fail.
-</p>
-<p>Note that the manycasting paradigm does not coincide
+
+
<p>Note that the manycasting paradigm does not coincide
with the anycast paradigm described in RFC-1546,
which is designed to find a single server from a clique
-of servers providing the same service.
+of servers providing the same service.
The manycast paradigm is designed to find a plurality
of redundant servers satisfying defined optimality criteria.
-</p>
-<p>Manycasting can be used with either symmetric key
-or public key cryptography.
+
+
<p>Manycasting can be used with either symmetric key
+or public key cryptography.
The public key infrastructure (PKI)
offers the best protection against compromised keys
and is generally considered stronger, at least with relatively
-large key sizes.
+large key sizes.
It is implemented using the Autokey protocol and
the OpenSSL cryptographic library available from
-<code>http://www.openssl.org/</code>.
+<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
+
+
<p>A persistent manycast client association is configured
using the
<code>manycastclient</code>
command, which is similar to the
<code>D</code>
or IPv6 prefix
<code>FF</code>)
-group address.
+group address.
The IANA has designated IPv4 address 224.1.1.1
-and IPv6 address FF05::101 (site local) for NTP.
+and IPv6 address FF05::101 (site local) for NTP.
When more servers are needed, it broadcasts manycast
client messages to this address at the minimum feasible rate
and minimum feasible time-to-live (TTL) hops, depending
-on how many servers have already been found.
+on how many servers have already been found.
There can be as many manycast client associations
as different group address, each one serving as a template
for a future ephemeral unicast client/server association.
-</p>
-<p>Manycast servers configured with the
+
+
<p>Manycast servers configured with the
<code>manycastserver</code>
command listen on the specified group address for manycast
-client messages.
+client messages.
Note the distinction between manycast client,
which actively broadcasts messages, and manycast server,
-which passively responds to them.
+which passively responds to them.
If a manycast server is
in scope of the current TTL and is itself synchronized
to a valid source and operating at a stratum level equal
to or lower than the manycast client, it replies to the
manycast client message with an ordinary unicast server message.
-</p>
-<p>The manycast client receiving this message mobilizes
+
+
<p>The manycast client receiving this message mobilizes
an ephemeral client/server association according to the
matching manycast client template, but only if cryptographically
authenticated and the server stratum is less than or equal
-to the client stratum.
+to the client stratum.
Authentication is explicitly required
-and either symmetric key or public key (Autokey) can be used.
+and either symmetric key or public key (Autokey) can be used.
Then, the client polls the server at its unicast address
in burst mode in order to reliably set the host clock
-and validate the source.
+and validate the source.
This normally results
in a volley of eight client/server at 2-s intervals
during which both the synchronization and cryptographic
-protocols run concurrently.
+protocols run concurrently.
Following the volley,
the client runs the NTP intersection and clustering
-algorithms, which act to discard all but the "best"
+algorithms, which act to discard all but the "best"
associations according to stratum and synchronization
-distance.
+distance.
The surviving associations then continue
in ordinary client/server mode.
-</p>
-<p>The manycast client polling strategy is designed to reduce
+
+
<p>The manycast client polling strategy is designed to reduce
as much as possible the volume of manycast client messages
and the effects of implosion due to near-simultaneous
-arrival of manycast server messages.
+arrival of manycast server messages.
The strategy is determined by the
<code>manycastclient</code>,
<code>tos</code>
and
<code>ttl</code>
-configuration commands.
+configuration commands.
The manycast poll interval is
normally eight times the system poll interval,
which starts out at the
<code>manycastclient</code>,
command and, under normal circumstances, increments to the
<code>maxpolll</code>
-value specified in this command.
+value specified in this command.
Initially, the TTL is
set at the minimum hops specified by the
<code>ttl</code>
-command.
+command.
At each retransmission the TTL is increased until reaching
the maximum hops specified by this command or a sufficient
-number client associations have been found.
+number client associations have been found.
Further retransmissions use the same TTL.
-</p>
-<p>The quality and reliability of the suite of associations
+
+
<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>minsane</code>
values specified in the
<code>tos</code>
-configuration command.
+configuration command.
At least
<code>minsane</code>
candidate servers must be available and the mitigation
algorithms produce at least
<code>minclock</code>
-survivors in order to synchronize the clock.
+survivors in order to synchronize the clock.
Byzantine agreement principles require at least four
-candidates in order to correctly discard a single falseticker.
+candidates in order to correctly discard a single falseticker.
For legacy purposes,
<code>minsane</code>
defaults to 1 and
<code>minclock</code>
-defaults to 3.
+defaults to 3.
For manycast service
<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>
servers are found, the manycast poll interval is immediately
set to eight times
-<code>maxpoll</code>.
+<code>maxpoll</code>.
If less than
<code>minclock</code>
servers are found when the TTL has reached the maximum hops,
-the manycast poll interval is doubled.
+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>maxpoll</code>.
Further transmissions use the same poll interval and
-TTL values.
+TTL values.
Note that while all this is going on,
each client/server association found is operating normally
it the system poll interval.
-</p>
-<p>Administratively scoped multicast boundaries are normally
+
+
<p>Administratively scoped multicast boundaries are normally
specified by the network router configuration and,
-in the case of IPv6, the link/site scope prefix.
+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>
configuration command can be
used to modify the values to match the scope rules.
-</p>
-<p>It is often useful to narrow the range of acceptable
-servers which can be found by manycast client associations.
+
+
<p>It is often useful to narrow the range of acceptable
+servers which can be found by manycast client associations.
Because manycast servers respond only when the client
stratum is equal to or greater than the server stratum,
primary (stratum 1) servers fill find only primary servers
-in TTL range, which is probably the most common objective.
+in TTL range, which is probably the most common objective.
However, unless configured otherwise, all manycast clients
in TTL range will eventually find all primary servers
in TTL range, which is probably not the most common
-objective in large networks.
+objective in large networks.
The
<code>tos</code>
-command can be used to modify this behavior.
+command can be used to modify this behavior.
Servers with stratum below
<code>floor</code>
or above
accepted if the number of servers within TTL range is
less than
<code>minclock</code>.
-</p>
-<p>The above actions occur for each manycast client message,
-which repeats at the designated poll interval.
+
+
<p>The above actions occur for each manycast client message,
+which repeats at the designated poll interval.
However, once the ephemeral client association is mobilized,
subsequent manycast server replies are discarded,
-since that would result in a duplicate association.
+since that would result in a duplicate association.
If during a poll interval the number of client associations
falls below
<code>minclock</code>,
all manycast client prototype associations are reset
to the initial poll interval and TTL hops and operation
-resumes from the beginning.
+resumes from the beginning.
It is important to avoid
frequent manycast client messages, since each one requires
-all manycast servers in TTL range to respond.
+all manycast servers in TTL range to respond.
The result could well be an implosion, either minor or major,
-depending on the number of servers in range.
+depending on the number of servers in range.
The recommended value for
<code>maxpoll</code>
is 12 (4,096 s).
-</p>
-<p>It is possible and frequently useful to configure a host
-as both manycast client and manycast server.
+
+
<p>It is possible and frequently useful to configure a host
+as both manycast client and manycast server.
A number of hosts configured this way and sharing a common
group address will automatically organize themselves
in an optimum configuration based on stratum and
-synchronization distance.
+synchronization distance.
For example, consider an NTP
subnet of two primary servers and a hundred or more
-dependent clients.
+dependent clients.
With two exceptions, all servers
and clients have identical configuration files including both
<code>multicastclient</code>
and
<code>multicastserver</code>
commands using, for instance, multicast group address
-239.1.1.1.
+239.1.1.1.
The only exception is that each primary server
configuration file must include commands for the primary
reference source such as a GPS receiver.
-</p>
-<p>The remaining configuration files for all secondary
+
+
<p>The remaining configuration files for all secondary
servers and clients have the same contents, except for the
<code>tos</code>
-command, which is specific for each stratum level.
+command, which is specific for each stratum level.
For stratum 1 and stratum 2 servers, that command is
-not necessary.
+not necessary.
For stratum 3 and above servers the
<code>floor</code>
-value is set to the intended stratum number.
+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.
-</p>
-<p>Once operations have stabilized in this scenario,
+
+
<p>Once operations have stabilized in this scenario,
the primary servers will find the primary reference source
and each other, since they both operate at the same
stratum (1), but not with any secondary server or client,
-since these operate at a higher stratum.
+since these operate at a higher stratum.
The secondary
-servers will find the servers at the same stratum level.
+servers will find the servers at the same stratum level.
If one of the primary servers loses its GPS receiver,
it will continue to operate as a client and other clients
will time out the corresponding association and
re-associate accordingly.
-</p>
-<p>Some administrators prefer to avoid running
+
+
<p>Some administrators prefer to avoid running
<code>ntpd(1ntpdmdoc)</code>
continuously and run either
<code>sntp(1sntpmdoc)</code>
or
<code>ntpd(1ntpdmdoc)</code>
<code>-q</code>
-as a cron job.
+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.
+available when the cron job runs.
A really slick
application of manycast is with
<code>ntpd(1ntpdmdoc)</code>
-<code>-q</code>.
+<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.
+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><a name="Manycast-Interactions-with-Autokey"></a>
-<h4 class="subsubsection">1.1.5.2 Manycast Interactions with Autokey</h4>
+
+<h5 class="subsubsection">Manycast Interactions with Autokey</h5>
+
<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
-and status word.
+and status word.
The manycast clients then run
the Autokey protocol, which collects and verifies
-all certificates involved.
+all certificates involved.
Following the burst interval
all but three survivors are cast off,
-but the certificates remain in the local cache.
+but the certificates remain in the local cache.
It often happens that several complete signing trails
from the client to the primary servers are collected in this way.
-</p>
-<p>About once an hour or less often if the poll interval
-exceeds this, the client regenerates the Autokey key list.
-This is in general transparent in client/server mode.
+
+
<p>About once an hour or less often if the poll interval
+exceeds this, the client regenerates the Autokey key list.
+This is in general transparent in client/server mode.
However, about once per day the server private value
used to generate cookies is refreshed along with all
-manycast client associations.
+manycast client associations.
In this case all
-cryptographic values including certificates is refreshed.
+cryptographic values including certificates is refreshed.
If a new certificate has been generated since
the last refresh epoch, it will automatically revoke
all prior certificates that happen to be in the
-certificate cache.
+certificate cache.
At the same time, the manycast
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><a name="Broadcast-Options"></a>
-<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>
-<dd><p>This command provides a way to delay,
+
+<h5 class="subsubsection">Broadcast Options</h5>
+
+ <dl>
+<dt><code>tos</code> <code>[bcpollbstep </code><kbd>gate</kbd><code>]</code><dd>This command provides a way to delay,
by the specified number of broadcast poll intervals,
-believing backward time steps from a broadcast server.
-Broadcast time networks are expected to be trusted.
-In the event a broadcast server’s time is stepped backwards,
+believing backward time steps from a broadcast server.
+Broadcast time networks are expected to be trusted.
+In the event a broadcast server's time is stepped backwards,
there is clear benefit to having the clients notice this change
-as soon as possible.
+as soon as possible.
Attacks such as replay attacks can happen, however,
and even though there are a number of protections built in to
-broadcast mode, attempts to perform a replay attack are possible.
+broadcast mode, attempts to perform a replay attack are possible.
This value defaults to 0, but can be changed
to any number of poll intervals between 0 and 4.
-</p></dd>
-</dl>
-<a name="Manycast-Options"></a>
-<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>
-<dd><p>This command affects the clock selection and clustering
-algorithms.
+
+<h5 class="subsubsection">Manycast Options</h5>
+
+ <dl>
+<dt><code>tos</code> <code>[ceiling </code><kbd>ceiling</kbd><code> | cohort { 0 | 1 } | floor </code><kbd>floor</kbd><code> | minclock </code><kbd>minclock</kbd><code> | minsane </code><kbd>minsane</kbd><code>]</code><dd>This command affects the clock selection and clustering
+algorithms.
It can be used to select the quality and
quantity of peers used to synchronize the system clock
-and is most useful in manycast mode.
+and is most useful in manycast mode.
The variables operate
as follows:
-</p><dl compact="compact">
-<dt><code>ceiling</code> <kbd>ceiling</kbd></dt>
-<dd><p>Peers with strata above
+ <dl>
+<dt><code>ceiling</code> <kbd>ceiling</kbd><dd>Peers with strata above
<code>ceiling</code>
will be discarded if there are at least
<code>minclock</code>
-peers remaining.
+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>
-<dd><p>This is a binary flag which enables (0) or disables (1)
+to any number from 1 to 15.
+<br><dt><code>cohort</code> <code>{0 | 1}</code><dd>This is a binary flag which enables (0) or disables (1)
manycast server replies to manycast clients with the same
-stratum level.
+stratum level.
This is useful to reduce implosions where
large numbers of 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>
-<dd><p>Peers with strata below
+are present.
+The default is to enable these replies.
+<br><dt><code>floor</code> <kbd>floor</kbd><dd>Peers with strata below
<code>floor</code>
will be discarded if there are at least
<code>minclock</code>
-peers remaining.
+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>
-<dd><p>The clustering algorithm repeatedly casts out outlier
+to any number from 1 to 15.
+<br><dt><code>minclock</code> <kbd>minclock</kbd><dd>The clustering algorithm repeatedly casts out outlier
associations until no more than
<code>minclock</code>
-associations remain.
+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>
-<dd><p>This is the minimum number of candidates available
+configured sources.
+<br><dt><code>minsane</code> <kbd>minsane</kbd><dd>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.
+one or more truechimers for the clustering algorithm.
If fewer than this number are available, the clock is
-undisciplined and allowed to run free.
+undisciplined and allowed to run free.
The default is 1
-for legacy purposes.
+for legacy purposes.
However, according to principles of
Byzantine agreement,
<code>minsane</code>
should be at least 4 in order to detect and discard
-a single falseticker.
-</p></dd>
+a single falseticker.
</dl>
-</dd>
-<dt><code>ttl</code> <kbd>hop</kbd> <kbd>...</kbd></dt>
-<dd><p>This command specifies a list of TTL values in increasing
-order, up to 8 values can be specified.
+ <br><dt><code>ttl</code> <kbd>hop</kbd> <kbd>...</kbd><dd>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 an expanding-ring search.
+in an expanding-ring search.
The default is eight
-multiples of 32 starting at 31.
-</p></dd>
+multiples of 32 starting at 31.
</dl>
-<hr>
+ <div class="node">
<a name="Reference-Clock-Support"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Reference-Clock-Support-1"></a>
-<h4 class="subsection">1.1.6 Reference Clock Support</h4>
-<p>The NTP Version 4 daemon supports some three dozen different radio,
+
+<h4 class="subsection">Reference Clock Support</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.
+used for backup or when no other clock source is available.
Detailed descriptions of individual device drivers and options can
be found in the
-"Reference Clock Drivers"
+"Reference Clock Drivers"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
Additional information can be found in the pages linked
there, including the
-"Debugging Hints for Reference Clock Drivers"
+"Debugging Hints for Reference Clock Drivers"
and
-"How To Write a Reference Clock Driver"
+"How To Write a Reference Clock Driver"
pages
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
In addition, support for a PPS
signal is available as described in the
-"Pulse-per-second (PPS) Signal Interfacing"
+"Pulse-per-second (PPS) Signal Interfacing"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
Many
drivers support special line discipline/streams modules which can
-significantly improve the accuracy using the driver.
+significantly improve the accuracy using the driver.
These are
described in the
-"Line Disciplines and Streams Drivers"
+"Line Disciplines and Streams Drivers"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
-</p>
-<p>A reference clock will generally (though not always) be a radio
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
+
+
<p>A reference clock will generally (though not always) be a radio
timecode receiver which is synchronized to a source of standard
time such as the services offered by the NRC in Canada and NIST and
-USNO in the US.
+USNO in the US.
The interface between the computer and the timecode
-receiver is device dependent, but is usually a serial port.
+receiver is device dependent, but is usually a serial port.
A
device driver specific to each reference clock must be selected and
compiled in the distribution; however, most common radio, satellite
-and modem clocks are included by default.
+and modem clocks are included by default.
Note that an attempt to
configure a reference clock when the driver has not been compiled
or the hardware port has not been appropriately configured results
in a scalding remark to the system log file, but is otherwise non
hazardous.
-</p>
-<p>For the purposes of configuration,
+
+
<p>For the purposes of configuration,
<code>ntpd(1ntpdmdoc)</code>
treats
reference clocks in a manner analogous to normal NTP peers as much
-as possible.
+as possible.
Reference clocks are identified by a syntactically
correct but invalid IP address, in order to distinguish them from
-normal NTP peers.
+normal NTP peers.
Reference clock addresses are of the form
<code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd>,
where
denoting the clock type and
<kbd>u</kbd>
indicates the unit
-number in the range 0-3.
+number in the range 0-3.
While it may seem overkill, it is in fact
sometimes useful to configure multiple reference clocks of the same
type, in which case the unit numbers must be unique.
-</p>
-<p>The
+
<code>server</code>
command is used to configure a reference
clock, where the
<kbd>address</kbd>
argument in that command
-is the clock address.
+is the clock address.
The
<code>key</code>,
<code>version</code>
and
<code>ttl</code>
-options are not used for reference clock support.
+options are not used for reference clock support.
The
<code>mode</code>
option is added for reference clock support, as
-described below.
+described below.
The
<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.
+enthusiasm than other reference clocks or peers.
Further
information on this option can be found in the
-"Mitigation Rules and the prefer Keyword"
+"Mitigation Rules and the prefer Keyword"
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
-page.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>)
+page.
The
<code>minpoll</code>
and
<code>maxpoll</code>
options have
-meaning only for selected clock drivers.
+meaning only for selected clock drivers.
See the individual clock
driver document pages for additional information.
-</p>
-<p>The
+
<code>fudge</code>
command is used to provide additional
information for individual clock drivers and normally follows
immediately after the
<code>server</code>
-command.
+command.
The
<kbd>address</kbd>
-argument specifies the clock address.
+argument specifies the clock address.
The
<code>refid</code>
and
<code>stratum</code>
options can be used to
-override the defaults for the device.
+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>
command as well.
-</p>
-<p>The stratum number of a reference clock is by default zero.
+
+ <p>The stratum number of a reference clock is by default zero.
Since the
<code>ntpd(1ntpdmdoc)</code>
daemon adds one to the stratum of each
peer, a primary server ordinarily displays an external stratum of
-one.
+one.
In order to provide engineered backups, it is often useful to
-specify the reference clock stratum as greater than zero.
+specify the reference clock stratum as greater than zero.
The
<code>stratum</code>
-option is used for this purpose.
+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.
+identifier as other than the default, depending on the driver.
The
<code>refid</code>
-option is used for this purpose.
+option is used for this purpose.
Except where noted,
these options apply to all clock drivers.
-</p><a name="Reference-Clock-Commands"></a>
-<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>
-<dd><p>This command can be used to configure reference clocks in
-special ways.
+
+<h5 class="subsubsection">Reference Clock Commands</h5>
+
+ <dl>
+<dt><code>server</code> <code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd> <code>[prefer]</code> <code>[mode </code><kbd>int</kbd><code>]</code> <code>[minpoll </code><kbd>int</kbd><code>]</code> <code>[maxpoll </code><kbd>int</kbd><code>]</code><dd>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>
-<dd><p>Marks the reference clock as preferred.
+ <dl>
+<dt><code>prefer</code><dd>Marks the reference clock as preferred.
All other things being
equal, this host will be chosen for synchronization among a set of
-correctly operating hosts.
+correctly operating hosts.
See the
-"Mitigation Rules and the prefer Keyword"
+"Mitigation Rules and the prefer Keyword"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>)
-for further information.
-</p></dd>
-<dt><code>mode</code> <kbd>int</kbd></dt>
-<dd><p>Specifies a mode number which is interpreted in a
-device-specific fashion.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>)
+for further information.
+<br><dt><code>mode</code> <kbd>int</kbd><dd>Specifies a mode number which is interpreted in a
+device-specific fashion.
For instance, it selects a dialing
protocol in the ACTS driver and a device subtype in the
parse
-drivers.
-</p></dd>
-<dt><code>minpoll</code> <kbd>int</kbd></dt>
-<dt><code>maxpoll</code> <kbd>int</kbd></dt>
-<dd><p>These options specify the minimum and maximum polling interval
+drivers.
+<br><dt><code>minpoll</code> <kbd>int</kbd><br><dt><code>maxpoll</code> <kbd>int</kbd><dd>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>
and
<code>maxpoll</code>
-default to 6 (64 s).
+default to 6 (64 s).
For modem reference clocks,
<code>minpoll</code>
defaults to 10 (17.1 m) and
<code>maxpoll</code>
-defaults to 14 (4.5 h).
-The allowable range is 4 (16 s) to 17 (36.4 h) inclusive.
-</p></dd>
+defaults to 14 (4.5 h).
+The allowable range is 4 (16 s) to 17 (36.4 h) inclusive.
</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>
-<dd><p>This command can be used to configure reference clocks in
-special ways.
+ <br><dt><code>fudge</code> <code>127.127.</code><kbd>t</kbd>.<kbd>u</kbd> <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 0 | 1]</code> <code>[flag2 0 | 1]</code> <code>[flag3 0 | 1]</code> <code>[flag4 0 | 1]</code><dd>This command can be used to configure reference clocks in
+special ways.
It must immediately follow the
<code>server</code>
-command which configures the driver.
+command which configures the driver.
Note that the same capability
is possible at run time using the
<code>ntpdc(1ntpdcmdoc)</code>
-program.
+program.
The options are interpreted as
follows:
-</p><dl compact="compact">
-<dt><code>time1</code> <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.
+ <dl>
+<dt><code>time1</code> <kbd>sec</kbd><dd>Specifies a constant to be added to the time offset produced by
+the driver, a fixed-point decimal number in seconds.
This is used
as a calibration constant to adjust the nominal time offset of a
particular clock to agree with an external standard, such as a
-precision PPS signal.
+precision PPS signal.
It also provides a way to correct a
systematic error or bias due to serial port or operating system
-latencies, different cable lengths or receiver internal delay.
+latencies, different cable lengths or receiver internal delay.
The
specified offset is in addition to the propagation delay provided
-by other means, such as internal DIPswitches.
+by other means, such as internal DIPswitches.
Where a calibration
for an individual system and driver is available, an approximate
-correction is noted in the driver documentation pages.
+correction is noted in the driver documentation pages.
Note: in order to facilitate calibration when more than one
radio clock or PPS signal is supported, a special calibration
-feature is available.
+feature is available.
It takes the form of an argument to the
<code>enable</code>
command described in
<a href="#Miscellaneous-Options">Miscellaneous Options</a>
page and operates as described in the
-"Reference Clock Drivers"
+"Reference Clock Drivers"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
-</p></dd>
-<dt><code>time2</code> <kbd>secs</kbd></dt>
-<dd><p>Specifies a fixed-point decimal number in seconds, which is
-interpreted in a driver-dependent way.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
+<br><dt><code>time2</code> <kbd>secs</kbd><dd>Specifies a fixed-point decimal number in seconds, which is
+interpreted in a driver-dependent way.
See the descriptions of
specific drivers in the
-"Reference Clock Drivers"
+"Reference Clock Drivers"
page
(available as part of the HTML documentation
provided in
-<samp>/usr/share/doc/ntp</samp>).
-</p></dd>
-<dt><code>stratum</code> <kbd>int</kbd></dt>
-<dd><p>Specifies the stratum number assigned to the driver, an integer
-between 0 and 15.
+<samp><span class="file">/usr/share/doc/ntp</span></samp>).
+<br><dt><code>stratum</code> <kbd>int</kbd><dd>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>
-<dd><p>Specifies an ASCII string of from one to four characters which
-defines the reference identifier used by the driver.
+ordinarily assigned by the driver itself, usually zero.
+<br><dt><code>refid</code> <kbd>string</kbd><dd>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>
-<dd><p>Specifies a mode number which is interpreted in a
-device-specific fashion.
+itself.
+<br><dt><code>mode</code> <kbd>int</kbd><dd>Specifies a mode number which is interpreted in a
+device-specific fashion.
For instance, it selects a dialing
protocol in the ACTS driver and a device subtype in the
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>
-<dd><p>These four flags are used for customizing the clock driver.
+drivers.
+<br><dt><code>flag1</code> <code>0</code> <code>|</code> <code>1</code><br><dt><code>flag2</code> <code>0</code> <code>|</code> <code>1</code><br><dt><code>flag3</code> <code>0</code> <code>|</code> <code>1</code><br><dt><code>flag4</code> <code>0</code> <code>|</code> <code>1</code><dd>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.
+is a function of the particular clock driver.
However, by
convention
<code>flag4</code>
<code>clockstats</code>
file configured with the
<code>filegen</code>
-command.
+command.
Further information on the
<code>filegen</code>
command can be found in
-‘Monitoring Options’.
-</p></dd>
-</dl>
-</dd>
+<a href="#Monitoring-Options">Monitoring Options</a>.
</dl>
-<hr>
+ </dl>
+ <div class="node">
<a name="Miscellaneous-Options"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Miscellaneous-Options-1"></a>
-<h4 class="subsection">1.1.7 Miscellaneous Options</h4>
-<dl compact="compact">
-<dt><code>broadcastdelay</code> <kbd>seconds</kbd></dt>
-<dd><p>The broadcast and multicast modes require a special calibration
+
+<h4 class="subsection">Miscellaneous Options</h4>
+
+ <dl>
+<dt><code>broadcastdelay</code> <kbd>seconds</kbd><dd>The broadcast and multicast modes require a special calibration
to determine the network delay between the local and remote
-servers.
+servers.
Ordinarily, this is done automatically by the initial
-protocol exchanges between the client and server.
+protocol exchanges between the client and server.
In some cases,
the calibration procedure may fail due to network or server access
-controls, for example.
+controls, for example.
This command specifies the default delay to
-be used under these circumstances.
+be used under these circumstances.
Typically (for Ethernet), a
-number between 0.003 and 0.007 seconds is appropriate.
+number between 0.003 and 0.007 seconds is appropriate.
The default
-when this command is not used is 0.004 seconds.
-</p></dd>
-<dt><code>calldelay</code> <kbd>delay</kbd></dt>
-<dd><p>This option controls the delay in seconds between the first and second
+when this command is not used is 0.004 seconds.
+<br><dt><code>calldelay</code> <kbd>delay</kbd><dd>This option controls the delay in seconds between the first and second
packets sent in burst or iburst mode to allow additional time for a modem
-or ISDN call to complete.
-</p></dd>
-<dt><code>driftfile</code> <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.
+or ISDN call to complete.
+<br><dt><code>driftfile</code> <kbd>driftfile</kbd><dd>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>
-command line option.
+command line option.
If the file exists, it is read at
startup in order to set the initial frequency and then updated once per
-hour with the current frequency computed by the daemon.
+hour with the current frequency computed by the daemon.
If the file name is
specified, but the file itself does not exist, the starts with an initial
-frequency of zero and creates the file when writing it for the first time.
+frequency of zero and creates the file when writing it for the first time.
If this command is not given, the daemon will always start with an initial
frequency of zero.
-</p>
-<p>The file format consists of a single line containing a single
+
+
<p>The file format consists of a single line containing a single
floating point number, which records the frequency offset measured
-in parts-per-million (PPM).
+in parts-per-million (PPM).
The file is updated by first writing
the current drift value into a temporary file and then renaming
-this file to replace the old version.
+this file to replace the old version.
This implies that
<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>
-<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>
-<dd><p>Provides a way to enable or disable various server options.
-Flags not mentioned are unaffected.
+otherwise, should be avoided.
+<br><dt><code>dscp</code> <kbd>value</kbd><dd>This option specifies the Differentiated Services Control Point (DSCP) value,
+a 6-bit code.
+The default value is 46, signifying Expedited Forwarding.
+<br><dt><code>enable</code> <code>[auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats | peer_clear_digest_early | unpeer_crypto_early | unpeer_crypto_nak_early | unpeer_digest_early]</code><br><dt><code>disable</code> <code>[auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats | peer_clear_digest_early | unpeer_crypto_early | unpeer_crypto_nak_early | unpeer_digest_early]</code><dd>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>
utility program.
-</p><dl compact="compact">
-<dt><code>auth</code></dt>
-<dd><p>Enables the server to synchronize with unconfigured peers only if the
+ <dl>
+<dt><code>auth</code><dd>Enables the server to synchronize with unconfigured peers only if the
peer has been correctly authenticated using either public key or
-private key cryptography.
+private key cryptography.
The default for this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>bclient</code></dt>
-<dd><p>Enables the server to listen for a message from a broadcast or
+<code>enable</code>.
+<br><dt><code>bclient</code><dd>Enables the server to listen for a message from a broadcast or
multicast server, as in the
<code>multicastclient</code>
command with default
-address.
+address.
The default for this flag is
-<code>disable</code>.
-</p></dd>
-<dt><code>calibrate</code></dt>
-<dd><p>Enables the calibrate feature for reference clocks.
+<code>disable</code>.
+<br><dt><code>calibrate</code><dd>Enables the calibrate feature for reference clocks.
The default for
this flag is
-<code>disable</code>.
-</p></dd>
-<dt><code>kernel</code></dt>
-<dd><p>Enables the kernel time discipline, if available.
+<code>disable</code>.
+<br><dt><code>kernel</code><dd>Enables the kernel time discipline, if available.
The default for this
flag is
<code>enable</code>
if support is available, otherwise
-<code>disable</code>.
-</p></dd>
-<dt><code>mode7</code></dt>
-<dd><p>Enables processing of NTP mode 7 implementation-specific requests
+<code>disable</code>.
+<br><dt><code>mode7</code><dd>Enables processing of NTP mode 7 implementation-specific requests
which are used by the deprecated
<code>ntpdc(1ntpdcmdoc)</code>
-program.
-The default for this flag is disable.
+program.
+The default for this flag is disable.
This flag is excluded from runtime configuration using
-<code>ntpq(1ntpqmdoc)</code>.
+<code>ntpq(1ntpqmdoc)</code>.
The
<code>ntpq(1ntpqmdoc)</code>
program provides the same capabilities as
<code>ntpdc(1ntpdcmdoc)</code>
-using standard mode 6 requests.
-</p></dd>
-<dt><code>monitor</code></dt>
-<dd><p>Enables the monitoring facility.
+using standard mode 6 requests.
+<br><dt><code>monitor</code><dd>Enables the monitoring facility.
See the
<code>ntpdc(1ntpdcmdoc)</code>
program
and the
<code>monlist</code>
-command or further information.
+command or further information.
The
default for this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>ntp</code></dt>
-<dd><p>Enables time and frequency discipline.
+<code>enable</code>.
+<br><dt><code>ntp</code><dd>Enables time and frequency discipline.
In effect, this switch opens and
-closes the feedback loop, which is useful for testing.
+closes the feedback loop, which is useful for testing.
The default for
this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>peer_clear_digest_early</code></dt>
-<dd><p>By default, if
+<code>enable</code>.
+<br><dt><code>peer_clear_digest_early</code><dd>By default, if
<code>ntpd(1ntpdmdoc)</code>
is using autokey and it
receives a crypto-NAK packet that
passes the duplicate packet and origin timestamp checks
-the peer variables are immediately cleared.
+the peer variables are immediately cleared.
While this is generally a feature
as it allows for quick recovery if a server key has changed,
a properly forged and appropriately delivered crypto-NAK packet
-can be used in a DoS attack.
+can be used in a DoS attack.
If you have active noticable problems with this type of DoS attack
then you should consider
-disabling this option.
+disabling this option.
You can check your
<code>peerstats</code>
-file for evidence of any of these attacks.
+file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>stats</code></dt>
-<dd><p>Enables the statistics facility.
+<code>enable</code>.
+<br><dt><code>stats</code><dd>Enables the statistics facility.
See the
-‘Monitoring Options’
-section for further information.
+<a href="#Monitoring-Options">Monitoring Options</a>
+section for further information.
The default for this flag is
-<code>disable</code>.
-</p></dd>
-<dt><code>unpeer_crypto_early</code></dt>
-<dd><p>By default, if
+<code>disable</code>.
+<br><dt><code>unpeer_crypto_early</code><dd>By default, if
<code>ntpd(1ntpdmdoc)</code>
receives an autokey packet that fails TEST9,
a crypto failure,
-the association is immediately cleared.
+the association is immediately cleared.
This is almost certainly a feature,
but if, in spite of the current recommendation of not using autokey,
you are
you are seeing this sort of DoS attack
disabling this flag will delay
tearing down the association until the reachability counter
-becomes zero.
+becomes zero.
You can check your
<code>peerstats</code>
-file for evidence of any of these attacks.
+file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>unpeer_crypto_nak_early</code></dt>
-<dd><p>By default, if
+<code>enable</code>.
+<br><dt><code>unpeer_crypto_nak_early</code><dd>By default, if
<code>ntpd(1ntpdmdoc)</code>
receives a crypto-NAK packet that
passes the duplicate packet and origin timestamp checks
-the association is immediately cleared.
+the association is immediately cleared.
While this is generally a feature
as it allows for quick recovery if a server key has changed,
a properly forged and appropriately delivered crypto-NAK packet
-can be used in a DoS attack.
+can be used in a DoS attack.
If you have active noticable problems with this type of DoS attack
then you should consider
-disabling this option.
+disabling this option.
You can check your
<code>peerstats</code>
-file for evidence of any of these attacks.
+file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
-</p></dd>
-<dt><code>unpeer_digest_early</code></dt>
-<dd><p>By default, if
+<code>enable</code>.
+<br><dt><code>unpeer_digest_early</code><dd>By default, if
<code>ntpd(1ntpdmdoc)</code>
receives what should be an authenticated packet
that passes other packet sanity checks but
contains an invalid digest
-the association is immediately cleared.
+the association is immediately cleared.
While this is generally a feature
as it allows for quick recovery,
if this type of packet is carefully forged and sent
-during an appropriate window it can be used for a DoS attack.
+during an appropriate window it can be used for a DoS attack.
If you have active noticable problems with this type of DoS attack
then you should consider
-disabling this option.
+disabling this option.
You can check your
<code>peerstats</code>
-file for evidence of any of these attacks.
+file for evidence of any of these attacks.
The
default for this flag is
-<code>enable</code>.
-</p></dd>
+<code>enable</code>.
</dl>
-</dd>
-<dt><code>includefile</code> <kbd>includefile</kbd></dt>
-<dd><p>This command allows additional configuration commands
-to be included from a separate file.
+ <br><dt><code>includefile</code> <kbd>includefile</kbd><dd>This command allows additional configuration commands
+to be included from a separate file.
Include files may
be nested to a depth of five; upon reaching the end of any
include file, command processing resumes in the previous
-configuration file.
+configuration file.
This option is useful for sites that run
<code>ntpd(1ntpdmdoc)</code>
on multiple hosts, with (mostly) common options (e.g., a
-restriction list).
-</p></dd>
-<dt><code>leapsmearinterval</code> <kbd>seconds</kbd></dt>
-<dd><p>This EXPERIMENTAL option is only available if
+restriction list).
+<br><dt><code>leapsmearinterval</code> <kbd>seconds</kbd><dd>This EXPERIMENTAL option is only available if
<code>ntpd(1ntpdmdoc)</code>
was built with the
<code>--enable-leap-smear</code>
option to the
<code>configure</code>
-script.
-It specifies the interval over which a leap second correction will be applied.
+script.
+It specifies the interval over which a leap second correction will be applied.
Recommended values for this option are between
-7200 (2 hours) and 86400 (24 hours).
-.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>
-<dd><p>This command controls the amount and type of output written to
+7200 (2 hours) and 86400 (24 hours).
+.Sy DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS!
+See http://bugs.ntp.org/2855 for more information.
+<br><dt><code>logconfig</code> <kbd>configkeyword</kbd><dd>This command controls the amount and type of output written to
the system
<code>syslog(3)</code>
facility or the alternate
<code>logfile</code>
-log file.
-By default, all output is turned on.
+log file.
+By default, all output is turned on.
All
<kbd>configkeyword</kbd>
keywords can be prefixed with
adds and
‘-’
removes
-messages.
+messages.
<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>clock</code>, <code>peer</code>, <code>sys</code> and <code>sync</code>).
Within these classes four types of messages can be
controlled: informational messages
(<code>info</code>),
and
status messages
(<code>status</code>).
-</p>
-<p>Configuration keywords are formed by concatenating the message class with
-the event class.
+
+
<p>Configuration keywords are formed by concatenating the message class with
+the event class.
The
<code>all</code>
-prefix can be used instead of a message class.
+prefix can be used instead of a message class.
A
message class may also be followed by the
<code>all</code>
keyword to enable/disable all
-messages of the respective message class.
+messages of the respective message class.
Thus, a minimal log configuration
could look like this:
-</p><pre class="verbatim">logconfig =syncstatus +sysevents
-</pre>
-<p>This would just list the synchronizations state of
+<pre class="verbatim"> logconfig =syncstatus +sysevents
+ </pre>
+
+ <p>This would just list the synchronizations state of
<code>ntpd(1ntpdmdoc)</code>
-and the major system events.
+and the major system events.
For a simple reference server, the
following minimum message configuration could be useful:
-</p><pre class="verbatim">logconfig =syncall +clockall
-</pre>
-<p>This configuration will list all clock information and
-synchronization information.
+<pre class="verbatim"> logconfig =syncall +clockall
+ </pre>
+
+ <p>This configuration will list all clock information and
+synchronization information.
All other events and messages about
-peers, system events and so on is suppressed.
-</p></dd>
-<dt><code>logfile</code> <kbd>logfile</kbd></dt>
-<dd><p>This command specifies the location of an alternate log file to
+peers, system events and so on is suppressed.
+<br><dt><code>logfile</code> <kbd>logfile</kbd><dd>This command specifies the location of an alternate log file to
be used instead of the default system
<code>syslog(3)</code>
-facility.
+facility.
This is the same operation as the
<code>-l</code>
-command line option.
-</p></dd>
-<dt><code>setvar</code> <kbd>variable</kbd> <code>[<code>default</code>]</code></dt>
-<dd><p>This command adds an additional system variable.
+command line option.
+<br><dt><code>setvar</code> <kbd>variable</kbd> <code>[default]</code><dd>This command adds an additional system variable.
These
variables can be used to distribute additional information such as
-the access policy.
+the access policy.
If the variable of the form
<code>name</code><code>=</code><kbd>value</kbd>
is followed by the
<code>default</code>
keyword, the
variable will be listed as part of the default system variables
-(<code>rv</code> command)).
+(<code>rv</code> command)).
These additional variables serve
-informational purposes only.
+informational purposes only.
They are not related to the protocol
-other that they can be listed.
+other that they can be listed.
The known protocol variables will
always override any variables defined via the
<code>setvar</code>
-mechanism.
+mechanism.
There are three special variables that contain the names
-of all variable of the same group.
+of all variable of the same group.
The
<code>sys_var_list</code>
holds
-the names of all system variables.
+the names of all system variables.
The
<code>peer_var_list</code>
holds
the names of all peer variables and the
<code>clock_var_list</code>
-holds the names of the reference clock variables.
-</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>
-<dd><p>This command can be used to alter several system variables in
-very exceptional circumstances.
+holds the names of the reference clock variables.
+<br><dt><code>tinker</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>]</code><dd>This command can be used to alter several system variables in
+very exceptional circumstances.
It should occur in the
-configuration file before any other configuration options.
+configuration file before any other configuration options.
The
default values of these variables have been carefully optimized for
-a wide range of network speeds and reliability expectations.
+a wide range of network speeds and reliability expectations.
In
general, they interact in intricate ways that are hard to predict
-and some combinations can result in some very nasty behavior.
+and some combinations can result in some very nasty behavior.
Very
rarely is it necessary to change the default values; but, some
folks cannot resist twisting the knobs anyway and this command is
-for them.
+for them.
Emphasis added: twisters are on their own and can expect
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>
-<dd><p>The argument becomes the new value for the minimum Allan
+
+ <p>The variables operate as follows:
+ <dl>
+<dt><code>allan</code> <kbd>allan</kbd><dd>The argument becomes the new value for the minimum Allan
intercept, which is a parameter of the PLL/FLL clock discipline
-algorithm.
+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>
-<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>
-<dd><p>The argument becomes the initial value of the frequency offset in
-parts-per-million.
+limit.
+<br><dt><code>dispersion</code> <kbd>dispersion</kbd><dd>The argument becomes the new value for the dispersion increase rate,
+normally .000015 s/s.
+<br><dt><code>freq</code> <kbd>freq</kbd><dd>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>
-<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.
+present, and avoids the initial training state if it is not.
+<br><dt><code>huffpuff</code> <kbd>huffpuff</kbd><dd>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.
The lower limit is
-900 s (15 m), but a more reasonable value is 7200 (2 hours).
+900 s (15 m), but a more reasonable value is 7200 (2 hours).
There
is no default, since the filter is not enabled unless this command
-is given.
-</p></dd>
-<dt><code>panic</code> <kbd>panic</kbd></dt>
-<dd><p>The argument is the panic threshold, normally 1000 s.
+is given.
+<br><dt><code>panic</code> <kbd>panic</kbd><dd>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>
-<dd><p>The argument is the step threshold, which by default is 0.128 s.
+be accepted.
+<br><dt><code>step</code> <kbd>step</kbd><dd>The argument is the step threshold, which by default is 0.128 s.
It can
-be set to any positive number in seconds.
+be set to any positive number in seconds.
If set to zero, step
-adjustments will never occur.
+adjustments will never occur.
Note: The kernel time discipline is
disabled if the step threshold is set to zero or greater than the
-default.
-</p></dd>
-<dt><code>stepback</code> <kbd>stepback</kbd></dt>
-<dd><p>The argument is the step threshold for the backward direction,
-which by default is 0.128 s.
+default.
+<br><dt><code>stepback</code> <kbd>stepback</kbd><dd>The argument is the step threshold for the backward direction,
+which by default is 0.128 s.
It can
-be set to any positive number in seconds.
+be set to any positive number in seconds.
If both the forward and backward step thresholds are set to zero, step
-adjustments will never occur.
+adjustments will never occur.
Note: The kernel time discipline is
disabled if
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>
-<dd><p>As for stepback, but for the forward direction.
-</p></dd>
-<dt><code>stepout</code> <kbd>stepout</kbd></dt>
-<dd><p>The argument is the stepout timeout, which by default is 900 s.
+set to zero or greater than .5 second.
+<br><dt><code>stepfwd</code> <kbd>stepfwd</kbd><dd>As for stepback, but for the forward direction.
+<br><dt><code>stepout</code> <kbd>stepout</kbd><dd>The argument is the stepout timeout, which by default is 900 s.
It can
-be set to any positive number in seconds.
+be set to any positive number in seconds.
If set to zero, the stepout
-pulses will not be suppressed.
-</p></dd>
+pulses will not be suppressed.
</dl>
-</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>
-<dd><p>Specify the number of megabytes of memory that should be
-allocated and locked.
+ <br><dt><code>rlimit</code> <code>[memlock </code><kbd>Nmegabytes</kbd><code> | stacksize </code><kbd>N4kPages</kbd><code> filenum </code><kbd>Nfiledescriptors</kbd><code>]</code><dd>
+ <dl>
+<dt><code>memlock</code> <kbd>Nmegabytes</kbd><dd>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>
-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>
-<dd><p>Specifies the maximum size of the process stack on systems with the
+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".
+<br><dt><code>stacksize</code> <kbd>N4kPages</kbd><dd>Specifies the maximum size of the process stack on systems with the
<code>mlockall()</code>
-function.
-Defaults to 50 4k pages (200 4k pages in OpenBSD).
-</p></dd>
-<dt><code>filenum</code> <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>
+function.
+Defaults to 50 4k pages (200 4k pages in OpenBSD).
+<br><dt><code>filenum</code> <kbd>Nfiledescriptors</kbd><dd>Specifies the maximum number of file descriptors ntpd may have open at once.
+Defaults to the system default.
</dl>
-</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>
-<dd><p>This command configures a trap receiver at the given host
+ <br><dt><code>trap</code> <kbd>host_address</kbd> <code>[port </code><kbd>port_number</kbd><code>]</code> <code>[interface </code><kbd>interface_address</kbd><code>]</code><dd>This command configures a trap receiver at the given host
address and port number for sending messages with the specified
-local interface address.
+local interface address.
If the port number is unspecified, a value
-of 18447 is used.
+of 18447 is used.
If the interface address is not specified, the
message is sent with a source address of the local interface the
-message is sent through.
+message is sent through.
Note that on a multihomed host the
interface used may vary from time to time with routing changes.
-</p>
-<p>The trap receiver will generally log event messages and other
-information from the server in a log file.
+
+
<p>The trap receiver will generally log event messages and other
+information from the server in a log file.
While such monitor
programs may also request their own trap dynamically, configuring a
trap receiver will ensure that no messages are lost when the server
-is started.
-</p></dd>
-<dt><code>hop</code> <kbd>...</kbd></dt>
-<dd><p>This command specifies a list of TTL values in increasing order, up to 8
-values can be specified.
+is started.
+<br><dt><code>hop</code> <kbd>...</kbd><dd>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
-an expanding-ring search.
+an expanding-ring search.
The default is eight multiples of 32 starting at
-31.
-</p></dd>
+31.
</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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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>
+
+ <ul class="menu">
+<li><a accesskey="1" href="#ntp_002econf-Files">ntp.conf Files</a>: Files
+<li><a accesskey="2" href="#ntp_002econf-See-Also">ntp.conf See Also</a>: See Also
+<li><a accesskey="3" href="#ntp_002econf-Bugs">ntp.conf Bugs</a>: Bugs
+<li><a accesskey="4" href="#ntp_002econf-Notes">ntp.conf Notes</a>: Notes
+</ul>
+
+<div class="node">
+<a name="ntp.conf-Files"></a>
<a name="ntp_002econf-Files"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="ntp_002econf-Files-1"></a>
-<h4 class="subsection">1.1.8 ntp.conf Files</h4>
-<dl compact="compact">
-<dt><samp>/etc/ntp.conf</samp></dt>
-<dd><p>the default name of the configuration file
-</p></dd>
-<dt><samp>ntp.keys</samp></dt>
-<dd><p>private MD5 keys
-</p></dd>
-<dt><samp>ntpkey</samp></dt>
-<dd><p>RSA private key
-</p></dd>
-<dt><samp>ntpkey_</samp><kbd>host</kbd></dt>
-<dd><p>RSA public key
-</p></dd>
-<dt><samp>ntp_dh</samp></dt>
-<dd><p>Diffie-Hellman agreement parameters
-</p></dd>
+
+<h4 class="subsection">ntp.conf Files</h4>
+
+ <dl>
+<dt><samp><span class="file">/etc/ntp.conf</span></samp><dd>the default name of the configuration file
+<br><dt><samp><span class="file">ntp.keys</span></samp><dd>private MD5 keys
+<br><dt><samp><span class="file">ntpkey</span></samp><dd>RSA private key
+<br><dt><samp><span class="file">ntpkey_</span></samp><kbd>host</kbd><dd>RSA public key
+<br><dt><samp><span class="file">ntp_dh</span></samp><dd>Diffie-Hellman agreement parameters
</dl>
-<hr>
+ <div class="node">
+<a name="ntp.conf-See-Also"></a>
<a name="ntp_002econf-See-Also"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="ntp_002econf-See-Also-1"></a>
-<h4 class="subsection">1.1.9 ntp.conf See Also</h4>
-<p><code>ntpd(1ntpdmdoc)</code>,
+
+<h4 class="subsection">ntp.conf See Also</h4>
+
+ <p><code>ntpd(1ntpdmdoc)</code>,
<code>ntpdc(1ntpdcmdoc)</code>,
<code>ntpq(1ntpqmdoc)</code>
-</p>
-<p>In addition to the manual pages provided,
+
+
<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>http://www.ntp.org/</code>.
A snapshot of this documentation is available in HTML format in
-<samp>/usr/share/doc/ntp</samp>.
-<br>
-</p>
+<samp><span class="file">/usr/share/doc/ntp</span></samp>.
<br>
-<p>David L. Mills, <em>Network Time Protocol (Version 4)</em>, RFC5905
-</p><hr>
+
+ <p><br>
+David L. Mills, <em>Network Time Protocol (Version 4)</em>, RFC5905
+<div class="node">
+<a name="ntp.conf-Bugs"></a>
<a name="ntp_002econf-Bugs"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002econf-Notes" accesskey="n" rel="next">ntp.conf Notes</a>, 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>
+<p><hr>
+
+
</div>
-<a name="ntp_002econf-Bugs-1"></a>
-<h4 class="subsection">1.1.10 ntp.conf Bugs</h4>
-<p>The syntax checking is not picky; some combinations of
+
+<h4 class="subsection">ntp.conf Bugs</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><span class="file">ntpkey_</span></samp><kbd>host</kbd>
files are really digital
-certificates.
+certificates.
These should be obtained via secure directory
-services when they become universally available.
-</p><hr>
-<div class="header">
-<p>
- </p>
+services when they become universally available.
+<div class="node">
+<a name="ntp.conf-Notes"></a>
+<a name="ntp_002econf-Notes"></a>
+<p><hr>
+
+
</div>
-<a name="ntp_002econf-Notes-1"></a>
-<h4 class="subsection">1.1.11 ntp.conf Notes</h4>
-<p>This document was derived from FreeBSD.
-</p><hr>
+<h4 class="subsection">ntp.conf Notes</h4>
+
+ <p>This document was derived from FreeBSD.
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
<title>NTP Symmetric Key</title>
-
+<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="NTP Symmetric Key">
-<meta name="keywords" content="NTP Symmetric Key">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">NTP Symmetric Key</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Description">ntp.keys Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">NTP Symmetric Key</h1>
-
-
+</div>
+<h2 class="unnumbered">NTP's Symmetric Key File User Manual</h2>
+<p>This document describes the symmetric key file for the NTP Project's
+<code>ntpd</code> program.
-<a name="Top"></a>
-<div class="header">
-<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>
-</div>
-<a name="NTP_0027s-Symmetric-Key-File-User-Manual"></a>
-<h1 class="top">NTP’s Symmetric Key File User Manual</h1>
+ <p>This document applies to version 4.2.8p9 of <code>ntp.keys</code>.
-<p>This document describes the symmetric key file for the NTP Project’s
-<code>ntpd</code> program.
-</p>
-<p>This document applies to version 4.2.8p9-win of <code>ntp.keys</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">NTP's Symmetric Key File User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002ekeys-Description">ntp.keys Description</a>
+<li><a accesskey="2" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
+</ul>
-<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>
-
-<hr>
+<div class="node">
+<a name="ntp.keys-Description"></a>
<a name="ntp_002ekeys-Description"></a>
-<div class="header">
-<p>
-Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<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>
-<hr>
+
+<div class="node">
+<a name="ntp.keys-Notes"></a>
<a name="ntp_002ekeys-Notes"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Notes-about-ntp_002ekeys"></a>
-<h3 class="section">1.1 Notes about ntp.keys</h3>
-<a name="index-ntp_002ekeys"></a>
-<a name="index-NTP-symmetric-key-file-format"></a>
+<h3 class="section">Notes about ntp.keys</h3>
+<p><a name="index-ntp_002ekeys-1"></a><a name="index-NTP-symmetric-key-file-format-2"></a>
-<p>This document describes the format of an NTP symmetric key file.
+ <p>This document describes the format of an NTP symmetric key file.
For a description of the use of this type of file, see the
-"Authentication Support"
+"Authentication Support"
section of the
<code>ntp.conf(5)</code>
page.
-</p>
-<p><code>ntpd(8)</code>
+
+
<p><code>ntpd(8)</code>
reads its keys from a file specified using the
<code>-k</code>
command line option or the
<code>keys</code>
-statement in the configuration file.
+statement in the configuration file.
While key number 0 is fixed by the NTP standard
(as 56 zero bits)
and may not be changed,
one or more keys numbered between 1 and 65534
may be arbitrarily set in the keys file.
-</p>
-<p>The key file uses the same comment conventions
-as the configuration file.
+
+
<p>The key file uses the same comment conventions
+as the configuration file.
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></div>
-<p>where
+<pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> <kbd>opt_IP_list</kbd>
+</pre>
+ <p>where
<kbd>keyno</kbd>
is a positive integer (between 1 and 65534),
<kbd>type</kbd>
is the key itself, and
<kbd>opt_IP_list</kbd>
is an optional comma-separated list of IPs
-that are allowed to serve time.
+that are allowed to serve time.
If
<kbd>opt_IP_list</kbd>
is empty,
any properly-authenticated server message will be
accepted.
-</p>
-<p>The
+
<kbd>key</kbd>
may be given in a format
controlled by the
<kbd>type</kbd>
-field.
+field.
The
<kbd>type</kbd>
<code>MD5</code>
-is always supported.
+is always supported.
If
<code>ntpd</code>
was built with the OpenSSL library
-then any digest library supported by that library may be specified.
+then any digest library supported by that library may be specified.
However, if compliance with FIPS 140-2 is required the
<kbd>type</kbd>
must be either
<code>SHA</code>
or
<code>SHA1</code>.
-</p>
-<p>What follows are some key types, and corresponding formats:
-</p>
-<dl compact="compact">
-<dt><code>MD5</code></dt>
-<dd><p>The key is 1 to 16 printable characters terminated by
+
+ <p>What follows are some key types, and corresponding formats:
+
+ <dl>
+<dt><code>MD5</code><dd>The key is 1 to 16 printable characters terminated by
an EOL,
whitespace,
or
a
<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>
-<dd><p>The key is a hex-encoded ASCII string of 40 characters,
-which is truncated as necessary.
-</p></dd>
+(which is the "start of comment" character).
+
+ <br><dt><code>SHA</code><br><dt><code>SHA1</code><br><dt><code>RMD160</code><dd>The key is a hex-encoded ASCII string of 40 characters,
+which is truncated as necessary.
</dl>
-<p>Note that the keys used by the
+
<p>Note that the keys used by the
<code>ntpq(8)</code>
and
<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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002ekeys-Files">ntp.keys Files</a>: Files
+<li><a accesskey="2" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>: See Also
+<li><a accesskey="3" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>: Notes
+</ul>
+
+<div class="node">
+<a name="ntp.keys-Files"></a>
<a name="ntp_002ekeys-Files"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
+
</div>
-<a name="ntp_002ekeys-Files-1"></a>
-<h4 class="subsection">1.1.1 ntp.keys Files</h4>
-<dl compact="compact">
-<dt><samp>/etc/ntp.keys</samp></dt>
-<dd><p>the default name of the configuration file
-</p></dd>
+
+<h4 class="subsection">ntp.keys Files</h4>
+
+ <dl>
+<dt><samp><span class="file">/etc/ntp.keys</span></samp><dd>the default name of the configuration file
</dl>
-<hr>
+<div class="node">
+<a name="ntp.keys-See-Also"></a>
<a name="ntp_002ekeys-See-Also"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002ekeys-Notes" accesskey="n" rel="next">ntp.keys Notes</a>, 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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-Files">ntp.keys Files</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
+
</div>
-<a name="ntp_002ekeys-See-Also-1"></a>
-<h4 class="subsection">1.1.2 ntp.keys See Also</h4>
+
+<h4 class="subsection">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>
-</p><hr>
-<div class="header">
-<p>
- </p>
+<div class="node">
+<a name="ntp.keys-Notes"></a>
+<a name="ntp_002ekeys-Notes"></a>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
+
</div>
-<a name="ntp_002ekeys-Notes-1"></a>
-<h4 class="subsection">1.1.3 ntp.keys Notes</h4>
-<p>This document was derived from FreeBSD.
-</p><hr>
+<h4 class="subsection">ntp.keys Notes</h4>
+
+<p>This document was derived from FreeBSD.
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>ntpd: Network Time Protocol (NTP) Daemon User’s Manual</title>
-
-<meta name="description" content="ntpd: Network Time Protocol (NTP) Daemon User’s Manual">
-<meta name="keywords" content="ntpd: Network Time Protocol (NTP) Daemon User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>ntpd: Network Time Protocol (NTP) Daemon User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="ntpd: Network Time Protocol (NTP) Daemon User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">ntpd: Network Time Protocol (NTP) Daemon User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">ntpd: Network Time Protocol (NTP) Daemon User's Manual</h1>
+<div class="node">
<a name="Top"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-Description">ntpd Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<a name="ntpd_003a-Network-Time-Protocol-_0028NTP_0029-Daemon-User-Manual"></a>
-<h1 class="top">ntpd: Network Time Protocol (NTP) Daemon User Manual</h1>
+
+<h2 class="unnumbered">ntpd: Network Time Protocol (NTP) Daemon User Manual</h2>
<p>The <code>ntpd</code> program is an operating system daemon that synchronizes the
-system clock to remote NTP time servers or local reference clocks.
+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
-1 and 2, defined by RFC-1059 and RFC-1119, respectively.
+1 and 2, defined by RFC-1059 and RFC-1119, respectively.
The program can operate in any of several modes, including client/server,
symmetric and broadcast modes, and with both symmetric-key and public-key
cryptography.
-</p>
-<p>This document applies to version 4.2.8p9-win of <code>ntpd</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
-</ul>
-</div>
+ <p>This document applies to version 4.2.8p9 of <code>ntpd</code>.
-<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>
+<ul class="menu">
+<li><a accesskey="1" href="#ntpd-Description">ntpd Description</a>: Description
+<li><a accesskey="2" href="#ntpd-Invocation">ntpd Invocation</a>: Invoking ntpd
+<li><a accesskey="3" href="#Usage">Usage</a>: Usage
+</ul>
-<hr>
+<div class="node">
<a name="ntpd-Description"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpd-Invocation" accesskey="n" rel="next">ntpd Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>The <code>ntpd</code> program ordinarily requires
-a configuration file described at ‘ntp.conf’.
+a configuration file described at <a href="#ntp_002econf">ntp.conf</a>.
This configuration file contains configuration commands described on
-the pages listed above.
+the pages listed above.
However a client can discover remote servers and configure them
-automatically.
+automatically.
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>ntpd</code> program normally operates continuously while adjusting the
system time and frequency, but in some cases this might not be
-practical.
+practical.
With the <code>-q</code> option <code>ntpd</code> operates as in continuous mode, but
-exits just after setting the clock for the first time.
+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.
+option with the <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,
+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>
-<hr>
+
+<div class="node">
<a name="ntpd-Invocation"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Invoking-ntpd"></a>
-<h3 class="section">1.1 Invoking ntpd</h3>
-<a name="index-ntpd"></a>
-<a name="index-NTP-daemon-program"></a>
+<h3 class="section">Invoking ntpd</h3>
+<p><a name="index-ntpd-1"></a><a name="index-NTP-daemon-program-2"></a>
-<p>The
<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.
+standard time servers.
It is a complete implementation of the
Network Time Protocol (NTP) version 4, as defined by RFC-5905,
but also retains compatibility with
version 3, as defined by RFC-1305, and versions 1
and 2, as defined by RFC-1059 and RFC-1119, respectively.
-</p>
-<p>The
+
<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
-picoseconds.
+picoseconds.
While the ultimate precision is not achievable with
ordinary workstations and networks of today, it may be required
with future gigahertz CPU clocks and gigabit LANs.
-</p>
-<p>Ordinarily,
+
<code>ntpd</code>
reads the
<code>ntp.conf(5)</code>
configuration file at startup time in order to determine the
-synchronization sources and operating modes.
+synchronization sources and operating modes.
It is also possible to
specify a working, although limited, configuration entirely on the
-command line, obviating the need for a configuration file.
+command line, obviating the need for a configuration file.
This may
be particularly useful when the local host is to be configured as a
broadcast/multicast client, with all peers being determined by
listening to broadcasts at run time.
-</p>
-<p>If NetInfo support is built into
+
+
<p>If NetInfo support is built into
<code>ntpd</code>
then
<code>ntpd</code>
specified by the
<code>-c</code>
option.
-</p>
-<p>Various internal
+
<code>ntpd</code>
variables can be displayed and
configuration options altered while the
and
<code>ntpdc(1ntpdcmdoc)</code>
utility programs.
-</p>
-<p>When
+
<code>ntpd</code>
starts it looks at the value of
<code>umask(2)</code>,
will set the
<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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntpd-usage">ntpd usage</a>: ntpd help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntpd-ipv4">ntpd ipv4</a>: ipv4 option (-4)
+<li><a accesskey="3" href="#ntpd-ipv6">ntpd ipv6</a>: ipv6 option (-6)
+<li><a accesskey="4" href="#ntpd-authreq">ntpd authreq</a>: authreq option (-a)
+<li><a accesskey="5" href="#ntpd-authnoreq">ntpd authnoreq</a>: authnoreq option (-A)
+<li><a accesskey="6" href="#ntpd-configfile">ntpd configfile</a>: configfile option (-c)
+<li><a accesskey="7" href="#ntpd-driftfile">ntpd driftfile</a>: driftfile option (-f)
+<li><a accesskey="8" href="#ntpd-panicgate">ntpd panicgate</a>: panicgate option (-g)
+<li><a accesskey="9" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>: force-step-once option (-G)
+<li><a href="#ntpd-jaildir">ntpd jaildir</a>: jaildir option (-i)
+<li><a href="#ntpd-interface">ntpd interface</a>: interface option (-I)
+<li><a href="#ntpd-keyfile">ntpd keyfile</a>: keyfile option (-k)
+<li><a href="#ntpd-logfile">ntpd logfile</a>: logfile option (-l)
+<li><a href="#ntpd-novirtualips">ntpd novirtualips</a>: novirtualips option (-L)
+<li><a href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>: modifymmtimer option (-M)
+<li><a href="#ntpd-nice">ntpd nice</a>: nice option (-N)
+<li><a href="#ntpd-pidfile">ntpd pidfile</a>: pidfile option (-p)
+<li><a href="#ntpd-priority">ntpd priority</a>: priority option (-P)
+<li><a href="#ntpd-quit">ntpd quit</a>: quit option (-q)
+<li><a href="#ntpd-propagationdelay">ntpd propagationdelay</a>: propagationdelay option (-r)
+<li><a href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>: saveconfigquit option
+<li><a href="#ntpd-statsdir">ntpd statsdir</a>: statsdir option (-s)
+<li><a href="#ntpd-trustedkey">ntpd trustedkey</a>: trustedkey option (-t)
+<li><a href="#ntpd-user">ntpd user</a>: user option (-u)
+<li><a href="#ntpd-updateinterval">ntpd updateinterval</a>: updateinterval option (-U)
+<li><a href="#ntpd-wait_002dsync">ntpd wait-sync</a>: wait-sync option (-w)
+<li><a href="#ntpd-slew">ntpd slew</a>: slew option (-x)
+<li><a href="#ntpd-usepcc">ntpd usepcc</a>: usepcc option
+<li><a href="#ntpd-pccfreq">ntpd pccfreq</a>: pccfreq option
+<li><a href="#ntpd-mdns">ntpd mdns</a>: mdns option (-m)
+<li><a href="#ntpd-config">ntpd config</a>: presetting/configuring ntpd
+<li><a href="#ntpd-exit-status">ntpd exit status</a>: exit status
+<li><a href="#ntpd-Usage">ntpd Usage</a>: Usage
+<li><a href="#ntpd-Files">ntpd Files</a>: Files
+<li><a href="#ntpd-See-Also">ntpd See Also</a>: See Also
+<li><a href="#ntpd-Bugs">ntpd Bugs</a>: Bugs
+<li><a href="#ntpd-Notes">ntpd Notes</a>: Notes
+</ul>
+
+<div class="node">
<a name="ntpd-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-ipv4">ntpd ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.1.1 ntpd help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">ntpd help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntpd-help-3"></a>
+This is the automatically generated usage text for ntpd.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit
with a status code of 0.
-</p>
-<div class="example">
+
<pre class="example">ntpd - NTP daemon program - Ver. 4.2.8p9
Usage: ntpd [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \
[ <server1> ... <serverN> ]
- examining environment variables named NTPD_*
Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org>
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<a name="ntpd-ipv4"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-ipv6">ntpd ipv6</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-usage">ntpd usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ipv4-option-_0028_002d4_0029"></a>
-<h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<a name="index-ntpd_002dipv4"></a>
-
-<p>This is the “force ipv4 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv4 option (-4)</h4>
+
+<p><a name="index-ntpd_002dipv4-4"></a>
+This is the “force ipv4 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv6.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv4 namespace.
+<div class="node">
<a name="ntpd-ipv6"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-authreq">ntpd authreq</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-ipv4">ntpd ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ipv6-option-_0028_002d6_0029"></a>
-<h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<a name="index-ntpd_002dipv6"></a>
-
-<p>This is the “force ipv6 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv6 option (-6)</h4>
+
+<p><a name="index-ntpd_002dipv6-5"></a>
+This is the “force ipv6 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv4.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv6 namespace.
+<div class="node">
<a name="ntpd-authreq"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-authnoreq">ntpd authnoreq</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-ipv6">ntpd ipv6</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="authreq-option-_0028_002da_0029"></a>
-<h4 class="subsection">1.1.4 authreq option (-a)</h4>
-<a name="index-ntpd_002dauthreq"></a>
-
-<p>This is the “require crypto authentication” option.
-</p>
-<p>This option has some usage constraints. It:
-<li> must not appear in combination with any of the following options:
-authnoreq.
-</li></ul>
-
-<p>Require cryptographic authentication for broadcast client,
-multicast client and symmetric passive associations.
-This is the default.
-</p><hr>
+
+<h4 class="subsection">authreq option (-a)</h4>
+
+<p><a name="index-ntpd_002dauthreq-6"></a>
+This is the “require crypto authentication” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+authnoreq.
+</ul>
+
+
<p>Require cryptographic authentication for broadcast client,
+multicast client and symmetric passive associations.
+This is the default.
+<div class="node">
<a name="ntpd-authnoreq"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-configfile">ntpd configfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-authreq">ntpd authreq</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="authnoreq-option-_0028_002dA_0029"></a>
-<h4 class="subsection">1.1.5 authnoreq option (-A)</h4>
-<a name="index-ntpd_002dauthnoreq"></a>
-
-<p>This is the “do not require crypto authentication” option.
-</p>
-<p>This option has some usage constraints. It:
-<li> must not appear in combination with any of the following options:
-authreq.
-</li></ul>
-
-<p>Do not require cryptographic authentication for broadcast client,
-multicast client and symmetric passive associations.
-This is almost never a good idea.
-</p><hr>
+
+<h4 class="subsection">authnoreq option (-A)</h4>
+
+<p><a name="index-ntpd_002dauthnoreq-7"></a>
+This is the “do not require crypto authentication” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+authreq.
+</ul>
+
+
<p>Do not require cryptographic authentication for broadcast client,
+multicast client and symmetric passive associations.
+This is almost never a good idea.
+<div class="node">
<a name="ntpd-configfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-driftfile">ntpd driftfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-authnoreq">ntpd authnoreq</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="configfile-option-_0028_002dc_0029"></a>
-<h4 class="subsection">1.1.6 configfile option (-c)</h4>
-<a name="index-ntpd_002dconfigfile"></a>
-<p>This is the “configuration file name” option.
-This option takes a string argument.
+<h4 class="subsection">configfile option (-c)</h4>
+
+<p><a name="index-ntpd_002dconfigfile-8"></a>
+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>
-by default.
-</p><hr>
+<samp><span class="file">/etc/ntp.conf</span></samp>
+by default.
+<div class="node">
<a name="ntpd-driftfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-panicgate">ntpd panicgate</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-configfile">ntpd configfile</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="driftfile-option-_0028_002df_0029"></a>
-<h4 class="subsection">1.1.7 driftfile option (-f)</h4>
-<a name="index-ntpd_002ddriftfile"></a>
-<p>This is the “frequency drift file name” option.
-This option takes a string argument.
+<h4 class="subsection">driftfile option (-f)</h4>
+
+<p><a name="index-ntpd_002ddriftfile-9"></a>
+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>
-by default.
+<samp><span class="file">/etc/ntp.drift</span></samp>
+by default.
This is the same operation as the
<code>driftfile</code> <kbd>driftfile</kbd>
configuration specification in the
-<samp>/etc/ntp.conf</samp>
-file.
-</p><hr>
+<samp><span class="file">/etc/ntp.conf</span></samp>
+file.
+<div class="node">
<a name="ntpd-panicgate"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-driftfile">ntpd driftfile</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="panicgate-option-_0028_002dg_0029"></a>
-<h4 class="subsection">1.1.8 panicgate option (-g)</h4>
-<a name="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:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>Normally,
+
+<h4 class="subsection">panicgate option (-g)</h4>
+
+<p><a name="index-ntpd_002dpanicgate-10"></a>
+This is the “allow the first adjustment to be big” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</ul>
+
<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>-q</code>
and
<code>-x</code>
-options.
+options.
See the
<code>tinker</code>
-configuration file directive for other options.
-</p><hr>
+configuration file directive for other options.
+<div class="node">
+<a name="ntpd-force-step-once"></a>
<a name="ntpd-force_002dstep_002donce"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-jaildir">ntpd jaildir</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-panicgate">ntpd panicgate</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="force_002dstep_002donce-option-_0028_002dG_0029"></a>
-<h4 class="subsection">1.1.9 force-step-once option (-G)</h4>
-<a name="index-ntpd_002dforce_002dstep_002donce"></a>
-<p>This is the “step any initial offset correction.” option.
+<h4 class="subsection">force-step-once option (-G)</h4>
+
+<p><a name="index-ntpd_002dforce_002dstep_002donce-11"></a>
+This is the “step any initial offset correction.” option.
Normally,
<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.
+which is 128 ms by default, and otherwise slews the time.
This option forces the initial offset correction to be stepped,
-so the highest time accuracy can be achieved quickly.
+so the highest time accuracy can be achieved quickly.
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.
-</p><hr>
+applications requiring monotonic time are running.
+See the <code>tinker</code> configuration file directive for other options.
+<div class="node">
<a name="ntpd-jaildir"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-interface">ntpd interface</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="jaildir-option-_0028_002di_0029"></a>
-<h4 class="subsection">1.1.10 jaildir option (-i)</h4>
-<a name="index-ntpd_002djaildir"></a>
-<p>This is the “jail directory” option.
+<h4 class="subsection">jaildir option (-i)</h4>
+
+<p><a name="index-ntpd_002djaildir-12"></a>
+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.
-</li></ul>
-<p>Chroot the server to the directory
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation.
+</ul>
+
+ <p>Chroot the server to the directory
<kbd>jaildir</kbd>
-.
-This option also implies that the server attempts to drop root privileges at startup.
+.
+This option also implies that the server attempts to drop root privileges at startup.
You may need to also specify a
<code>-u</code>
-option.
+option.
This option is only available if the OS supports adjusting the clock
-without full root privileges.
+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>).
-</p><hr>
+<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>).
+<div class="node">
<a name="ntpd-interface"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-keyfile">ntpd keyfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-jaildir">ntpd jaildir</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="interface-option-_0028_002dI_0029"></a>
-<h4 class="subsection">1.1.11 interface option (-I)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>Open the network address given, or all the addresses associated with the
+
+<h4 class="subsection">interface option (-I)</h4>
+
+<p><a name="index-ntpd_002dinterface-13"></a>
+This is the “listen on an interface name or address” option.
+This option takes a string argument <samp><span class="file">iface</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</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.
+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.
-</p><hr>
+<code>interface</code> command, which is more versatile.
+<div class="node">
<a name="ntpd-keyfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-logfile">ntpd logfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-interface">ntpd interface</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="keyfile-option-_0028_002dk_0029"></a>
-<h4 class="subsection">1.1.12 keyfile option (-k)</h4>
-<a name="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>
-is the default.
+<h4 class="subsection">keyfile option (-k)</h4>
+
+<p><a name="index-ntpd_002dkeyfile-14"></a>
+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><span class="file">/etc/ntp.keys</span></samp>
+is the default.
This is the same operation as the
<code>keys</code> <kbd>keyfile</kbd>
-configuration file directive.
-</p><hr>
+configuration file directive.
+<div class="node">
<a name="ntpd-logfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-novirtualips">ntpd novirtualips</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-keyfile">ntpd keyfile</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="logfile-option-_0028_002dl_0029"></a>
-<h4 class="subsection">1.1.13 logfile option (-l)</h4>
-<a name="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.
+<h4 class="subsection">logfile option (-l)</h4>
+
+<p><a name="index-ntpd_002dlogfile-15"></a>
+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>
-configuration file directive.
-</p><hr>
+configuration file directive.
+<div class="node">
<a name="ntpd-novirtualips"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-logfile">ntpd logfile</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="novirtualips-option-_0028_002dL_0029"></a>
-<h4 class="subsection">1.1.14 novirtualips option (-L)</h4>
-<a name="index-ntpd_002dnovirtualips"></a>
-<p>This is the “do not listen to virtual interfaces” option.
+<h4 class="subsection">novirtualips option (-L)</h4>
+
+<p><a name="index-ntpd_002dnovirtualips-16"></a>
+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
-is more versatile.
-</p><hr>
+is more versatile.
+<div class="node">
<a name="ntpd-modifymmtimer"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-nice">ntpd nice</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-novirtualips">ntpd novirtualips</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="modifymmtimer-option-_0028_002dM_0029"></a>
-<h4 class="subsection">1.1.15 modifymmtimer option (-M)</h4>
-<a name="index-ntpd_002dmodifymmtimer"></a>
-
-<p>This is the “modify multimedia timer (windows only)” option.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
-</li></ul>
-
-<p>Set the Windows Multimedia Timer to highest resolution. This
+
+<h4 class="subsection">modifymmtimer option (-M)</h4>
+
+<p><a name="index-ntpd_002dmodifymmtimer-17"></a>
+This is the “modify multimedia timer (windows only)” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</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>
+avoiding timekeeping glitches associated with changes.
+<div class="node">
<a name="ntpd-nice"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-pidfile">ntpd pidfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="nice-option-_0028_002dN_0029"></a>
-<h4 class="subsection">1.1.16 nice option (-N)</h4>
-<a name="index-ntpd_002dnice"></a>
-<p>This is the “run at high priority” option.
+<h4 class="subsection">nice option (-N)</h4>
+
+<p><a name="index-ntpd_002dnice-18"></a>
+This is the “run at high priority” option.
To the extent permitted by the operating system, run
<code>ntpd</code>
-at the highest priority.
-</p><hr>
+at the highest priority.
+<div class="node">
<a name="ntpd-pidfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-priority">ntpd priority</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-nice">ntpd nice</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="pidfile-option-_0028_002dp_0029"></a>
-<h4 class="subsection">1.1.17 pidfile option (-p)</h4>
-<a name="index-ntpd_002dpidfile"></a>
-<p>This is the “path to the pid file” option.
-This option takes a string argument.
+<h4 class="subsection">pidfile option (-p)</h4>
+
+<p><a name="index-ntpd_002dpidfile-19"></a>
+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
-process ID.
+<code>ntpd</code>'s
+process ID.
This is the same operation as the
<code>pidfile</code> <kbd>pidfile</kbd>
-configuration file directive.
-</p><hr>
+configuration file directive.
+<div class="node">
<a name="ntpd-priority"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-quit">ntpd quit</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-pidfile">ntpd pidfile</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="priority-option-_0028_002dP_0029"></a>
-<h4 class="subsection">1.1.18 priority option (-P)</h4>
-<a name="index-ntpd_002dpriority"></a>
-<p>This is the “process priority” option.
-This option takes a number argument.
+<h4 class="subsection">priority option (-P)</h4>
+
+<p><a name="index-ntpd_002dpriority-20"></a>
+This is the “process priority” option.
+This option takes a number argument.
To the extent permitted by the operating system, run
<code>ntpd</code>
at the specified
<code>sched_setscheduler(SCHED_FIFO)</code>
-priority.
-</p><hr>
+priority.
+<div class="node">
<a name="ntpd-quit"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-propagationdelay">ntpd propagationdelay</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-priority">ntpd priority</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="quit-option-_0028_002dq_0029"></a>
-<h4 class="subsection">1.1.19 quit option (-q)</h4>
-<a name="index-ntpd_002dquit"></a>
-
-<p>This is the “set the time and quit” option.
-</p>
-<p>This option has some usage constraints. It:
-<li> must not appear in combination with any of the following options:
-saveconfigquit, wait-sync.
-</li></ul>
-
-<p><code>ntpd</code>
+
+<h4 class="subsection">quit option (-q)</h4>
+
+<p><a name="index-ntpd_002dquit-21"></a>
+This is the “set the time and quit” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+saveconfigquit, wait-sync.
+</ul>
+
will not daemonize and will exit after the clock is first
synchronized. This behavior mimics that of the
<code>ntpdate</code>
-program, which will soon be replaced with a shell script.
+program, which will soon be replaced with a shell script.
The
<code>-g</code>
and
<code>-x</code>
-options can be used with this option.
-Note: The kernel time discipline is disabled with this option.
-</p><hr>
+options can be used with this option.
+Note: The kernel time discipline is disabled with this option.
+<div class="node">
<a name="ntpd-propagationdelay"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-quit">ntpd quit</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="propagationdelay-option-_0028_002dr_0029"></a>
-<h4 class="subsection">1.1.20 propagationdelay option (-r)</h4>
-<a name="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>
+<h4 class="subsection">propagationdelay option (-r)</h4>
+
+<p><a name="index-ntpd_002dpropagationdelay-22"></a>
+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.
+<div class="node">
<a name="ntpd-saveconfigquit"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-statsdir">ntpd statsdir</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-propagationdelay">ntpd propagationdelay</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="saveconfigquit-option"></a>
-<h4 class="subsection">1.1.21 saveconfigquit option</h4>
-<a name="index-ntpd_002dsaveconfigquit"></a>
-<p>This is the “save parsed configuration and quit” option.
+<h4 class="subsection">saveconfigquit option</h4>
+
+<p><a name="index-ntpd_002dsaveconfigquit-23"></a>
+This is the “save parsed configuration and quit” option.
This option takes a string argument.
-</p>
-<p>This option has some usage constraints. It:
-<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:
-quit, wait-sync.
-</li></ul>
-
-<p>Cause <code>ntpd</code> to parse its startup configuration file and save an
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>SAVECONFIG</code> during the compilation.
+<li>must not appear in combination with any of the following options:
+quit, wait-sync.
+</ul>
+
+
<p>Cause <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>
+designed for automated testing.
+<div class="node">
<a name="ntpd-statsdir"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-trustedkey">ntpd trustedkey</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="statsdir-option-_0028_002ds_0029"></a>
-<h4 class="subsection">1.1.22 statsdir option (-s)</h4>
-<a name="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.
+<h4 class="subsection">statsdir option (-s)</h4>
+
+<p><a name="index-ntpd_002dstatsdir-24"></a>
+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>
-configuration file directive.
-</p><hr>
+configuration file directive.
+<div class="node">
<a name="ntpd-trustedkey"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-user">ntpd user</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-statsdir">ntpd statsdir</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="trustedkey-option-_0028_002dt_0029"></a>
-<h4 class="subsection">1.1.23 trustedkey option (-t)</h4>
-<a name="index-ntpd_002dtrustedkey"></a>
-
-<p>This is the “trusted key number” option.
-This option takes a string argument <samp>tkey</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>Add the specified key number to the trusted key list.
-</p><hr>
+
+<h4 class="subsection">trustedkey option (-t)</h4>
+
+<p><a name="index-ntpd_002dtrustedkey-25"></a>
+This is the “trusted key number” option.
+This option takes a string argument <samp><span class="file">tkey</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</ul>
+
+ <p>Add the specified key number to the trusted key list.
+<div class="node">
<a name="ntpd-user"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-updateinterval">ntpd updateinterval</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-trustedkey">ntpd trustedkey</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="user-option-_0028_002du_0029"></a>
-<h4 class="subsection">1.1.24 user option (-u)</h4>
-<a name="index-ntpd_002duser"></a>
-<p>This is the “run as userid (or userid:groupid)” option.
+<h4 class="subsection">user option (-u)</h4>
+
+<p><a name="index-ntpd_002duser-26"></a>
+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.
-</li></ul>
-<p>Specify a user, and optionally a group, to switch to.
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation.
+</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.
+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>).
-</p><hr>
+<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>).
+<div class="node">
<a name="ntpd-updateinterval"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-wait_002dsync">ntpd wait-sync</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-user">ntpd user</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="updateinterval-option-_0028_002dU_0029"></a>
-<h4 class="subsection">1.1.25 updateinterval option (-U)</h4>
-<a name="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.
-Give the time in seconds between two scans for new or dropped interfaces.
+<h4 class="subsection">updateinterval option (-U)</h4>
+
+<p><a name="index-ntpd_002dupdateinterval-27"></a>
+This is the “interval in seconds between scans for new or dropped interfaces” option.
+This option takes a number argument.
+Give the time in seconds between two scans for new or dropped interfaces.
For systems with routing socket support the scans will be performed shortly after the interface change
-has been detected by the system.
-Use 0 to disable scanning. 60 seconds is the minimum time between scans.
-</p><hr>
+has been detected by the system.
+Use 0 to disable scanning. 60 seconds is the minimum time between scans.
+<div class="node">
+<a name="ntpd-wait-sync"></a>
<a name="ntpd-wait_002dsync"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-slew">ntpd slew</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-updateinterval">ntpd updateinterval</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="wait_002dsync-option-_0028_002dw_0029"></a>
-<h4 class="subsection">1.1.26 wait-sync option (-w)</h4>
-<a name="index-ntpd_002dwait_002dsync"></a>
-<p>This is the “seconds to wait for first clock sync” option.
+<h4 class="subsection">wait-sync option (-w)</h4>
+
+<p><a name="index-ntpd_002dwait_002dsync-28"></a>
+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:
-<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:
-nofork, quit, saveconfigquit.
-</li></ul>
-
-<p>If greater than zero, alters <code>ntpd</code>’s behavior when forking to
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>HAVE_WORKING_FORK</code> during the compilation.
+<li>must not appear in combination with any of the following options:
+nofork, quit, saveconfigquit.
+</ul>
+
+ <p>If greater than zero, alters <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>.
+otherwise it is <code>ETIMEDOUT</code>.
This provides the option for a script starting <code>ntpd</code> to easily
-wait for the first set of the clock before proceeding.
-</p><hr>
+wait for the first set of the clock before proceeding.
+<div class="node">
<a name="ntpd-slew"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-usepcc">ntpd usepcc</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-wait_002dsync">ntpd wait-sync</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="slew-option-_0028_002dx_0029"></a>
-<h4 class="subsection">1.1.27 slew option (-x)</h4>
-<a name="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.
-This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
-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.
+
+<h4 class="subsection">slew option (-x)</h4>
+
+<p><a name="index-ntpd_002dslew-29"></a>
+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.
+This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
+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>
and
<code>-q</code>
-options.
+options.
See the
<code>tinker</code>
-configuration file directive for other options.
-Note: The kernel time discipline is disabled with this option.
-</p><hr>
+configuration file directive for other options.
+Note: The kernel time discipline is disabled with this option.
+<div class="node">
<a name="ntpd-usepcc"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-pccfreq">ntpd pccfreq</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-slew">ntpd slew</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="usepcc-option"></a>
-<h4 class="subsection">1.1.28 usepcc option</h4>
-<a name="index-ntpd_002dusepcc"></a>
-
-<p>This is the “use cpu cycle counter (windows only)” option.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
-</li></ul>
-
-<p>Attempt to substitute the CPU counter for <code>QueryPerformanceCounter</code>.
+
+<h4 class="subsection">usepcc option</h4>
+
+<p><a name="index-ntpd_002dusepcc-30"></a>
+This is the “use cpu cycle counter (windows only)” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</ul>
+
+ <p>Attempt to substitute the CPU counter for <code>QueryPerformanceCounter</code>.
The CPU counter and <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>
+used directly, saving the overhead of a system call.
+<div class="node">
<a name="ntpd-pccfreq"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-mdns">ntpd mdns</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-usepcc">ntpd usepcc</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="pccfreq-option"></a>
-<h4 class="subsection">1.1.29 pccfreq option</h4>
-<a name="index-ntpd_002dpccfreq"></a>
-<p>This is the “force cpu cycle counter use (windows only)” option.
+<h4 class="subsection">pccfreq option</h4>
+
+<p><a name="index-ntpd_002dpccfreq-31"></a>
+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.
-</li></ul>
-<p>Force substitution the CPU counter for <code>QueryPerformanceCounter</code>.
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation.
+</ul>
+
+ <p>Force substitution the CPU counter for <code>QueryPerformanceCounter</code>.
The CPU counter (RDTSC on x86) is used unconditionally with the
-given frequency (in Hz).
-</p><hr>
+given frequency (in Hz).
+<div class="node">
<a name="ntpd-mdns"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-config">ntpd config</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-pccfreq">ntpd pccfreq</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="mdns-option-_0028_002dm_0029"></a>
-<h4 class="subsection">1.1.30 mdns option (-m)</h4>
-<a name="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:
-<li> must be compiled in by defining <code>HAVE_DNSREGISTRATION</code> during the compilation.
-</li></ul>
-
-<p>Registers as an NTP server with the local mDNS server which allows
+
+<h4 class="subsection">mdns option (-m)</h4>
+
+<p><a name="index-ntpd_002dmdns-32"></a>
+This is the “register with mdns as a ntp server” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>HAVE_DNSREGISTRATION</code> during the compilation.
+</ul>
+
+
<p>Registers as an NTP server with the local mDNS server which allows
the server to be discovered via mDNS client lookup.
-</p>
-<hr>
+<div class="node">
<a name="ntpd-config"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-exit-status">ntpd exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-mdns">ntpd mdns</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="presetting_002fconfiguring-ntpd"></a>
-<h4 class="subsection">1.1.31 presetting/configuring ntpd</h4>
+
+<h4 class="subsection">presetting/configuring ntpd</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
-the options listed above in upper case and segmented with underscores.
+the options listed above in upper case and segmented with underscores.
The <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>
-<a name="version-_0028_002d_0029"></a>
-<h4 class="subsubheading">version (-)</h4>
+ <p>The command line options relating to configuration and/or usage help are:
+
+<h5 class="subsubheading">version (-)</h5>
<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 infomation may be selected with an option argument.
+detail to provide. The default is to print just the version. The licensing infomation 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>
-<dd><p>Only print the version. This is the default.
-</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
-<dd><p>Name the copyright usage licensing terms.
-</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
-<dd><p>Print the full copyright usage licensing terms.
-</p></dd>
+
+ <dl>
+<dt>‘<samp><span class="samp">version</span></samp>’<dd>Only print the version. This is the default.
+<br><dt>‘<samp><span class="samp">copyright</span></samp>’<dd>Name the copyright usage licensing terms.
+<br><dt>‘<samp><span class="samp">verbose</span></samp>’<dd>Print the full copyright usage licensing terms.
</dl>
-<hr>
+<div class="node">
<a name="ntpd-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-Usage">ntpd Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-config">ntpd config</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-exit-status-1"></a>
-<h4 class="subsection">1.1.32 ntpd exit status</h4>
+
+<h4 class="subsection">ntpd exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
+ <div class="node">
<a name="ntpd-Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-Files">ntpd Files</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-exit-status">ntpd exit status</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-Usage-1"></a>
-<h4 class="subsection">1.1.33 ntpd Usage</h4>
-<hr>
+
+<h4 class="subsection">ntpd Usage</h4>
+
+<div class="node">
<a name="ntpd-Files"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-See-Also">ntpd See Also</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-Usage">ntpd Usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-Files-1"></a>
-<h4 class="subsection">1.1.34 ntpd Files</h4>
-<hr>
+
+<h4 class="subsection">ntpd Files</h4>
+
+<div class="node">
<a name="ntpd-See-Also"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-Bugs">ntpd Bugs</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-Files">ntpd Files</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-See-Also-1"></a>
-<h4 class="subsection">1.1.35 ntpd See Also</h4>
-<hr>
+
+<h4 class="subsection">ntpd See Also</h4>
+
+<div class="node">
<a name="ntpd-Bugs"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpd-Notes">ntpd Notes</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpd-See-Also">ntpd See Also</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-Bugs-1"></a>
-<h4 class="subsection">1.1.36 ntpd Bugs</h4>
-<hr>
+
+<h4 class="subsection">ntpd Bugs</h4>
+
+<div class="node">
<a name="ntpd-Notes"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntpd-Bugs">ntpd Bugs</a>,
+Up: <a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
+
</div>
-<a name="ntpd-Notes-1"></a>
-<h4 class="subsection">1.1.37 ntpd Notes</h4>
-<hr>
+<h4 class="subsection">ntpd Notes</h4>
+
+<div class="node">
<a name="Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Usage-1"></a>
-<h3 class="section">1.2 Usage</h3>
-
-<table>
-<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>
-</table>
-<hr>
-
-
-
-</body>
-</html>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</h3>
+
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>ntpdc: NTPD Control User’s Manual</title>
-
-<meta name="description" content="ntpdc: NTPD Control User’s Manual">
-<meta name="keywords" content="ntpdc: NTPD Control User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>ntpdc: NTPD Control User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="ntpdc: NTPD Control User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">ntpdc: NTPD Control User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">ntpdc: NTPD Control User's Manual</h1>
+<div class="node">
<a name="Top"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-Description">ntpdc Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<a name="ntpdc_003a-NTPD-Control-User-Manual"></a>
-<h1 class="top">ntpdc: NTPD Control User Manual</h1>
-<p>This document describes the use of the NTP Project’s <code>ntpdc</code> program,
+<h2 class="unnumbered">ntpdc: NTPD Control User Manual</h2>
+
+<p>This document describes the use of the NTP Project's <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.8p9-win of <code>ntpdc</code>.
-</p>
-<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
+
+ <p>This document applies to version 4.2.8p9 of <code>ntpdc</code>.
+
+
<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
IETF specification.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">ntpdc: NTPD Control User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntpdc-Description">ntpdc Description</a>: Description
+<li><a accesskey="2" href="#ntpdc-Invocation">ntpdc Invocation</a>: Invoking ntpdc
+<li><a accesskey="3" href="#Usage">Usage</a>: Usage
+</ul>
-<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>
-
-<hr>
+<div class="node">
<a name="ntpdc-Description"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpdc-Invocation" accesskey="n" rel="next">ntpdc Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>By default, <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></div>
-<p>where
+<pre class="example"> 1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+</pre>
+ <p>where
YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
(+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
and
the +4.567 +/- 0.089 secs indicates the time offset and
error bound of the system clock relative to the server clock.
-</p>
-<hr>
+
+<div class="node">
<a name="ntpdc-Invocation"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Invoking-ntpdc"></a>
-<h3 class="section">1.1 Invoking ntpdc</h3>
-<a name="index-ntpdc"></a>
-<a name="index-vendor_002dspecific-NTPD-control-program"></a>
+<h3 class="section">Invoking ntpdc</h3>
+<p><a name="index-ntpdc-1"></a><a name="index-vendor_002dspecific-NTPD-control-program-2"></a>
-<p><code>ntpdc</code>
-is deprecated.
+is deprecated.
Please use
<code>ntpq(1ntpqmdoc)</code> instead - it can do everything
<code>ntpdc</code>
used to do, and it does so using a much more sane interface.
-</p>
-<p><code>ntpdc</code>
+
is a utility program used to query
<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.
+current state and to request changes in that state.
+It uses NTP mode 7 control message formats described in the source code.
The program may
be run either in interactive mode or controlled using command line
-arguments.
+arguments.
Extensive state and statistics information is available
through the
<code>ntpdc</code>
-interface.
+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
+ntpd's configuration file may also be specified at run time using
<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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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-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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntpdc-usage">ntpdc usage</a>: ntpdc help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntpdc-ipv4">ntpdc ipv4</a>: ipv4 option (-4)
+<li><a accesskey="3" href="#ntpdc-ipv6">ntpdc ipv6</a>: ipv6 option (-6)
+<li><a accesskey="4" href="#ntpdc-command">ntpdc command</a>: command option (-c)
+<li><a accesskey="5" href="#ntpdc-interactive">ntpdc interactive</a>: interactive option (-i)
+<li><a accesskey="6" href="#ntpdc-listpeers">ntpdc listpeers</a>: listpeers option (-l)
+<li><a accesskey="7" href="#ntpdc-numeric">ntpdc numeric</a>: numeric option (-n)
+<li><a accesskey="8" href="#ntpdc-peers">ntpdc peers</a>: peers option (-p)
+<li><a accesskey="9" href="#ntpdc-showpeers">ntpdc showpeers</a>: showpeers option (-s)
+<li><a href="#ntpdc-config">ntpdc config</a>: presetting/configuring ntpdc
+<li><a href="#ntpdc-exit-status">ntpdc exit status</a>: exit status
+<li><a href="#ntpdc-Usage">ntpdc Usage</a>: Usage
+<li><a href="#ntpdc-See-Also">ntpdc See Also</a>: See Also
+<li><a href="#ntpdc-Authors">ntpdc Authors</a>: Authors
+<li><a href="#ntpdc-Bugs">ntpdc Bugs</a>: Bugs
+</ul>
+
+<div class="node">
<a name="ntpdc-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-ipv4">ntpdc ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.1.1 ntpdc help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">ntpdc help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntpdc-help-3"></a>
+This is the automatically generated usage text for ntpdc.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
Usage: ntpdc [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
Flg Arg Option-Name Description
- examining environment variables named NTPDC_*
Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org>
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<a name="ntpdc-ipv4"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-ipv6">ntpdc ipv6</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-usage">ntpdc usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ipv4-option-_0028_002d4_0029"></a>
-<h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<a name="index-ntpdc_002dipv4"></a>
-
-<p>This is the “force ipv4 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv4 option (-4)</h4>
+
+<p><a name="index-ntpdc_002dipv4-4"></a>
+This is the “force ipv4 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv6.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv4 namespace.
+<div class="node">
<a name="ntpdc-ipv6"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-command">ntpdc command</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-ipv4">ntpdc ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ipv6-option-_0028_002d6_0029"></a>
-<h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<a name="index-ntpdc_002dipv6"></a>
-
-<p>This is the “force ipv6 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv6 option (-6)</h4>
+
+<p><a name="index-ntpdc_002dipv6-5"></a>
+This is the “force ipv6 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv4.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv6 namespace.
+<div class="node">
<a name="ntpdc-command"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-interactive">ntpdc interactive</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-ipv6">ntpdc ipv6</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="command-option-_0028_002dc_0029"></a>
-<h4 class="subsection">1.1.4 command option (-c)</h4>
-<a name="index-ntpdc_002dcommand"></a>
-
-<p>This is the “run a command and exit” option.
-This option takes a string argument <samp>cmd</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>The following argument is interpreted as an interactive format command
+
+<h4 class="subsection">command option (-c)</h4>
+
+<p><a name="index-ntpdc_002dcommand-6"></a>
+This is the “run a command and exit” option.
+This option takes a string argument <samp><span class="file">cmd</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</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>
+host(s).
+<div class="node">
<a name="ntpdc-interactive"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-listpeers">ntpdc listpeers</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-command">ntpdc command</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="interactive-option-_0028_002di_0029"></a>
-<h4 class="subsection">1.1.5 interactive option (-i)</h4>
-<a name="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:
-<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>
+
+<h4 class="subsection">interactive option (-i)</h4>
+
+<p><a name="index-ntpdc_002dinteractive-7"></a>
+This is the “force ntpq to operate in interactive mode” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+command, listpeers, peers, showpeers.
+</ul>
+
+
<p>Force ntpq to operate in interactive mode. Prompts will be written
+to the standard output and commands read from the standard input.
+<div class="node">
<a name="ntpdc-listpeers"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-numeric">ntpdc numeric</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-interactive">ntpdc interactive</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="listpeers-option-_0028_002dl_0029"></a>
-<h4 class="subsection">1.1.6 listpeers option (-l)</h4>
-<a name="index-ntpdc_002dlistpeers"></a>
-
-<p>This is the “print a list of the peers” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">listpeers option (-l)</h4>
+
+<p><a name="index-ntpdc_002dlistpeers-8"></a>
+This is the “print a list of the peers” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+command.
+</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.
+<div class="node">
<a name="ntpdc-numeric"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-peers">ntpdc peers</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-listpeers">ntpdc listpeers</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="numeric-option-_0028_002dn_0029"></a>
-<h4 class="subsection">1.1.7 numeric option (-n)</h4>
-<a name="index-ntpdc_002dnumeric"></a>
-<p>This is the “numeric host addresses” option.
+<h4 class="subsection">numeric option (-n)</h4>
+
+<p><a name="index-ntpdc_002dnumeric-9"></a>
+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>
+<div class="node">
<a name="ntpdc-peers"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-showpeers">ntpdc showpeers</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-numeric">ntpdc numeric</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="peers-option-_0028_002dp_0029"></a>
-<h4 class="subsection">1.1.8 peers option (-p)</h4>
-<a name="index-ntpdc_002dpeers"></a>
-
-<p>This is the “print a list of the peers” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">peers option (-p)</h4>
+
+<p><a name="index-ntpdc_002dpeers-10"></a>
+This is the “print a list of the peers” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+command.
+</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.
+<div class="node">
<a name="ntpdc-showpeers"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpdc-config" accesskey="n" rel="next">ntpdc config</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-config">ntpdc config</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-peers">ntpdc peers</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="showpeers-option-_0028_002ds_0029"></a>
-<h4 class="subsection">1.1.9 showpeers option (-s)</h4>
-<a name="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:
-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>
+
+<h4 class="subsection">showpeers option (-s)</h4>
+
+<p><a name="index-ntpdc_002dshowpeers-11"></a>
+This is the “show a list of the peers” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must not appear in combination with any of the following options:
+command.
+</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.
+
+<div class="node">
<a name="ntpdc-config"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpdc-exit-status" accesskey="n" rel="next">ntpdc exit status</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-exit-status">ntpdc exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-showpeers">ntpdc showpeers</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="presetting_002fconfiguring-ntpdc"></a>
-<h4 class="subsection">1.1.10 presetting/configuring ntpdc</h4>
+
+<h4 class="subsection">presetting/configuring ntpdc</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
-the options listed above in upper case and segmented with underscores.
+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
+the options listed above in upper case and segmented with underscores.
The <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
-</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>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
+
+<p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
+ <ul>
+<li>$HOME
+<li>$PWD
+</ul>
+ The environment variables <code>HOME</code>, and <code>PWD</code>
+are expanded and replaced when <samp><span class="file">ntpdc</span></samp> runs.
+For any of these that are plain files, they are simply processed.
+For any that are directories, then a file named <samp><span class="file">.ntprc</span></samp> is searched for
within that directory and processed.
-</p>
-<p>Configuration files may be in a wide variety of formats.
+
+ <p>Configuration files may be in a wide variety of formats.
The basic format is an option name followed by a value (argument) on the
same line. Values may be separated from the option name with a colon,
equal sign or simply white space. Values may be continued across multiple
lines by escaping the newline with a backslash.
-</p>
-<p>Multiple programs may also share the same initialization file.
+
+ <p>Multiple programs may also share the same initialization file.
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></div>
-<p>or by
-</p><div class="example">
-<pre class="example"><?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
+<pre class="example"> [NTPDC]
+</pre>
+ <p class="noindent">or by
+<pre class="example"> <?program ntpdc>
+</pre>
+ <p class="noindent">Do not mix these styles within one configuration file.
+
+ <p>Compound values and carefully constructed string values may also be
specified using XML syntax:
-</p><div class="example">
-<pre class="example"><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><div class="example">
-<pre class="example">"...<...>..."
-</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
+<pre class="example"> <option-name>
+ <sub-opt>...&lt;...&gt;...</sub-opt>
+ </option-name>
+</pre>
+ <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
+<pre class="example"> "...<...>..."
+</pre>
+ <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
the associated name/value pair list (see: optionFindValue).
-</p>
-<p>The command line options relating to configuration and/or usage help are:
-</p>
-<a name="version-_0028_002d_0029"></a>
-<h4 class="subsubheading">version (-)</h4>
+
+ <p>The command line options relating to configuration and/or usage help are:
+
+<h5 class="subsubheading">version (-)</h5>
<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 infomation may be selected with an option argument.
+detail to provide. The default is to print just the version. The licensing infomation 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>
-<dd><p>Only print the version. This is the default.
-</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
-<dd><p>Name the copyright usage licensing terms.
-</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
-<dd><p>Print the full copyright usage licensing terms.
-</p></dd>
+
+ <dl>
+<dt>‘<samp><span class="samp">version</span></samp>’<dd>Only print the version. This is the default.
+<br><dt>‘<samp><span class="samp">copyright</span></samp>’<dd>Name the copyright usage licensing terms.
+<br><dt>‘<samp><span class="samp">verbose</span></samp>’<dd>Print the full copyright usage licensing terms.
</dl>
-<hr>
+<div class="node">
<a name="ntpdc-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-Usage">ntpdc Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-config">ntpdc config</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-exit-status-1"></a>
-<h4 class="subsection">1.1.11 ntpdc exit status</h4>
+
+<h4 class="subsection">ntpdc exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<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>
-<dd><p>A specified configuration file could not be loaded.
-</p></dd>
-<dt>‘<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>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
+<br><dt>‘<samp><span class="samp">66 (EX_NOINPUT)</span></samp>’<dd>A specified configuration file could not be loaded.
+<br><dt>‘<samp><span class="samp">70 (EX_SOFTWARE)</span></samp>’<dd>libopts had an internal operational error. Please report
+it to autogen-users@lists.sourceforge.net. Thank you.
</dl>
-<hr>
+ <div class="node">
<a name="ntpdc-Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-See-Also">ntpdc See Also</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-exit-status">ntpdc exit status</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-Usage-1"></a>
-<h4 class="subsection">1.1.12 ntpdc Usage</h4>
-<hr>
+
+<h4 class="subsection">ntpdc Usage</h4>
+
+<div class="node">
<a name="ntpdc-See-Also"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-Authors">ntpdc Authors</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-Usage">ntpdc Usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-See-Also-1"></a>
-<h4 class="subsection">1.1.13 ntpdc See Also</h4>
-<hr>
+
+<h4 class="subsection">ntpdc See Also</h4>
+
+<div class="node">
<a name="ntpdc-Authors"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpdc-Bugs">ntpdc Bugs</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-See-Also">ntpdc See Also</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-Authors-1"></a>
-<h4 class="subsection">1.1.14 ntpdc Authors</h4>
-<hr>
+
+<h4 class="subsection">ntpdc Authors</h4>
+
+<div class="node">
<a name="ntpdc-Bugs"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntpdc-Authors">ntpdc Authors</a>,
+Up: <a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
+
</div>
-<a name="ntpdc-Bugs-1"></a>
-<h4 class="subsection">1.1.15 ntpdc Bugs</h4>
-<hr>
+<h4 class="subsection">ntpdc Bugs</h4>
+
+<div class="node">
<a name="Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Usage-1"></a>
-<h3 class="section">1.2 Usage</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</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.
+check the current time, offset, and error in the local clock.
For example:
-</p>
-<div class="example">
-<pre class="example">ntpdc ntpserver.somewhere
-</pre></div>
-<p>With suitable privilege, it can be run as a command or in a
+<pre class="example"> ntpdc ntpserver.somewhere
+</pre>
+ <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.
+the <code>ntpdate</code> and <code>rdate</code> commands.
For example:
-</p>
-<div class="example">
-<pre class="example">ntpdc -a ntpserver.somewhere
-</pre></div>
-<hr>
-
+<pre class="example"> ntpdc -a ntpserver.somewhere
+</pre>
+ </body></html>
-</body>
-</html>
#
# EDIT THIS FILE WITH CAUTION (invoke-ntpq.texi)
#
-# It has been AutoGen-ed January 2, 2017 at 12:05:22 PM by AutoGen 5.18.5
+# It has been AutoGen-ed March 19, 2017 at 10:10:33 AM by AutoGen 5.18.5
# From the definitions ntpq-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
The
@code{ntpq}
-utility program is used to query NTP servers which
-implement the standard NTP mode 6 control message formats defined
-in Appendix B of the NTPv3 specification RFC1305, requesting
+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.
-The same formats are used in NTPv4, although some of the
-variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
command line arguments.
Requests to read and write arbitrary
the remote host is not heard from within a suitable timeout
time.
+Note that in contexts where a host name is expected, a
+@code{-4}
+qualifier preceding the host name forces resolution to the IPv4
+namespace, while a
+@code{-6}
+qualifier forces resolution to the IPv6 namespace.
+For examples and usage, see the
+@quotedblleft{}NTP Debugging Techniques@quotedblright{}
+page.
+
Specifying a
command line option other than
@code{-i}
@code{ntpq}
will attempt to read
interactive format commands from the standard input.
+
@subsubsection Internal Commands
+
Interactive format commands consist of a keyword followed by zero
to four arguments.
Only enough characters of the full keyword to
number of interactive format commands are executed entirely within
the
@code{ntpq}
-utility itself and do not result in NTP mode 6
+utility itself and do not result in NTP
requests being sent to a server.
These are described following.
@table @asis
-@item @code{?} @code{[@kbd{command_keyword}]}
-@item @code{help} @code{[@kbd{command_keyword}]}
+@item @code{?} @code{[@kbd{command}]}
+@item @code{help} @code{[@kbd{command}]}
A
@quoteleft{}?@quoteright{}
-by itself will print a list of all the command
-keywords known to this incarnation of
+by itself will print a list of all the commands
+known to
@code{ntpq}
A
@quoteleft{}?@quoteright{}
-followed by a command keyword will print function and usage
+followed by a command name will print function and usage
information about the command.
-This command is probably a better
-source of information about
-@code{ntpq}
-than this manual
-page.
-@item @code{addvars} @kbd{variable_name}@code{[@code{=value}]} @code{...}
-@item @code{rmvars} @kbd{variable_name} @code{...}
+@item @code{addvars} @kbd{name}@code{[=@kbd{value}@code{[,...]}
+@item @code{rmvars} @kbd{name}@code{[,...]}
@item @code{clearvars}
@item @code{showvars}
-The data carried by NTP mode 6 messages consists of a list of
+The arguments to this command consist of a list of
items of the form
-@quoteleft{}variable_name=value@quoteright{},
+@kbd{name}@code{[=@kbd{value}]},
where the
-@quoteleft{}=value@quoteright{}
+.No = Ns Ar value
is ignored, and can be omitted,
in requests to the server to read variables.
The
@code{ntpq}
-utility maintains an internal list in which data to be included in control
-messages can be assembled, and sent using the
+utility maintains an internal list in which data to be included in
+messages can be assembled, and displayed or set using the
@code{readlist}
and
@code{writelist}
@code{rmvars}
command can be used to remove individual variables from the list,
while the
-@code{clearlist}
+@code{clearvars}
command removes all variables from the
list.
The
@code{showvars}
command displays the current list of optional variables.
-@item @code{authenticate} @code{[yes | no]}
+@item @code{authenticate} @code{[@code{yes}|@code{no}]}
Normally
@code{ntpq}
does not authenticate requests unless
they are write requests.
The command
-@quoteleft{}authenticate yes@quoteright{}
+@code{authenticate} @code{yes}
causes
@code{ntpq}
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
-requests slightly differently, and can occasionally melt the CPU in
-fuzzballs if you turn authentication on before doing a
-@code{peer}
-display.
+requests slightly differently.
The command
-@quoteleft{}authenticate@quoteright{}
+@code{authenticate}
causes
@code{ntpq}
to display whether or not
-@code{ntpq}
-is currently autheinticating requests.
+it is currently authenticating requests.
@item @code{cooked}
Causes output from query commands to be "cooked", so that
variables which are recognized by
values reformatted for human consumption.
Variables which
@code{ntpq}
-thinks should have a decodable value but didn't are
+could not decode completely are
marked with a trailing
@quoteleft{}?@quoteright{}.
-@item @code{debug} @code{[@code{more} | @code{less} | @code{off}]}
+@item @code{debug} @code{[@code{more}|@code{less}|@code{off}]}
With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
-@item @code{delay} @kbd{milliseconds}
+Otherwise, the debugging level is changed as indicated.
+@item @code{delay} @code{[@kbd{milliseconds}]}
Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
Actually the
server does not now require timestamps in authenticated requests,
so this command may be obsolete.
+Without any arguments, displays the current delay.
+@item @code{drefid} @code{[@code{hash}|@code{ipv4}]}
+Display refids as IPv4 or hash.
+Without any arguments, displays whether refids are shown as IPv4
+addresses or hashes.
@item @code{exit}
Exit
@code{ntpq}
-@item @code{host} @kbd{hostname}
+@item @code{host} @code{[@kbd{name}]}
Set the host to which future queries will be sent.
-@kbd{hostname}
+The
+@kbd{name}
may be either a host name or a numeric address.
-@item @code{hostnames} @code{[@code{yes} | @code{no}]}
+Without any arguments, displays the current host.
+@item @code{hostnames} @code{[@code{yes}|@code{no}]}
If
@code{yes}
is specified, host names are printed in
modified using the command line
@code{-n}
switch.
-@item @code{keyid} @kbd{keyid}
+Without any arguments, displays whether host names or numeric addresses
+are shown.
+@item @code{keyid} @code{[@kbd{keyid}]}
This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
@code{controlkey}
key number the server has been configured to use for this
purpose.
-@item @code{keytype} @code{[@code{md5} | @code{OpenSSLDigestType}]}
-Specify the type of key to use for authenticating requests.
-@code{md5}
-is alway supported.
+Without any arguments, displays the current
+@kbd{keyid}.
+@item @code{keytype} @code{[@kbd{digest}]}
+Specify the digest algorithm to use for authenticating requests, with default
+@code{MD5}.
If
@code{ntpq}
-was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+was built with OpenSSL support, and OpenSSL is installed,
+@kbd{digest}
+can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-@code{keytype}
-is displayed.
-@item @code{ntpversion} @code{[@code{1} | @code{2} | @code{3} | @code{4}]}
+@code{keytype} @kbd{digest}
+algorithm used is displayed.
+@item @code{ntpversion} @code{[@code{1}|@code{2}|@code{3}|@code{4}]}
Sets the NTP version number which
@code{ntpq}
claims in
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
successful.
-@code{poll}
+@item @code{poll} @code{[@kbd{n}]} @code{[@code{verbose}]}
+Poll an NTP server in client mode
@kbd{n}
-@code{verbose}
+times.
+Poll not implemented yet.
@item @code{quit}
Exit
@code{ntpq}
The only formating/interpretation done on
the data is to transform nonascii data into a printable (but barely
understandable) form.
-@item @code{timeout} @kbd{milliseconds}
+@item @code{timeout} @code{[@kbd{milliseconds}]}
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}
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
@item @code{version}
-Print the version of the
+Display the version of the
@code{ntpq}
program.
@end table
@subsubsection Control Message Commands
-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.
+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 message to the server and expect a
+single response message.
The exceptions are the
@code{peers}
command, which sends a series of messages,
@code{mreadvar}
commands, which iterate over a range of associations.
@table @asis
+@item @code{apeers}
+Display a list of peers in the form:
+@example
+[tally]remote refid assid st t when pool reach delay offset jitter
+@end example
+where the output is just like the
+@code{peers}
+command except that the
+@code{refid}
+is displayed in hex format and the association number is also displayed.
@item @code{associations}
Display a list of mobilized associations in the form:
@example
ind assid status conf reach auth condition last_event cnt
@end example
@table @asis
-@item Sy String Ta Sy Description
+@item Sy Variable Ta Sy Description
@item @code{ind} @code{Ta} @code{index} @code{on} @code{this} @code{list}
-@item @code{assid} @code{Ta} @code{association} @code{ID}
+@item @code{assid} @code{Ta} @code{association} @code{id}
@item @code{status} @code{Ta} @code{peer} @code{status} @code{word}
-@item @code{conf} @code{Ta} @code{yes}: @code{persistent,} @code{no}: @code{ephemeral}
-@item @code{reach} @code{Ta} @code{yes}: @code{reachable,} @code{no}: @code{unreachable}
-@item @code{auth} @code{Ta} @code{ok}, @code{yes}, @code{bad} @code{and} @code{none}
-@item @code{condition} @code{Ta} @code{selection} @code{status} @code{(see} @code{the} @code{select} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
-@item @code{last_event} @code{Ta} @code{event} @code{report} @code{(see} @code{the} @code{event} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
-@item @code{cnt} @code{Ta} @code{event} @code{count} @code{(see} @code{the} @code{count} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
+@item @code{conf} @code{Ta} @code{yes}: @code{No} @code{persistent,} @code{no}: @code{No} @code{ephemeral}
+@item @code{reach} @code{Ta} @code{yes}: @code{No} @code{reachable,} @code{no}: @code{No} @code{unreachable}
+@item @code{auth} @code{Ta} @code{ok}, @code{yes}, @code{bad} @code{No} @code{and} @code{none}
+@item @code{condition} @code{Ta} @code{selection} @code{status} @code{(see} @code{the} @code{select} @code{No} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
+@item @code{last_event} @code{Ta} @code{event} @code{report} @code{(see} @code{the} @code{event} @code{No} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
+@item @code{cnt} @code{Ta} @code{event} @code{count} @code{(see} @code{the} @code{count} @code{No} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
@end table
@item @code{authinfo}
-Display the authentication statistics.
-@item @code{clockvar} @kbd{assocID} @code{[@kbd{name}@code{[@code{=}@kbd{value}]}]} @code{[...]}
-@item @code{cv} @kbd{assocID} @code{[@kbd{name}@code{[@code{=}@kbd{value}]}]} @code{[...]}
-Display a list of clock variables for those associations supporting a reference clock.
-@item @code{:config} @code{[...]}
-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.
+Display the authentication statistics counters:
+time since reset, stored keys, free keys, key lookups, keys not found,
+uncached keys, expired keys, encryptions, decryptions.
+@item @code{clocklist} @code{[@kbd{associd}]}
+@item @code{cl} @code{[@kbd{associd}]}
+Display all clock variables in the variable list for those associations
+supporting a reference clock.
+@item @code{clockvar} @code{[@kbd{associd}]} @code{[@kbd{name}@code{[=@kbd{value}]}]}@code{[,...]}
+@item @code{cv} @code{[@kbd{associd}]} @code{[@kbd{name}@code{[=@kbd{value}]}]}@code{[,...]}
+Display a list of clock variables for those associations supporting a
+reference clock.
+@item @code{:config} @kbd{configuration command line}
+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.
@item @code{config-from-file} @kbd{filename}
-Send the each line of
+Send each line of
@kbd{filename}
-to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+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.
@item @code{ifstats}
-Display statistics for each local network address. Authentication is required.
+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.
@item @code{iostats}
-Display network and reference clock I/O statistics.
+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.
@item @code{kerninfo}
-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.
+Display kernel loop and PPS statistics:
+associd, status, pll offset, pll frequency, maximum error,
+estimated error, kernel status, pll time constant, precision,
+frequency tolerance, pps frequency, pps stability, pps jitter,
+calibration interval, calibration cycles, jitter exceeded,
+stability exceeded, calibration errors.
+As with other ntpq output, times are in milliseconds; very small values
+may be shown as exponentials.
+The precision value displayed is in milliseconds as well, unlike the
+precision system variable.
@item @code{lassociations}
-Perform the same function as the associations command, except display mobilized and unmobilized associations.
-@item @code{lopeers} @code{[@code{-4} | @code{-6}]}
-Obtain and print a list of all peers and clients showing
-@kbd{dstadr}
-(associated with any given IP version).
-@item @code{lpeers} @code{[@code{-4} | @code{-6}]}
-Print a peer spreadsheet for the appropriate IP version(s).
-@kbd{dstadr}
-(associated with any given IP version).
+Perform the same function as the associations command, except display
+mobilized and unmobilized associations, including all clients.
+@item @code{lopeers} @code{[@code{-4}|@code{-6}]}
+Display a list of all peers and clients showing
+@code{dstadr}
+(associated with the given IP version).
+@item @code{lpassociations}
+Display the last obtained list of associations, including all clients.
+@item @code{lpeers} @code{[@code{-4}|@code{-6}]}
+Display a list of all peers and clients (associated with the given IP version).
@item @code{monstats}
-Display monitor facility statistics.
-@item @code{mrulist} @code{[@code{limited} | @code{kod} | @code{mincount}=@kbd{count} | @code{laddr}=@kbd{localaddr} | @code{sort}=@kbd{sortorder} | @code{resany}=@kbd{hexmask} | @code{resall}=@kbd{hexmask}]}
-Obtain and print traffic counts collected and maintained by the monitor facility.
+Display monitor facility status, statistics, and limits:
+enabled, addresses, peak addresses, maximum addresses,
+reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
+@item @code{mreadlist} @kbd{associdlo} @kbd{associdhi}
+@item @code{mrl} @kbd{associdlo} @kbd{associdhi}
+Perform the same function as the
+@code{readlist}
+command for a range of association ids.
+@item @code{mreadvar} @kbd{associdlo} @kbd{associdhi} @code{[@kbd{name}]}@code{[,...]}
+This range may be determined from the list displayed by any
+command showing associations.
+@item @code{mrv} @kbd{associdlo} @kbd{associdhi} @code{[@kbd{name}]}@code{[,...]}
+Perform the same function as the
+@code{readvar}
+command for a range of association ids.
+This range may be determined from the list displayed by any
+command showing associations.
+@item @code{mrulist} @code{[@code{limited} | @code{kod} | @code{mincount}=@kbd{count} | @code{laddr}=@kbd{localaddr} | @code{sort}=@code{[-]}@kbd{sortorder} | @code{resany}=@kbd{hexmask} | @code{resall}=@kbd{hexmask}]}
+Display traffic counts of the most recently seen source addresses
+collected and maintained by the monitor facility.
With the exception of
-@code{sort}=@kbd{sortorder},
+@code{sort}=@code{[-]}@kbd{sortorder},
the options filter the list returned by
-@code{ntpd.}
+@code{ntpd(8)}.
The
@code{limited}
and
@code{kod}
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+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}
option filters entries representing less than
@kbd{sortorder}
defaults to
@code{lstint}
-and may be any of
+and may be
@code{addr},
-@code{count},
@code{avgint},
+@code{count},
@code{lstint},
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by
+@quoteleft{}-@quoteright{}
+to reverse the sort order.
The output columns are:
@table @asis
@item Column
Description
@item @code{lstint}
-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
+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}
@item @code{avgint}
Average interval in s between packets from this address.
Restriction flags associated with this address.
Most are copied unchanged from the matching
@code{restrict}
-command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
+the last packet from this address triggered a rate control response.
@item @code{r}
Rate control indicator, either
a period,
@item @code{rport}
Source port of last packet from this address.
@item @code{remote} @code{address}
-DNS name, numeric address, or address followed by
+host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
@end table
-@item @code{mreadvar} @code{assocID} @code{assocID} @code{[@kbd{variable_name}@code{[=@kbd{value}]} ...]}
-@item @code{mrv} @code{assocID} @code{assocID} @code{[@kbd{variable_name}@code{[=@kbd{value}]} ...]}
-Perform the same function as the
-@code{readvar}
-command, except for a range of association IDs.
-This range is determined from the association list cached by the most recent
-@code{associations}
-command.
@item @code{opeers} @code{[@code{-4} | @code{-6}]}
Obtain and print the old-style list of all peers and clients showing
-@kbd{dstadr}
-(associated with any given IP version),
+@code{dstadr}
+(associated with the given IP version),
rather than the
-@kbd{refid}.
+@code{refid}.
@item @code{passociations}
Perform the same function as the
@code{associations}
.Lk decode.html#peer "peer status word"
@item @code{remote}
host name (or IP number) of peer.
-The value displayed will be truncated to 15 characters unless the
+The value displayed will be truncated to 15 characters unless the
+@code{ntpq}
@code{-w}
-flag is given, in which case the full value will be displayed
-on the first line,
-and the remaining data is displayed on the next line.
+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.
@item @code{refid}
-association ID or
+source IP address or
.Lk decode.html#kiss "'kiss code"
@item @code{st}
-stratum
+stratum: 0 for local reference clocks, 1 for servers with local
+reference clocks, ..., 16 for unsynchronized server clocks
@item @code{t}
@code{u}:
unicast or manycast client,
@code{M}:
multicast server
@item @code{when}
-sec/min/hr since last received packet
+time in seconds, minutes, hours, or days since the last packet
+was received, or
+@quoteleft{}-@quoteright{}
+if a packet has never been received
@item @code{poll}
-poll interval (log2 s)
+poll interval (s)
@item @code{reach}
reach shift register (octal)
@item @code{delay}
@item @code{offset}
offset of server relative to this host
@item @code{jitter}
-jitter
+offset RMS error estimate.
@end table
-@item @code{apeers}
-Display a list of peers in the form:
-@example
-[tally]remote refid assid st t when pool reach delay offset jitter
-@end example
-where the output is just like the
-@code{peers}
-command except that the
-@code{refid}
-is displayed in hex format and the association number is also displayed.
-@item @code{pstats} @kbd{assocID}
-Show the statistics for the peer with the given
-@kbd{assocID}.
-@item @code{readlist} @kbd{assocID}
-@item @code{rl} @kbd{assocID}
-Read the system or peer variables included in the variable list.
-@item @code{readvar} @kbd{assocID} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}
-@item @code{rv} @kbd{assocID} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}
-Display the specified variables.
+@item @code{pstats} @kbd{associd}
+Display the statistics for the peer with the given
+@kbd{associd}:
+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.
+@item @code{readlist} @code{[@kbd{associd}]}
+@item @code{rl} @code{[@kbd{associd}]}
+Display all system or peer variables.
+If the
+@kbd{associd}
+is omitted, it is assumed to be zero.
+@item @code{readvar} @code{[@kbd{associd} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}]}
+@item @code{rv} @code{[@kbd{associd} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}]}
+Display the specified system or peer variables.
If
-@kbd{assocID}
+@kbd{associd}
is zero, the variables are from the
@ref{System Variables}
name space, otherwise they are from the
@ref{Peer Variables}
name space.
The
-@kbd{assocID}
+@kbd{associd}
is required, as the same name can occur in both spaces.
If no
@kbd{name}
is included, all operative variables in the name space are displayed.
-
In this case only, if the
-@kbd{assocID}
-is omitted, it is assumed zero.
+@kbd{associd}
+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
-YYYYMMDDTTTT ,
-where YYYY is the year,
-MM the month of year,
-DD the day of month and
-TTTT the time of day.
+@kbd{YYYY}@kbd{MM} @kbd{DD} @kbd{TTTT},
+where
+@kbd{YYYY}
+is the year,
+@kbd{MM}
+the month of year,
+@kbd{DD}
+the day of month and
+@kbd{TTTT}
+the time of day.
@item @code{reslist}
-Show the access control (restrict) list for
+Display the access control (restrict) list for
@code{ntpq}
-
+Authentication is required.
@item @code{saveconfig} @kbd{filename}
-Write the current configuration,
-including any runtime modifications given with
+Save the current configuration,
+including any runtime modifications made by
@code{:config}
or
@code{config-from-file},
-to the ntpd host's file
+to the NTP server host file
@kbd{filename}.
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-@code{ntpd}
+@code{ntpd(8)}
configuration file.
@kbd{filename}
can use
-@code{strftime()}
-format specifies to substitute the current date and time, for example,
-@code{q]saveconfig} @code{ntp-%Y%m%d-%H%M%S.confq]}.
+@code{date(1)}
+format specifiers to substitute the current date and time, for
+example,
+@example
+@code{saveconfig} @file{ntp-%Y%m%d-%H%M%S.conf}.
+@end example
The filename used is stored in system variable
@code{savedconfig}.
Authentication is required.
+@item @code{sysinfo}
+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.
+@item @code{sysstats}
+Display system uptime and packet counts maintained in the
+protocol module:
+uptime, sysstats reset, packets received, current version,
+older version, bad length or format, authentication failed,
+declined, restricted, rate limited, KoD responses,
+processed for time.
@item @code{timerstats}
-Display interval timer counters.
-@item @code{writelist} @kbd{assocID}
-Write the system or peer variables included in the variable list.
-@item @code{writevar} @kbd{assocID} @kbd{name}=@kbd{value} @code{[, ...]}
-Write the specified variables.
+Display interval timer counters:
+time since reset, timer overruns, calls to transmit.
+@item @code{writelist} @kbd{associd}
+Set all system or peer variables included in the variable list.
+@item @code{writevar} @kbd{associd} @kbd{name}=@kbd{value} @code{[, ...]}
+Set the specified variables in the variable list.
If the
-@kbd{assocID}
+@kbd{associd}
is zero, the variables are from the
@ref{System Variables}
name space, otherwise they are from the
@ref{Peer Variables}
name space.
The
-@kbd{assocID}
+@kbd{associd}
is required, as the same name can occur in both spaces.
-@item @code{sysinfo}
-Display operational summary.
-@item @code{sysstats}
-Print statistics counters maintained in the protocol module.
+Authentication is required.
@end table
@subsubsection Status Words and Kiss Codes
-
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 in the
-@code{rv}
+These words are displayed by the
+@code{readlist}
and
-@code{as}
+@code{associations}
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"
@subsubsection System Variables
The following system variables appear in the
-@code{rv}
+@code{readlist}
billboard.
Not all variables are displayed in some configurations.
+
@table @asis
@item Variable
Description
total roundtrip delay to the primary reference clock
@item @code{rootdisp}
total dispersion to the primary reference clock
+@item @code{refid}
+reference id or
+.Lk decode.html#kiss "kiss code"
+@item @code{reftime}
+reference time
+@item @code{clock}
+date and time of day
@item @code{peer}
-system peer association ID
+system peer association id
@item @code{tc}
time constant and poll exponent (log2 s) (3-17)
@item @code{mintc}
minimum time constant (log2 s) (3-10)
-@item @code{clock}
-date and time of day
-@item @code{refid}
-reference ID or
-.Lk decode.html#kiss "kiss code"
-@item @code{reftime}
-reference time
@item @code{offset}
-combined offset of server relative to this host
+combined offset of server relative to this host
+@item @code{frequency}
+frequency drift (PPM) relative to hardware clock
@item @code{sys_jitter}
combined system jitter
-@item @code{frequency}
-frequency offset (PPM) relative to hardware clock
@item @code{clk_wander}
clock frequency wander (PPM)
@item @code{clk_jitter}
additional system variables are displayed,
including some or all of the following,
depending on the particular Autokey dance:
-
@table @asis
@item Variable
Description
@end table
@subsubsection Peer Variables
The following peer variables appear in the
-@code{rv}
+@code{readlist}
billboard for each association.
Not all variables are displayed in some configurations.
@item Variable
Description
@item @code{associd}
-association ID
+association id
@item @code{status}
.Lk decode.html#peer "peer status word"
@item @code{srcadr}
@item @code{rootdisp}
total root dispersion to the primary reference clock
@item @code{refid}
-reference ID or
+reference id or
.Lk decode.html#kiss "kiss code"
@item @code{reftime}
reference time
+@item @code{rec}
+last packet received time
@item @code{reach}
reach register (octal)
@item @code{unreach}
.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
@item @code{flash}
.Lk decode.html#flash "flash status word"
+@item @code{keyid}
+symmetric key id
@item @code{offset}
filter offset
@item @code{delay}
filter dispersion
@item @code{jitter}
filter jitter
-@item @code{ident}
-Autokey group name for this association
@item @code{bias}
unicast/broadcast bias
@item @code{xleave}
@code{bias}
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.
+It represents the offset of the broadcast subgraph relative to the
+unicast subgraph.
The
@code{xleave}
variable appears only for the interleaved symmetric and interleaved modes.
@item @code{signature}
OpenSSL digest/signature scheme
@item @code{initsequence}
-initial key ID
+initial key id
@item @code{initkey}
initial key index
@item @code{timestamp}
Autokey signature timestamp
+@item @code{ident}
+Autokey group name for this association
@end table
@subsubsection Clock Variables
The following clock variables appear in the
-@code{cv}
+@code{clocklist}
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
@table @asis
@item Variable
Description
@item @code{associd}
-association ID
+association id
@item @code{status}
.Lk decode.html#clock "clock status word"
@item @code{device}
@item @code{stratum}
driver stratum
@item @code{refid}
-driver reference ID
+driver reference id
@item @code{flags}
driver flags
@end table
ntpq - standard NTP query program - Ver. 4.2.8p9
Usage: ntpq [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
Flg Arg Option-Name Description
- -4 no ipv4 Force IPv4 DNS name resolution
+ -4 no ipv4 Force IPv4 name resolution
- prohibits the option 'ipv6'
- -6 no ipv6 Force IPv6 DNS name resolution
+ -6 no ipv6 Force IPv6 name resolution
- prohibits the option 'ipv4'
-c Str command run a command and exit
- may appear multiple times
@subsection ipv4 option (-4)
@cindex ntpq-ipv4
-This is the ``force ipv4 dns name resolution'' option.
+This is the ``force ipv4 name resolution'' option.
@noindent
This option has some usage constraints. It:
ipv6.
@end itemize
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv4 namespace.
@node ntpq ipv6
@subsection ipv6 option (-6)
@cindex ntpq-ipv6
-This is the ``force ipv6 dns name resolution'' option.
+This is the ``force ipv6 name resolution'' option.
@noindent
This option has some usage constraints. It:
ipv4.
@end itemize
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv6 namespace.
@node ntpq command
@subsection command option (-c)
This is the ``numeric host addresses'' option.
Output all host addresses in dotted-quad numeric format rather than
-converting to the canonical host names.
+converting to the canonical host names.
@node ntpq old-rv
@subsection old-rv option
@cindex ntpq-old-rv
/*
* EDIT THIS FILE WITH CAUTION (ntpq-opts.c)
*
- * It has been AutoGen-ed January 2, 2017 at 12:05:13 PM by AutoGen 5.18.5
+ * It has been AutoGen-ed March 19, 2017 at 10:10:23 AM by AutoGen 5.18.5
* From the definitions ntpq-opts.def
* and the template file options
*
/**
* static const strings for ntpq options
*/
-static char const ntpq_opt_strs[1982] =
+static char const ntpq_opt_strs[1974] =
/* 0 */ "ntpq 4.2.8p9\n"
"Copyright (C) 1992-2017 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
"Time Foundation makes no representations about the suitability this\n"
"software for any purpose. It is provided \"as is\" without express or\n"
"implied warranty.\n\0"
-/* 1008 */ "Force IPv4 DNS name resolution\0"
-/* 1039 */ "IPV4\0"
-/* 1044 */ "ipv4\0"
-/* 1049 */ "Force IPv6 DNS name resolution\0"
-/* 1080 */ "IPV6\0"
-/* 1085 */ "ipv6\0"
-/* 1090 */ "run a command and exit\0"
-/* 1113 */ "COMMAND\0"
-/* 1121 */ "command\0"
-/* 1129 */ "Increase debug verbosity level\0"
-/* 1160 */ "DEBUG_LEVEL\0"
-/* 1172 */ "debug-level\0"
-/* 1184 */ "Set the debug verbosity level\0"
-/* 1214 */ "SET_DEBUG_LEVEL\0"
-/* 1230 */ "set-debug-level\0"
-/* 1246 */ "Force ntpq to operate in interactive mode\0"
-/* 1288 */ "INTERACTIVE\0"
-/* 1300 */ "interactive\0"
-/* 1312 */ "numeric host addresses\0"
-/* 1335 */ "NUMERIC\0"
-/* 1343 */ "numeric\0"
-/* 1351 */ "Always output status line with readvar\0"
-/* 1390 */ "OLD_RV\0"
-/* 1397 */ "old-rv\0"
-/* 1404 */ "Print a list of the peers\0"
-/* 1430 */ "PEERS\0"
-/* 1436 */ "peers\0"
-/* 1442 */ "Set default display type for S2+ refids\0"
-/* 1482 */ "REFID\0"
-/* 1488 */ "refid\0"
-/* 1494 */ "Display the full 'remote' value\0"
-/* 1526 */ "WIDE\0"
-/* 1531 */ "wide\0"
-/* 1536 */ "display extended usage information and exit\0"
-/* 1580 */ "help\0"
-/* 1585 */ "extended usage information passed thru pager\0"
-/* 1630 */ "more-help\0"
-/* 1640 */ "output version information and exit\0"
-/* 1676 */ "version\0"
-/* 1684 */ "save the option state to a config file\0"
-/* 1723 */ "save-opts\0"
-/* 1733 */ "load options from a config file\0"
-/* 1765 */ "LOAD_OPTS\0"
-/* 1775 */ "no-load-opts\0"
-/* 1788 */ "no\0"
-/* 1791 */ "NTPQ\0"
-/* 1796 */ "ntpq - standard NTP query program - Ver. 4.2.8p9\n"
+/* 1008 */ "Force IPv4 name resolution\0"
+/* 1035 */ "IPV4\0"
+/* 1040 */ "ipv4\0"
+/* 1045 */ "Force IPv6 name resolution\0"
+/* 1072 */ "IPV6\0"
+/* 1077 */ "ipv6\0"
+/* 1082 */ "run a command and exit\0"
+/* 1105 */ "COMMAND\0"
+/* 1113 */ "command\0"
+/* 1121 */ "Increase debug verbosity level\0"
+/* 1152 */ "DEBUG_LEVEL\0"
+/* 1164 */ "debug-level\0"
+/* 1176 */ "Set the debug verbosity level\0"
+/* 1206 */ "SET_DEBUG_LEVEL\0"
+/* 1222 */ "set-debug-level\0"
+/* 1238 */ "Force ntpq to operate in interactive mode\0"
+/* 1280 */ "INTERACTIVE\0"
+/* 1292 */ "interactive\0"
+/* 1304 */ "numeric host addresses\0"
+/* 1327 */ "NUMERIC\0"
+/* 1335 */ "numeric\0"
+/* 1343 */ "Always output status line with readvar\0"
+/* 1382 */ "OLD_RV\0"
+/* 1389 */ "old-rv\0"
+/* 1396 */ "Print a list of the peers\0"
+/* 1422 */ "PEERS\0"
+/* 1428 */ "peers\0"
+/* 1434 */ "Set default display type for S2+ refids\0"
+/* 1474 */ "REFID\0"
+/* 1480 */ "refid\0"
+/* 1486 */ "Display the full 'remote' value\0"
+/* 1518 */ "WIDE\0"
+/* 1523 */ "wide\0"
+/* 1528 */ "display extended usage information and exit\0"
+/* 1572 */ "help\0"
+/* 1577 */ "extended usage information passed thru pager\0"
+/* 1622 */ "more-help\0"
+/* 1632 */ "output version information and exit\0"
+/* 1668 */ "version\0"
+/* 1676 */ "save the option state to a config file\0"
+/* 1715 */ "save-opts\0"
+/* 1725 */ "load options from a config file\0"
+/* 1757 */ "LOAD_OPTS\0"
+/* 1767 */ "no-load-opts\0"
+/* 1780 */ "no\0"
+/* 1783 */ "NTPQ\0"
+/* 1788 */ "ntpq - standard NTP query program - Ver. 4.2.8p9\n"
"Usage: %s [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]\n\0"
-/* 1915 */ "$HOME\0"
-/* 1921 */ ".\0"
-/* 1923 */ ".ntprc\0"
-/* 1930 */ "http://bugs.ntp.org, bugs@ntp.org\0"
-/* 1964 */ "ntpq 4.2.8p9\0"
-/* 1977 */ "hash";
+/* 1907 */ "$HOME\0"
+/* 1913 */ ".\0"
+/* 1915 */ ".ntprc\0"
+/* 1922 */ "http://bugs.ntp.org, bugs@ntp.org\0"
+/* 1956 */ "ntpq 4.2.8p9\0"
+/* 1969 */ "hash";
/**
* ipv4 option description with
/** Descriptive text for the ipv4 option */
#define IPV4_DESC (ntpq_opt_strs+1008)
/** Upper-cased name for the ipv4 option */
-#define IPV4_NAME (ntpq_opt_strs+1039)
+#define IPV4_NAME (ntpq_opt_strs+1035)
/** Name string for the ipv4 option */
-#define IPV4_name (ntpq_opt_strs+1044)
+#define IPV4_name (ntpq_opt_strs+1040)
/** Other options that appear in conjunction with the ipv4 option */
static int const aIpv4CantList[] = {
INDEX_OPT_IPV6, NO_EQUIVALENT };
* "Must also have options" and "Incompatible options":
*/
/** Descriptive text for the ipv6 option */
-#define IPV6_DESC (ntpq_opt_strs+1049)
+#define IPV6_DESC (ntpq_opt_strs+1045)
/** Upper-cased name for the ipv6 option */
-#define IPV6_NAME (ntpq_opt_strs+1080)
+#define IPV6_NAME (ntpq_opt_strs+1072)
/** Name string for the ipv6 option */
-#define IPV6_name (ntpq_opt_strs+1085)
+#define IPV6_name (ntpq_opt_strs+1077)
/** Other options that appear in conjunction with the ipv6 option */
static int const aIpv6CantList[] = {
INDEX_OPT_IPV4, NO_EQUIVALENT };
* command option description:
*/
/** Descriptive text for the command option */
-#define COMMAND_DESC (ntpq_opt_strs+1090)
+#define COMMAND_DESC (ntpq_opt_strs+1082)
/** Upper-cased name for the command option */
-#define COMMAND_NAME (ntpq_opt_strs+1113)
+#define COMMAND_NAME (ntpq_opt_strs+1105)
/** Name string for the command option */
-#define COMMAND_name (ntpq_opt_strs+1121)
+#define COMMAND_name (ntpq_opt_strs+1113)
/** Compiled in flag settings for the command option */
#define COMMAND_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
* debug-level option description:
*/
/** Descriptive text for the debug-level option */
-#define DEBUG_LEVEL_DESC (ntpq_opt_strs+1129)
+#define DEBUG_LEVEL_DESC (ntpq_opt_strs+1121)
/** Upper-cased name for the debug-level option */
-#define DEBUG_LEVEL_NAME (ntpq_opt_strs+1160)
+#define DEBUG_LEVEL_NAME (ntpq_opt_strs+1152)
/** Name string for the debug-level option */
-#define DEBUG_LEVEL_name (ntpq_opt_strs+1172)
+#define DEBUG_LEVEL_name (ntpq_opt_strs+1164)
/** Compiled in flag settings for the debug-level option */
#define DEBUG_LEVEL_FLAGS (OPTST_DISABLED)
* set-debug-level option description:
*/
/** Descriptive text for the set-debug-level option */
-#define SET_DEBUG_LEVEL_DESC (ntpq_opt_strs+1184)
+#define SET_DEBUG_LEVEL_DESC (ntpq_opt_strs+1176)
/** Upper-cased name for the set-debug-level option */
-#define SET_DEBUG_LEVEL_NAME (ntpq_opt_strs+1214)
+#define SET_DEBUG_LEVEL_NAME (ntpq_opt_strs+1206)
/** Name string for the set-debug-level option */
-#define SET_DEBUG_LEVEL_name (ntpq_opt_strs+1230)
+#define SET_DEBUG_LEVEL_name (ntpq_opt_strs+1222)
/** Compiled in flag settings for the set-debug-level option */
#define SET_DEBUG_LEVEL_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_NUMERIC))
* "Must also have options" and "Incompatible options":
*/
/** Descriptive text for the interactive option */
-#define INTERACTIVE_DESC (ntpq_opt_strs+1246)
+#define INTERACTIVE_DESC (ntpq_opt_strs+1238)
/** Upper-cased name for the interactive option */
-#define INTERACTIVE_NAME (ntpq_opt_strs+1288)
+#define INTERACTIVE_NAME (ntpq_opt_strs+1280)
/** Name string for the interactive option */
-#define INTERACTIVE_name (ntpq_opt_strs+1300)
+#define INTERACTIVE_name (ntpq_opt_strs+1292)
/** Other options that appear in conjunction with the interactive option */
static int const aInteractiveCantList[] = {
INDEX_OPT_COMMAND,
* numeric option description:
*/
/** Descriptive text for the numeric option */
-#define NUMERIC_DESC (ntpq_opt_strs+1312)
+#define NUMERIC_DESC (ntpq_opt_strs+1304)
/** Upper-cased name for the numeric option */
-#define NUMERIC_NAME (ntpq_opt_strs+1335)
+#define NUMERIC_NAME (ntpq_opt_strs+1327)
/** Name string for the numeric option */
-#define NUMERIC_name (ntpq_opt_strs+1343)
+#define NUMERIC_name (ntpq_opt_strs+1335)
/** Compiled in flag settings for the numeric option */
#define NUMERIC_FLAGS (OPTST_DISABLED)
* old-rv option description:
*/
/** Descriptive text for the old-rv option */
-#define OLD_RV_DESC (ntpq_opt_strs+1351)
+#define OLD_RV_DESC (ntpq_opt_strs+1343)
/** Upper-cased name for the old-rv option */
-#define OLD_RV_NAME (ntpq_opt_strs+1390)
+#define OLD_RV_NAME (ntpq_opt_strs+1382)
/** Name string for the old-rv option */
-#define OLD_RV_name (ntpq_opt_strs+1397)
+#define OLD_RV_name (ntpq_opt_strs+1389)
/** Compiled in flag settings for the old-rv option */
#define OLD_RV_FLAGS (OPTST_DISABLED)
* "Must also have options" and "Incompatible options":
*/
/** Descriptive text for the peers option */
-#define PEERS_DESC (ntpq_opt_strs+1404)
+#define PEERS_DESC (ntpq_opt_strs+1396)
/** Upper-cased name for the peers option */
-#define PEERS_NAME (ntpq_opt_strs+1430)
+#define PEERS_NAME (ntpq_opt_strs+1422)
/** Name string for the peers option */
-#define PEERS_name (ntpq_opt_strs+1436)
+#define PEERS_name (ntpq_opt_strs+1428)
/** Other options that appear in conjunction with the peers option */
static int const aPeersCantList[] = {
INDEX_OPT_INTERACTIVE, NO_EQUIVALENT };
* refid option description:
*/
/** Descriptive text for the refid option */
-#define REFID_DESC (ntpq_opt_strs+1442)
+#define REFID_DESC (ntpq_opt_strs+1434)
/** Upper-cased name for the refid option */
-#define REFID_NAME (ntpq_opt_strs+1482)
+#define REFID_NAME (ntpq_opt_strs+1474)
/** Name string for the refid option */
-#define REFID_name (ntpq_opt_strs+1488)
+#define REFID_name (ntpq_opt_strs+1480)
/** The compiled in default value for the refid option argument */
#define REFID_DFT_ARG ((char const*)REFID_IPV4)
/** Compiled in flag settings for the refid option */
* wide option description:
*/
/** Descriptive text for the wide option */
-#define WIDE_DESC (ntpq_opt_strs+1494)
+#define WIDE_DESC (ntpq_opt_strs+1486)
/** Upper-cased name for the wide option */
-#define WIDE_NAME (ntpq_opt_strs+1526)
+#define WIDE_NAME (ntpq_opt_strs+1518)
/** Name string for the wide option */
-#define WIDE_name (ntpq_opt_strs+1531)
+#define WIDE_name (ntpq_opt_strs+1523)
/** Compiled in flag settings for the wide option */
#define WIDE_FLAGS (OPTST_DISABLED)
/*
* Help/More_Help/Version option descriptions:
*/
-#define HELP_DESC (ntpq_opt_strs+1536)
-#define HELP_name (ntpq_opt_strs+1580)
+#define HELP_DESC (ntpq_opt_strs+1528)
+#define HELP_name (ntpq_opt_strs+1572)
#ifdef HAVE_WORKING_FORK
-#define MORE_HELP_DESC (ntpq_opt_strs+1585)
-#define MORE_HELP_name (ntpq_opt_strs+1630)
+#define MORE_HELP_DESC (ntpq_opt_strs+1577)
+#define MORE_HELP_name (ntpq_opt_strs+1622)
#define MORE_HELP_FLAGS (OPTST_IMM | OPTST_NO_INIT)
#else
#define MORE_HELP_DESC HELP_DESC
# define VER_FLAGS (OPTST_SET_ARGTYPE(OPARG_TYPE_STRING) | \
OPTST_ARG_OPTIONAL | OPTST_IMM | OPTST_NO_INIT)
#endif
-#define VER_DESC (ntpq_opt_strs+1640)
-#define VER_name (ntpq_opt_strs+1676)
-#define SAVE_OPTS_DESC (ntpq_opt_strs+1684)
-#define SAVE_OPTS_name (ntpq_opt_strs+1723)
-#define LOAD_OPTS_DESC (ntpq_opt_strs+1733)
-#define LOAD_OPTS_NAME (ntpq_opt_strs+1765)
-#define NO_LOAD_OPTS_name (ntpq_opt_strs+1775)
-#define LOAD_OPTS_pfx (ntpq_opt_strs+1788)
+#define VER_DESC (ntpq_opt_strs+1632)
+#define VER_name (ntpq_opt_strs+1668)
+#define SAVE_OPTS_DESC (ntpq_opt_strs+1676)
+#define SAVE_OPTS_name (ntpq_opt_strs+1715)
+#define LOAD_OPTS_DESC (ntpq_opt_strs+1725)
+#define LOAD_OPTS_NAME (ntpq_opt_strs+1757)
+#define NO_LOAD_OPTS_name (ntpq_opt_strs+1767)
+#define LOAD_OPTS_pfx (ntpq_opt_strs+1780)
#define LOAD_OPTS_name (NO_LOAD_OPTS_name + 3)
/**
* Declare option callback procedures
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/** Reference to the upper cased version of ntpq. */
-#define zPROGNAME (ntpq_opt_strs+1791)
+#define zPROGNAME (ntpq_opt_strs+1783)
/** Reference to the title line for ntpq usage. */
-#define zUsageTitle (ntpq_opt_strs+1796)
+#define zUsageTitle (ntpq_opt_strs+1788)
/** ntpq configuration file name. */
-#define zRcName (ntpq_opt_strs+1923)
+#define zRcName (ntpq_opt_strs+1915)
/** Directories to search for ntpq config files. */
static char const * const apzHomeList[3] = {
- ntpq_opt_strs+1915,
- ntpq_opt_strs+1921,
+ ntpq_opt_strs+1907,
+ ntpq_opt_strs+1913,
NULL };
/** The ntpq program bug email address. */
-#define zBugsAddr (ntpq_opt_strs+1930)
+#define zBugsAddr (ntpq_opt_strs+1922)
/** Clarification/explanation of what ntpq does. */
#define zExplain (NULL)
/** Extra detail explaining what ntpq does. */
#define zDetail (NULL)
/** The full version string for ntpq. */
-#define zFullVersion (ntpq_opt_strs+1964)
+#define zFullVersion (ntpq_opt_strs+1956)
/* extracted from optcode.tlib near line 364 */
#if defined(ENABLE_NLS)
/* extracted from optmain.tlib near line 945 */
static char const * const names[2] = {
- ntpq_opt_strs+1977, ntpq_opt_strs+1044 };
+ ntpq_opt_strs+1969, ntpq_opt_strs+1040 };
if (pOptions <= OPTPROC_EMIT_LIMIT) {
(void) optionEnumerationVal(pOptions, pOptDesc, names, 2);
implied warranty.\n"));
/* referenced via ntpqOptions.pOptDesc->pzText */
- puts(_("Force IPv4 DNS name resolution"));
+ puts(_("Force IPv4 name resolution"));
/* referenced via ntpqOptions.pOptDesc->pzText */
- puts(_("Force IPv6 DNS name resolution"));
+ puts(_("Force IPv6 name resolution"));
/* referenced via ntpqOptions.pOptDesc->pzText */
puts(_("run a command and exit"));
/*
* EDIT THIS FILE WITH CAUTION (ntpq-opts.h)
*
- * It has been AutoGen-ed January 2, 2017 at 12:05:13 PM by AutoGen 5.18.5
+ * It has been AutoGen-ed March 19, 2017 at 10:10:23 AM by AutoGen 5.18.5
* From the definitions ntpq-opts.def
* and the template file options
*
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpq 1ntpqman "02 Jan 2017" "4.2.8p9" "User Commands"
+.TH ntpq 1ntpqman "19 Mar 2017" "4.2.8p9" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:23 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:34 AM by AutoGen 5.18.5
.\" From the definitions ntpq-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.ne 2
.SH DESCRIPTION
+.sp \n(Ppu
+.ne 2
+
The
\f\*[B-Font]ntpq\fP
-utility program is used to query NTP servers which
-implement the standard NTP mode 6 control message formats defined
-in Appendix B of the NTPv3 specification RFC1305, requesting
+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.
-The same formats are used in NTPv4, although some of the
-variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
command line arguments.
Requests to read and write arbitrary
utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
+.sp \n(Ppu
+.ne 2
+
If one or more request options is included on the command line
when
\f\*[B-Font]ntpq\fP
\f\*[B-Font]ntpq\fP
utility will prompt for
commands if the standard input is a terminal device.
+.sp \n(Ppu
+.ne 2
+
\f\*[B-Font]ntpq\fP
uses NTP mode 6 packets to communicate with the
NTP server, and hence can be used to query any compatible server on
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
+.sp \n(Ppu
+.ne 2
+
+Note that in contexts where a host name is expected, a
+\f\*[B-Font]\-4\f[]
+qualifier preceding the host name forces resolution to the IPv4
+namespace, while a
+\f\*[B-Font]\-6\f[]
+qualifier forces resolution to the IPv6 namespace.
+For examples and usage, see the
+\*[Lq]NTP Debugging Techniques\*[Rq]
+page.
+.sp \n(Ppu
+.ne 2
+
Specifying a
command line option other than
\f\*[B-Font]\-i\f[]
will attempt to read
interactive format commands from the standard input.
.SS "Internal Commands"
+.sp \n(Ppu
+.ne 2
+
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.
+.sp \n(Ppu
+.ne 2
+
A
number of interactive format commands are executed entirely within
the
\f\*[B-Font]ntpq\fP
-utility itself and do not result in NTP mode 6
+utility itself and do not result in NTP
requests being sent to a server.
These are described following.
-.TP 20
-.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command_keyword\f[]]
+.TP 15
+.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command\f[]]
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command_keyword\f[]]
+.TP 15
+.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command\f[]]
A
\[oq]\&?\[cq]
-by itself will print a list of all the command
-keywords known to this incarnation of
+by itself will print a list of all the commands
+known to
\f\*[B-Font]ntpq\fP.
A
\[oq]\&?\[cq]
-followed by a command keyword will print function and usage
+followed by a command name will print function and usage
information about the command.
-This command is probably a better
-source of information about
-\f\*[B-Font]ntpq\fP
-than this manual
-page.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]variable_name\f[][\f\*[B-Font]=value\f[]] \f\*[B-Font]...\f[]
+.TP 15
+.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[][,...]
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]variable_name\f[] \f\*[B-Font]...\f[]
+.TP 15
+.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]name\f[][,...]
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]clearvars\f[]
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]showvars\f[]
-The data carried by NTP mode 6 messages consists of a list of
+The arguments to this command consist of a list of
items of the form
-\[oq]variable_name=value\[cq],
+\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]],
where the
-\[oq]=value\[cq]
+.NOP \&=\f\*[I-Font]value\f[]
is ignored, and can be omitted,
in requests to the server to read variables.
The
\f\*[B-Font]ntpq\fP
-utility maintains an internal list in which data to be included in control
-messages can be assembled, and sent using the
+utility maintains an internal list in which data to be included in
+messages can be assembled, and displayed or set using the
\f\*[B-Font]readlist\f[]
and
\f\*[B-Font]writelist\f[]
\f\*[B-Font]rmvars\f[]
command can be used to remove individual variables from the list,
while the
-\f\*[B-Font]clearlist\f[]
+\f\*[B-Font]clearvars\f[]
command removes all variables from the
list.
The
command displays the current list of optional variables.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]authenticate\f[] [yes | no]
+.TP 15
+.NOP \f\*[B-Font]authenticate\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
Normally
\f\*[B-Font]ntpq\fP
does not authenticate requests unless
they are write requests.
The command
-\[oq]authenticate yes\[cq]
+\f\*[B-Font]authenticate\f[] \f\*[B-Font]yes\f[]
causes
\f\*[B-Font]ntpq\fP
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
-requests slightly differently, and can occasionally melt the CPU in
-fuzzballs if you turn authentication on before doing a
-\f\*[B-Font]peer\f[]
-display.
+requests slightly differently.
The command
-\[oq]authenticate\[cq]
+\f\*[B-Font]authenticate\f[]
causes
\f\*[B-Font]ntpq\fP
to display whether or not
-\f\*[B-Font]ntpq\fP
-is currently autheinticating requests.
+it is currently authenticating requests.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]cooked\f[]
Causes output from query commands to be "cooked", so that
variables which are recognized by
values reformatted for human consumption.
Variables which
\f\*[B-Font]ntpq\fP
-thinks should have a decodable value but didn't are
+could not decode completely are
marked with a trailing
\[oq]\&?\[cq].
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[] | \f\*[B-Font]less\f[] | \f\*[B-Font]off\f[]]
+.TP 15
+.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[]|\f\*[B-Font]less\f[]|\f\*[B-Font]off\f[]]
With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
+Otherwise, the debugging level is changed as indicated.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[]
+.TP 15
+.NOP \f\*[B-Font]delay\f[] [\f\*[I-Font]milliseconds\f[]]
Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
Actually the
server does not now require timestamps in authenticated requests,
so this command may be obsolete.
+Without any arguments, displays the current delay.
+.br
+.ns
+.TP 15
+.NOP \f\*[B-Font]drefid\f[] [\f\*[B-Font]hash\f[]|\f\*[B-Font]ipv4\f[]]
+Display refids as IPv4 or hash.
+Without any arguments, displays whether refids are shown as IPv4
+addresses or hashes.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]exit\f[]
Exit
\f\*[B-Font]ntpq\fP.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[]
+.TP 15
+.NOP \f\*[B-Font]host\f[] [\f\*[I-Font]name\f[]]
Set the host to which future queries will be sent.
-\f\*[I-Font]hostname\f[]
+The
+\f\*[I-Font]name\f[]
may be either a host name or a numeric address.
+Without any arguments, displays the current host.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]]
+.TP 15
+.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
If
\f\*[B-Font]yes\f[]
is specified, host names are printed in
modified using the command line
\f\*[B-Font]\-n\f[]
switch.
+Without any arguments, displays whether host names or numeric addresses
+are shown.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[]
+.TP 15
+.NOP \f\*[B-Font]keyid\f[] [\f\*[I-Font]keyid\f[]]
This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
\f\*[B-Font]controlkey\f[]
key number the server has been configured to use for this
purpose.
+Without any arguments, displays the current
+\f\*[I-Font]keyid\f[].
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]keytype\f[] [\f\*[B-Font]md5\f[] | \f\*[B-Font]OpenSSLDigestType\f[]]
-Specify the type of key to use for authenticating requests.
-\f\*[B-Font]md5\f[]
-is alway supported.
+.TP 15
+.NOP \f\*[B-Font]keytype\f[] [\f\*[I-Font]digest\f[]]
+Specify the digest algorithm to use for authenticating requests, with default
+\f\*[B-Font]MD5\f[].
If
\f\*[B-Font]ntpq\fP
-was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+was built with OpenSSL support, and OpenSSL is installed,
+\f\*[I-Font]digest\f[]
+can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-\f\*[B-Font]keytype\f[]
-is displayed.
+\f\*[B-Font]keytype\f[] \f\*[I-Font]digest\f[]
+algorithm used is displayed.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[] | \f\*[B-Font]2\f[] | \f\*[B-Font]3\f[] | \f\*[B-Font]4\f[]]
+.TP 15
+.NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[]|\f\*[B-Font]2\f[]|\f\*[B-Font]3\f[]|\f\*[B-Font]4\f[]]
Sets the NTP version number which
\f\*[B-Font]ntpq\fP
claims in
when communicating with servers.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]passwd\f[]
This command prompts you to type in a password (which will not
be echoed) which will be used to authenticate configuration
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
successful.
-.\" Not yet implemented.
-.\" .It Ic poll
-.\" .Op Ar n
-.\" .Op Ic verbose
-.\" Poll an NTP server in client mode
-.\" .Ar n
-.\" times.
.br
.ns
-.TP 20
+.TP 15
+.NOP \f\*[B-Font]poll\f[] [\f\*[I-Font]n\f[]] [\f\*[B-Font]verbose\f[]]
+Poll an NTP server in client mode
+\f\*[I-Font]n\f[]
+times.
+Poll not implemented yet.
+.br
+.ns
+.TP 15
.NOP \f\*[B-Font]quit\f[]
Exit
\f\*[B-Font]ntpq\fP.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]raw\f[]
Causes all output from query commands is printed as received
from the remote server.
understandable) form.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[]
+.TP 15
+.NOP \f\*[B-Font]timeout\f[] [\f\*[I-Font]milliseconds\f[]]
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
\f\*[B-Font]ntpq\fP
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]version\f[]
-Print the version of the
+Display the version of the
\f\*[B-Font]ntpq\fP
program.
.PP
.SS "Control Message Commands"
-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.
+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 message to the server and expect a
+single response message.
The exceptions are the
-\f[C]peers\f[]
+\f\*[B-Font]peers\f[]
command, which sends a series of messages,
and the
-\f[C]mreadlist\f[]
+\f\*[B-Font]mreadlist\f[]
and
-\f[C]mreadvar\f[]
+\f\*[B-Font]mreadvar\f[]
commands, which iterate over a range of associations.
.TP 10
+.NOP \f\*[B-Font]apeers\f[]
+Display a list of peers in the form:
+.Dl [tally]remote refid assid st t when pool reach delay offset jitter
+where the output is just like the
+\f\*[B-Font]peers\f[]
+command except that the
+\f\*[B-Font]refid\f[]
+is displayed in hex format and the association number is also displayed.
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]associations\f[]
Display a list of mobilized associations in the form:
.Dl ind assid status conf reach auth condition last_event cnt
.RS
.IP \fB\(bu\fP 2
-.IP \fB\(bu\fP 2 \f[C]ind\f[] \f[C]Ta\f[] \f[C]index\f[] \f[C]on\f[] \f[C]this\f[] \f[C]list\f[]
-.IP \fB\(bu\fP 2 \f[C]assid\f[] \f[C]Ta\f[] \f[C]association\f[] \f[C]ID\f[]
-.IP \fB\(bu\fP 2 \f[C]status\f[] \f[C]Ta\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word\f[]
-.IP \fB\(bu\fP 2 \f[C]conf\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]persistent,\f[] \f[C]no\f[]: \f[C]ephemeral\f[]
-.IP \fB\(bu\fP 2 \f[C]reach\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]reachable,\f[] \f[C]no\f[]: \f[C]unreachable\f[]
-.IP \fB\(bu\fP 2 \f[C]auth\f[] \f[C]Ta\f[] \f[C]ok\f[], \f[C]yes\f[], \f[C]bad\f[] \f[C]and\f[] \f[C]none\f[]
-.IP \fB\(bu\fP 2 \f[C]condition\f[] \f[C]Ta\f[] \f[C]selection\f[] \f[C]status\f[] \f[C](see\f[] \f[C]the\f[] \f[C]select\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
-.IP \fB\(bu\fP 2 \f[C]last_event\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]report\f[] \f[C](see\f[] \f[C]the\f[] \f[C]event\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
-.IP \fB\(bu\fP 2 \f[C]cnt\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]count\f[] \f[C](see\f[] \f[C]the\f[] \f[C]count\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]ind\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]index\f[] \f\*[B-Font]on\f[] \f\*[B-Font]this\f[] \f\*[B-Font]list\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]assid\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]association\f[] \f\*[B-Font]id\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]status\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]conf\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]persistent,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]ephemeral\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]reach\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]reachable,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]unreachable\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]auth\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]ok\f[], \f\*[B-Font]yes\f[], \f\*[B-Font]bad\f[] \f\*[B-Font]No\f[] \f\*[B-Font]and\f[] \f\*[B-Font]none\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]condition\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]selection\f[] \f\*[B-Font]status\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]select\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]last_event\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]report\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]event\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]cnt\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]count\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]count\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
.RE
.br
.ns
.TP 10
.NOP \f\*[B-Font]authinfo\f[]
-Display the authentication statistics.
+Display the authentication statistics counters:
+time since reset, stored keys, free keys, key lookups, keys not found,
+uncached keys, expired keys, encryptions, decryptions.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]clocklist\f[] [\f\*[I-Font]associd\f[]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]clockvar\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
+.NOP \f\*[B-Font]cl\f[] [\f\*[I-Font]associd\f[]]
+Display all clock variables in the variable list for those associations
+supporting a reference clock.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]cv\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
-Display a list of clock variables for those associations supporting a reference clock.
+.NOP \f\*[B-Font]clockvar\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]:config\f[] [...]
-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.
+.NOP \f\*[B-Font]cv\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
+Display a list of clock variables for those associations supporting a
+reference clock.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]:config\f[] \f\*[I-Font]configuration command line\f[]
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[]
-Send the each line of
+Send each line of
\f\*[I-Font]filename\f[]
-to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]ifstats\f[]
-Display statistics for each local network address. Authentication is required.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]iostats\f[]
-Display network and reference clock I/O statistics.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]kerninfo\f[]
-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.
+Display kernel loop and PPS statistics:
+associd, status, pll offset, pll frequency, maximum error,
+estimated error, kernel status, pll time constant, precision,
+frequency tolerance, pps frequency, pps stability, pps jitter,
+calibration interval, calibration cycles, jitter exceeded,
+stability exceeded, calibration errors.
+As with other ntpq output, times are in milliseconds; very small values
+may be shown as exponentials.
+The precision value displayed is in milliseconds as well, unlike the
+precision system variable.
.br
.ns
.TP 10
.NOP \f\*[B-Font]lassociations\f[]
-Perform the same function as the associations command, except display mobilized and unmobilized associations.
+Perform the same function as the associations command, except display
+mobilized and unmobilized associations, including all clients.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
-Obtain and print a list of all peers and clients showing
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version).
+.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
+Display a list of all peers and clients showing
+\f\*[B-Font]dstadr\f[]
+(associated with the given IP version).
.br
.ns
.TP 10
-.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
-Print a peer spreadsheet for the appropriate IP version(s).
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version).
+.NOP \f\*[B-Font]lpassociations\f[]
+Display the last obtained list of associations, including all clients.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
+Display a list of all peers and clients (associated with the given IP version).
.br
.ns
.TP 10
.NOP \f\*[B-Font]monstats\f[]
-Display monitor facility statistics.
+Display monitor facility status, statistics, and limits:
+enabled, addresses, peak addresses, maximum addresses,
+reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mreadlist\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mrl\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
+Perform the same function as the
+\f\*[B-Font]readlist\f[]
+command for a range of association ids.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mreadvar\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
+This range may be determined from the list displayed by any
+command showing associations.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[]]
-Obtain and print traffic counts collected and maintained by the monitor facility.
+.NOP \f\*[B-Font]mrv\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
+Perform the same function as the
+\f\*[B-Font]readvar\f[]
+command for a range of association ids.
+This range may be determined from the list displayed by any
+command showing associations.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]\&=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]\&=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]\&=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]\&=\f\*[I-Font]hexmask\f[]]
+Display traffic counts of the most recently seen source addresses
+collected and maintained by the monitor facility.
With the exception of
-\f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[],
+\f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[],
the options filter the list returned by
-\f\*[B-Font]ntpd.\f[]
+\fCntpd\f[]\fR(8)\f[].
The
\f\*[B-Font]limited\f[]
and
\f\*[B-Font]kod\f[]
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+options return only entries representing client addresses from which the
+last packet received triggered either discarding or a KoD response.
The
\f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[]
option filters entries representing less than
\f\*[I-Font]sortorder\f[]
defaults to
\f\*[B-Font]lstint\f[]
-and may be any of
+and may be
\f\*[B-Font]addr\f[],
-\f\*[B-Font]count\f[],
\f\*[B-Font]avgint\f[],
+\f\*[B-Font]count\f[],
\f\*[B-Font]lstint\f[],
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by
+\[oq]\&-\[cq]
+to reverse the sort order.
The output columns are:
.RS
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]lstint\f[]
-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
+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
\f\*[B-Font]ntpq\fP.
.br
.ns
Restriction flags associated with this address.
Most are copied unchanged from the matching
\f\*[B-Font]restrict\f[]
-command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
+the last packet from this address triggered a rate control response.
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[]
-DNS name, numeric address, or address followed by
+host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
.RE
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mreadvar\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]mrv\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
-Perform the same function as the
-\f\*[B-Font]readvar\f[]
-command, except for a range of association IDs.
-This range is determined from the association list cached by the most recent
-\f\*[B-Font]associations\f[]
-command.
-.br
-.ns
-.TP 10
.NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
Obtain and print the old-style list of all peers and clients showing
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version),
+\f\*[B-Font]dstadr\f[]
+(associated with the given IP version),
rather than the
-\f\*[I-Font]refid\f[].
+\f\*[B-Font]refid\f[].
.br
.ns
.TP 10
.TP 10
.NOP \f\*[B-Font]remote\f[]
host name (or IP number) of peer.
-The value displayed will be truncated to 15 characters unless the
+The value displayed will be truncated to 15 characters unless the
+\f\*[B-Font]ntpq\fP
\f\*[B-Font]\-w\f[]
-flag is given, in which case the full value will be displayed
-on the first line,
-and the remaining data is displayed on the next line.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-association ID or
+source IP address or
.Lk decode.html#kiss "'kiss code"
.br
.ns
.TP 10
.NOP \f\*[B-Font]st\f[]
-stratum
+stratum: 0 for local reference clocks, 1 for servers with local
+reference clocks, ..., 16 for unsynchronized server clocks
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]when\f[]
-sec/min/hr since last received packet
+time in seconds, minutes, hours, or days since the last packet
+was received, or
+\[oq]\&-\[cq]
+if a packet has never been received
.br
.ns
.TP 10
.NOP \f\*[B-Font]poll\f[]
-poll interval (log2 s)
+poll interval (s)
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]jitter\f[]
-jitter
+offset RMS error estimate.
.RE
.br
.ns
.TP 10
-.NOP \f\*[B-Font]apeers\f[]
-Display a list of peers in the form:
-.Dl [tally]remote refid assid st t when pool reach delay offset jitter
-where the output is just like the
-\f\*[B-Font]peers\f[]
-command except that the
-\f\*[B-Font]refid\f[]
-is displayed in hex format and the association number is also displayed.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]assocID\f[]
-Show the statistics for the peer with the given
-\f\*[I-Font]assocID\f[].
+.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]associd\f[]
+Display the statistics for the peer with the given
+\f\*[I-Font]associd\f[]:
+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.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]readlist\f[] \f\*[I-Font]assocID\f[]
+.NOP \f\*[B-Font]readlist\f[] [\f\*[I-Font]associd\f[]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]rl\f[] \f\*[I-Font]assocID\f[]
-Read the system or peer variables included in the variable list.
+.NOP \f\*[B-Font]rl\f[] [\f\*[I-Font]associd\f[]]
+Display all system or peer variables.
+If the
+\f\*[I-Font]associd\f[]
+is omitted, it is assumed to be zero.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]readvar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
+.NOP \f\*[B-Font]readvar\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]rv\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
-Display the specified variables.
+.NOP \f\*[B-Font]rv\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
+Display the specified system or peer variables.
If
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is zero, the variables are from the
\fISystem\f[] \fIVariables\f[]
name space, otherwise they are from the
\fIPeer\f[] \fIVariables\f[]
name space.
The
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is required, as the same name can occur in both spaces.
If no
\f\*[I-Font]name\f[]
is included, all operative variables in the name space are displayed.
In this case only, if the
-\f\*[I-Font]assocID\f[]
-is omitted, it is assumed zero.
+\f\*[I-Font]associd\f[]
+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
-YYYYMMDDTTTT ,
-where YYYY is the year,
-MM the month of year,
-DD the day of month and
-TTTT the time of day.
+\f\*[I-Font]YYYY\f[]\f\*[I-Font]MM\f[] \f\*[I-Font]DD\f[] \f\*[I-Font]TTTT\f[],
+where
+\f\*[I-Font]YYYY\f[]
+is the year,
+\f\*[I-Font]MM\f[]
+the month of year,
+\f\*[I-Font]DD\f[]
+the day of month and
+\f\*[I-Font]TTTT\f[]
+the time of day.
.br
.ns
.TP 10
.NOP \f\*[B-Font]reslist\f[]
-Show the access control (restrict) list for
+Display the access control (restrict) list for
\f\*[B-Font]ntpq\fP.
+Authentication is required.
.br
.ns
.TP 10
.NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[]
-Write the current configuration,
-including any runtime modifications given with
+Save the current configuration,
+including any runtime modifications made by
\f\*[B-Font]:config\f[]
or
\f\*[B-Font]config-from-file\f[],
-to the ntpd host's file
+to the NTP server host file
\f\*[I-Font]filename\f[].
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-\f\*[B-Font]ntpd\f[]
+\fCntpd\f[]\fR(8)\f[]
configuration file.
\f\*[I-Font]filename\f[]
can use
-\fCstrftime\f[]\fR()\f[]
-format specifies to substitute the current date and time, for example,
-\f\*[B-Font]q]saveconfig\f[] \f\*[B-Font]ntp-%Y%m%d-%H%M%S.confq]\f[].
+\fCdate\f[]\fR(1)\f[]
+format specifiers to substitute the current date and time, for
+example,
+.in +4
+\f\*[B-Font]saveconfig\f[] \fIntp-%Y%m%d-%H%M%S.conf\f[].
+.in -4
The filename used is stored in system variable
\f\*[B-Font]savedconfig\f[].
Authentication is required.
.br
.ns
.TP 10
+.NOP \f\*[B-Font]sysinfo\f[]
+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.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]sysstats\f[]
+Display system uptime and packet counts maintained in the
+protocol module:
+uptime, sysstats reset, packets received, current version,
+older version, bad length or format, authentication failed,
+declined, restricted, rate limited, KoD responses,
+processed for time.
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]timerstats\f[]
-Display interval timer counters.
+Display interval timer counters:
+time since reset, timer overruns, calls to transmit.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]assocID\f[]
-Write the system or peer variables included in the variable list.
+.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]associd\f[]
+Set all system or peer variables included in the variable list.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
-Write the specified variables.
+.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]associd\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
+Set the specified variables in the variable list.
If the
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is zero, the variables are from the
\fISystem\f[] \fIVariables\f[]
name space, otherwise they are from the
\fIPeer\f[] \fIVariables\f[]
name space.
The
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is required, as the same name can occur in both spaces.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]sysinfo\f[]
-Display operational summary.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]sysstats\f[]
-Print statistics counters maintained in the protocol module.
+Authentication is required.
.PP
.SS Status Words and Kiss Codes
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 in the
-\f\*[B-Font]rv\f[]
+These words are displayed by the
+\f\*[B-Font]readlist\f[]
and
-\f\*[B-Font]as\f[]
+\f\*[B-Font]associations\f[]
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"
in the reference identifier field in various billboards.
.SS System Variables
The following system variables appear in the
-\f\*[B-Font]rv\f[]
+\f\*[B-Font]readlist\f[]
billboard.
Not all variables are displayed in some configurations.
+.sp \n(Ppu
+.ne 2
+
.TP 10
.NOP Variable
Description
.br
.ns
.TP 10
-.NOP \f\*[B-Font]peer\f[]
-system peer association ID
+.NOP \f\*[B-Font]refid\f[]
+reference id or
+.Lk decode.html#kiss "kiss code"
.br
.ns
.TP 10
-.NOP \f\*[B-Font]tc\f[]
-time constant and poll exponent (log2 s) (3-17)
+.NOP \f\*[B-Font]reftime\f[]
+reference time
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mintc\f[]
-minimum time constant (log2 s) (3-10)
+.NOP \f\*[B-Font]clock\f[]
+date and time of day
.br
.ns
.TP 10
-.NOP \f\*[B-Font]clock\f[]
-date and time of day
+.NOP \f\*[B-Font]peer\f[]
+system peer association id
.br
.ns
.TP 10
-.NOP \f\*[B-Font]refid\f[]
-reference ID or
-.Lk decode.html#kiss "kiss code"
+.NOP \f\*[B-Font]tc\f[]
+time constant and poll exponent (log2 s) (3-17)
.br
.ns
.TP 10
-.NOP \f\*[B-Font]reftime\f[]
-reference time
+.NOP \f\*[B-Font]mintc\f[]
+minimum time constant (log2 s) (3-10)
.br
.ns
.TP 10
.NOP \f\*[B-Font]offset\f[]
-combined offset of server relative to this host
+combined offset of server relative to this host
.br
.ns
.TP 10
-.NOP \f\*[B-Font]sys_jitter\f[]
-combined system jitter
+.NOP \f\*[B-Font]frequency\f[]
+frequency drift (PPM) relative to hardware clock
.br
.ns
.TP 10
-.NOP \f\*[B-Font]frequency\f[]
-frequency offset (PPM) relative to hardware clock
+.NOP \f\*[B-Font]sys_jitter\f[]
+combined system jitter
.br
.ns
.TP 10
.PP
.SS Peer Variables
The following peer variables appear in the
-\f\*[B-Font]rv\f[]
+\f\*[B-Font]readlist\f[]
billboard for each association.
Not all variables are displayed in some configurations.
+.sp \n(Ppu
+.ne 2
+
.TP 10
.NOP Variable
Description
.ns
.TP 10
.NOP \f\*[B-Font]associd\f[]
-association ID
+association id
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-reference ID or
+reference id or
.Lk decode.html#kiss "kiss code"
.br
.ns
.br
.ns
.TP 10
+.NOP \f\*[B-Font]rec\f[]
+last packet received time
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]reach\f[]
reach register (octal)
.br
.br
.ns
.TP 10
+.NOP \f\*[B-Font]keyid\f[]
+symmetric key id
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]offset\f[]
filter offset
.br
.br
.ns
.TP 10
-.NOP \f\*[B-Font]ident\f[]
-Autokey group name for this association
-.br
-.ns
-.TP 10
.NOP \f\*[B-Font]bias\f[]
unicast/broadcast bias
.br
\f\*[B-Font]bias\f[]
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.
+It represents the offset of the broadcast subgraph relative to the
+unicast subgraph.
The
\f\*[B-Font]xleave\f[]
variable appears only for the interleaved symmetric and interleaved modes.
.ns
.TP 10
.NOP \f\*[B-Font]initsequence\f[]
-initial key ID
+initial key id
.br
.ns
.TP 10
.TP 10
.NOP \f\*[B-Font]timestamp\f[]
Autokey signature timestamp
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]ident\f[]
+Autokey group name for this association
.PP
.SS Clock Variables
The following clock variables appear in the
-\f\*[B-Font]cv\f[]
+\f\*[B-Font]clocklist\f[]
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]associd\f[]
-association ID
+association id
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-driver reference ID
+driver reference id
.br
.ns
.TP 10
.SH "OPTIONS"
.TP
.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[]
-Force IPv4 DNS name resolution.
+Force IPv4 name resolution.
This option must not appear in combination with any of the following options:
ipv6.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv4 namespace.
.TP
.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[]
-Force IPv6 DNS name resolution.
+Force IPv6 name resolution.
This option must not appear in combination with any of the following options:
ipv4.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv6 namespace.
.TP
.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[]
numeric host addresses.
.sp
Output all host addresses in dotted-quad numeric format rather than
-converting to the canonical host names.
+converting to the canonical host names.
.TP
.NOP \f\*[B-Font]\-\-old\-rv\f[]
Always output status line with readvar.
-.Dd January 2 2017
+.Dd March 19 2017
.Dt NTPQ 1ntpqmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpq-opts.mdoc)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:20 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:31 AM by AutoGen 5.18.5
.\" From the definitions ntpq-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
[ host ...]
.Pp
.Sh DESCRIPTION
+.Pp
The
.Nm
-utility program is used to query NTP servers which
-implement the standard NTP mode 6 control message formats defined
-in Appendix B of the NTPv3 specification RFC1305, requesting
+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.
-The same formats are used in NTPv4, although some of the
-variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
command line arguments.
Requests to read and write arbitrary
utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
+.Pp
If one or more request options is included on the command line
when
.Nm
.Nm
utility will prompt for
commands if the standard input is a terminal device.
+.Pp
.Nm
uses NTP mode 6 packets to communicate with the
NTP server, and hence can be used to query any compatible server on
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
+.Pp
+Note that in contexts where a host name is expected, a
+.Fl 4
+qualifier preceding the host name forces resolution to the IPv4
+namespace, while a
+.Fl 6
+qualifier forces resolution to the IPv6 namespace.
+For examples and usage, see the
+.Dq NTP Debugging Techniques
+page.
+.Pp
Specifying a
command line option other than
.Fl i
will attempt to read
interactive format commands from the standard input.
.Ss "Internal Commands"
+.Pp
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.
+.Pp
A
number of interactive format commands are executed entirely within
the
.Nm
-utility itself and do not result in NTP mode 6
+utility itself and do not result in NTP
requests being sent to a server.
These are described following.
-.Bl -tag -width "? [command_keyword]" -compact -offset indent
-.It Ic ? Op Ar command_keyword
-.It Ic help Op Ar command_keyword
+.Bl -tag -width "help [command]" -compact -offset indent
+.It Ic ? Op Ar command
+.It Ic help Op Ar command
A
.Ql \&?
-by itself will print a list of all the command
-keywords known to this incarnation of
+by itself will print a list of all the commands
+known to
.Nm .
A
.Ql \&?
-followed by a command keyword will print function and usage
+followed by a command name will print function and usage
information about the command.
-This command is probably a better
-source of information about
-.Nm
-than this manual
-page.
-.It Ic addvars Ar variable_name Ns Xo Op Ic =value
-.Ic ...
-.Xc
-.It Ic rmvars Ar variable_name Ic ...
+.It Ic addvars Ar name Ns Oo \&= Ns Ar value Ns Op ,...
+.It Ic rmvars Ar name Ns Op ,...
.It Ic clearvars
.It Ic showvars
-The data carried by NTP mode 6 messages consists of a list of
+The arguments to this command consist of a list of
items of the form
-.Ql variable_name=value ,
+.Ar name Ns Op \&= Ns Ar value ,
where the
-.Ql =value
+.No \&= Ns Ar value
is ignored, and can be omitted,
in requests to the server to read variables.
The
.Nm
-utility maintains an internal list in which data to be included in control
-messages can be assembled, and sent using the
+utility maintains an internal list in which data to be included in
+messages can be assembled, and displayed or set using the
.Ic readlist
and
.Ic writelist
.Ic rmvars
command can be used to remove individual variables from the list,
while the
-.Ic clearlist
+.Ic clearvars
command removes all variables from the
list.
The
.Ic showvars
command displays the current list of optional variables.
-.It Ic authenticate Op yes | no
+.It Ic authenticate Op Cm yes Ns | Ns Cm no
Normally
.Nm
does not authenticate requests unless
they are write requests.
The command
-.Ql authenticate yes
+.Ic authenticate Cm yes
causes
.Nm
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
-requests slightly differently, and can occasionally melt the CPU in
-fuzzballs if you turn authentication on before doing a
-.Ic peer
-display.
+requests slightly differently.
The command
-.Ql authenticate
+.Ic authenticate
causes
.Nm
to display whether or not
-.Nm
-is currently autheinticating requests.
+it is currently authenticating requests.
.It Ic cooked
Causes output from query commands to be "cooked", so that
variables which are recognized by
values reformatted for human consumption.
Variables which
.Nm
-thinks should have a decodable value but didn't are
+could not decode completely are
marked with a trailing
.Ql \&? .
-.It Xo
-.Ic debug
-.Oo
-.Cm more |
-.Cm less |
-.Cm off
-.Oc
-.Xc
+.It Ic debug Op Cm more Ns | Ns Cm less Ns | Ns Cm off
With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
-.It Ic delay Ar milliseconds
+Otherwise, the debugging level is changed as indicated.
+.It Ic delay Op Ar milliseconds
Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
Actually the
server does not now require timestamps in authenticated requests,
so this command may be obsolete.
+Without any arguments, displays the current delay.
+.It Ic drefid Op Cm hash Ns | Ns Cm ipv4
+Display refids as IPv4 or hash.
+Without any arguments, displays whether refids are shown as IPv4
+addresses or hashes.
.It Ic exit
Exit
.Nm .
-.It Ic host Ar hostname
+.It Ic host Op Ar name
Set the host to which future queries will be sent.
-.Ar hostname
+The
+.Ar name
may be either a host name or a numeric address.
-.It Ic hostnames Op Cm yes | Cm no
+Without any arguments, displays the current host.
+.It Ic hostnames Op Cm yes Ns | Ns Cm no
If
.Cm yes
is specified, host names are printed in
modified using the command line
.Fl n
switch.
-.It Ic keyid Ar keyid
+Without any arguments, displays whether host names or numeric addresses
+are shown.
+.It Ic keyid Op Ar keyid
This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
.Cm controlkey
key number the server has been configured to use for this
purpose.
-.It Ic keytype Xo Oo
-.Cm md5 |
-.Cm OpenSSLDigestType
-.Oc
-.Xc
-Specify the type of key to use for authenticating requests.
-.Cm md5
-is alway supported.
+Without any arguments, displays the current
+.Ar keyid .
+.It Ic keytype Op Ar digest
+Specify the digest algorithm to use for authenticating requests, with default
+.Cm MD5 .
If
.Nm
-was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+was built with OpenSSL support, and OpenSSL is installed,
+.Ar digest
+can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-.Ic keytype
-is displayed.
-.It Ic ntpversion Xo Oo
-.Cm 1 |
-.Cm 2 |
-.Cm 3 |
-.Cm 4
-.Oc
-.Xc
+.Ic keytype Ar digest
+algorithm used is displayed.
+.It Ic ntpversion Op Cm 1 Ns | Ns Cm 2 Ns | Ns Cm 3 Ns | Ns Cm 4
Sets the NTP version number which
.Nm
claims in
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
successful.
-.\" Not yet implemented.
-.\" .It Ic poll
-.\" .Op Ar n
-.\" .Op Ic verbose
-.\" Poll an NTP server in client mode
-.\" .Ar n
-.\" times.
+.It Ic poll Oo Ar n Oc Op Cm verbose
+Poll an NTP server in client mode
+.Ar n
+times.
+Poll not implemented yet.
.It Ic quit
Exit
.Nm .
The only formating/interpretation done on
the data is to transform nonascii data into a printable (but barely
understandable) form.
-.It Ic timeout Ar milliseconds
+.It Ic timeout Op Ar milliseconds
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
.Nm
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
.It Ic version
-Print the version of the
+Display the version of the
.Nm
program.
.El
.Ss "Control Message Commands"
-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.
+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 message to the server and expect a
+single response message.
The exceptions are the
-.Li peers
+.Ic peers
command, which sends a series of messages,
and the
-.Li mreadlist
+.Ic mreadlist
and
-.Li mreadvar
+.Ic mreadvar
commands, which iterate over a range of associations.
.Bl -tag -width "something" -compact -offset indent
-.It Cm associations
+.It Ic apeers
+Display a list of peers in the form:
+.Dl [tally]remote refid assid st t when pool reach delay offset jitter
+where the output is just like the
+.Ic peers
+command except that the
+.Cm refid
+is displayed in hex format and the association number is also displayed.
+.It Ic associations
Display a list of mobilized associations in the form:
.Dl ind assid status conf reach auth condition last_event cnt
-.Bl -column -offset indent ".Sy Variable" ".Sy Description"
-.It Sy String Ta Sy Description
-.It Li ind Ta index on this list
-.It Li assid Ta association ID
-.It Li status Ta peer status word
-.It Li conf Ta Li yes : persistent, Li no : ephemeral
-.It Li reach Ta Li yes : reachable, Li no : unreachable
-.It Li auth Ta Li ok , Li yes , Li bad and Li none
-.It Li condition Ta selection status (see the Li select field of the peer status word)
-.It Li last_event Ta event report (see the Li event field of the peer status word)
-.It Li cnt Ta event count (see the Li count field of the peer status word)
+.Bl -column -offset indent ".Sy Variable" "see the select field of the peer status word"
+.It Sy Variable Ta Sy Description
+.It Cm ind Ta index on this list
+.It Cm assid Ta association id
+.It Cm status Ta peer status word
+.It Cm conf Ta Cm yes : No persistent, Cm no : No ephemeral
+.It Cm reach Ta Cm yes : No reachable, Cm no : No unreachable
+.It Cm auth Ta Cm ok , Cm yes , Cm bad No and Cm none
+.It Cm condition Ta selection status \&(see the Cm select No field of the peer status word\&)
+.It Cm last_event Ta event report \&(see the Cm event No field of the peer status word\&)
+.It Cm cnt Ta event count \&(see the Cm count No field of the peer status word\&)
.El
-.It Cm authinfo
-Display the authentication statistics.
-.It Cm clockvar Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
-.It Cm cv Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
-Display a list of clock variables for those associations supporting a reference clock.
-.It Cm :config Op ...
-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.
-.It Cm config\-from\-file Ar filename
-Send the each line of
+.It Ic authinfo
+Display the authentication statistics counters:
+time since reset, stored keys, free keys, key lookups, keys not found,
+uncached keys, expired keys, encryptions, decryptions.
+.It Ic clocklist Op Ar associd
+.It Ic cl Op Ar associd
+Display all clock variables in the variable list for those associations
+supporting a reference clock.
+.It Ic clockvar Oo Ar associd Oc Oo Ar name Ns Oo \&= Ns Ar value Oc Ns Oc Ns Op ,...
+.It Ic cv Oo Ar associd Oc Oo Ar name Ns Oo \&= Ns Ar value Oc Ns Oc Ns Op ,...
+Display a list of clock variables for those associations supporting a
+reference clock.
+.It Ic :config Ar "configuration command line"
+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.
+.It Ic config\-from\-file Ar filename
+Send each line of
.Ar filename
-to the server as run\-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+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.
.It Ic ifstats
-Display statistics for each local network address. Authentication is required.
+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.
.It Ic iostats
-Display network and reference clock I/O statistics.
+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.
.It Ic kerninfo
-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.
+Display kernel loop and PPS statistics:
+associd, status, pll offset, pll frequency, maximum error,
+estimated error, kernel status, pll time constant, precision,
+frequency tolerance, pps frequency, pps stability, pps jitter,
+calibration interval, calibration cycles, jitter exceeded,
+stability exceeded, calibration errors.
+As with other ntpq output, times are in milliseconds; very small values
+may be shown as exponentials.
+The precision value displayed is in milliseconds as well, unlike the
+precision system variable.
.It Ic lassociations
-Perform the same function as the associations command, except display mobilized and unmobilized associations.
-.It Ic lopeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
-Obtain and print a list of all peers and clients showing
-.Ar dstadr
-(associated with any given IP version).
-.It Ic lpeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
-Print a peer spreadsheet for the appropriate IP version(s).
-.Ar dstadr
-(associated with any given IP version).
+Perform the same function as the associations command, except display
+mobilized and unmobilized associations, including all clients.
+.It Ic lopeers Op Fl 4 Ns | Ns Fl 6
+Display a list of all peers and clients showing
+.Cm dstadr
+(associated with the given IP version).
+.It Ic lpassociations
+Display the last obtained list of associations, including all clients.
+.It Ic lpeers Op Fl 4 Ns | Ns Fl 6
+Display a list of all peers and clients (associated with the given IP version).
.It Ic monstats
-Display monitor facility statistics.
-.It Ic mrulist Oo Ic limited | Ic kod | Ic mincount Ns = Ns Ar count | Ic laddr Ns = Ns Ar localaddr | Ic sort Ns = Ns Ar sortorder | Ic resany Ns = Ns Ar hexmask | Ic resall Ns = Ns Ar hexmask Oc
-Obtain and print traffic counts collected and maintained by the monitor facility.
+Display monitor facility status, statistics, and limits:
+enabled, addresses, peak addresses, maximum addresses,
+reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
+.It Ic mreadlist Ar associdlo Ar associdhi
+.It Ic mrl Ar associdlo Ar associdhi
+Perform the same function as the
+.Ic readlist
+command for a range of association ids.
+.It Ic mreadvar Ar associdlo Ar associdhi Oo Ar name Oc Ns Op ,...
+This range may be determined from the list displayed by any
+command showing associations.
+.It Ic mrv Ar associdlo Ar associdhi Oo Ar name Oc Ns Op ,...
+Perform the same function as the
+.Ic readvar
+command for a range of association ids.
+This range may be determined from the list displayed by any
+command showing associations.
+.It Xo Ic mrulist Oo Cm limited | Cm kod | Cm mincount Ns \&= Ns Ar count |
+.Cm laddr Ns \&= Ns Ar localaddr | Cm sort Ns \&= Ns Oo \&\- Oc Ns Ar sortorder |
+.Cm resany Ns \&= Ns Ar hexmask | Cm resall Ns \&= Ns Ar hexmask Oc
+.Xc
+Display traffic counts of the most recently seen source addresses
+collected and maintained by the monitor facility.
With the exception of
-.Cm sort Ns = Ns Ar sortorder ,
+.Cm sort Ns \&= Ns Oo \&\- Oc Ns Ar sortorder ,
the options filter the list returned by
-.Cm ntpd.
+.Xr ntpd 8 .
The
.Cm limited
and
.Cm kod
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+options return only entries representing client addresses from which the
+last packet received triggered either discarding or a KoD response.
The
.Cm mincount Ns = Ns Ar count
option filters entries representing less than
.Ar sortorder
defaults to
.Cm lstint
-and may be any of
+and may be
.Cm addr ,
-.Cm count ,
.Cm avgint ,
+.Cm count ,
.Cm lstint ,
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by
+.Ql \&\-
+to reverse the sort order.
The output columns are:
.Bl -tag -width "something" -compact -offset indent
.It Column
Description
.It Ic lstint
-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
+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
.Nm .
.It Ic avgint
Average interval in s between packets from this address.
Restriction flags associated with this address.
Most are copied unchanged from the matching
.Ic restrict
-command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
+the last packet from this address triggered a rate control response.
.It Ic r
Rate control indicator, either
a period,
.It Ic rport
Source port of last packet from this address.
.It Ic remote address
-DNS name, numeric address, or address followed by
+host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
.El
-.It Ic mreadvar assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
-.It Ic mrv assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
-Perform the same function as the
-.Ic readvar
-command, except for a range of association IDs.
-This range is determined from the association list cached by the most recent
-.Ic associations
-command.
-.It Ic opeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
+.It Ic opeers Op Fl 4 | Fl 6
Obtain and print the old\-style list of all peers and clients showing
-.Ar dstadr
-(associated with any given IP version),
+.Cm dstadr
+(associated with the given IP version),
rather than the
-.Ar refid .
+.Cm refid .
.It Ic passociations
Perform the same function as the
.Ic associations
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic [tally]
+.It Cm [tally]
single\-character code indicating current value of the
.Ic select
field of the
.Lk decode.html#peer "peer status word"
-.It Ic remote
+.It Cm remote
host name (or IP number) of peer.
-The value displayed will be truncated to 15 characters unless the
+The value displayed will be truncated to 15 characters unless the
+.Nm
.Fl w
-flag is given, in which case the full value will be displayed
-on the first line,
-and the remaining data is displayed on the next line.
-.It Ic refid
-association ID or
+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.
+.It Cm refid
+source IP address or
.Lk decode.html#kiss "'kiss code"
-.It Ic st
-stratum
-.It Ic t
+.It Cm st
+stratum: 0 for local reference clocks, 1 for servers with local
+reference clocks, ..., 16 for unsynchronized server clocks
+.It Cm t
.Ic u :
unicast or manycast client,
.Ic b :
broadcast server,
.Ic M :
multicast server
-.It Ic when
-sec/min/hr since last received packet
-.It Ic poll
-poll interval (log2 s)
-.It Ic reach
+.It Cm when
+time in seconds, minutes, hours, or days since the last packet
+was received, or
+.Ql \&\-
+if a packet has never been received
+.It Cm poll
+poll interval (s)
+.It Cm reach
reach shift register (octal)
-.It Ic delay
+.It Cm delay
roundtrip delay
-.It Ic offset
+.It Cm offset
offset of server relative to this host
-.It Ic jitter
-jitter
+.It Cm jitter
+offset RMS error estimate.
.El
-.It Ic apeers
-Display a list of peers in the form:
-.Dl [tally]remote refid assid st t when pool reach delay offset jitter
-where the output is just like the
-.Ic peers
-command except that the
-.Ic refid
-is displayed in hex format and the association number is also displayed.
-.It Ic pstats Ar assocID
-Show the statistics for the peer with the given
-.Ar assocID .
-.It Ic readlist Ar assocID
-.It Ic rl Ar assocID
-Read the system or peer variables included in the variable list.
-.It Ic readvar Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc Oo , ... Oc
-.It Ic rv Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc Oo , ... Oc
-Display the specified variables.
+.It Ic pstats Ar associd
+Display the statistics for the peer with the given
+.Ar associd :
+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.
+.It Ic readlist Op Ar associd
+.It Ic rl Op Ar associd
+Display all system or peer variables.
+If the
+.Ar associd
+is omitted, it is assumed to be zero.
+.It Ic readvar Op Ar associd Ar name Ns Oo Ns = Ns Ar value Oc Op , ...
+.It Ic rv Op Ar associd Ar name Ns Oo Ns = Ns Ar value Oc Op , ...
+Display the specified system or peer variables.
If
-.Ar assocID
+.Ar associd
is zero, the variables are from the
.Sx System Variables
name space, otherwise they are from the
.Sx Peer Variables
name space.
The
-.Ar assocID
+.Ar associd
is required, as the same name can occur in both spaces.
If no
.Ar name
is included, all operative variables in the name space are displayed.
In this case only, if the
-.Ar assocID
-is omitted, it is assumed zero.
+.Ar associd
+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
-YYYYMMDDTTTT ,
-where YYYY is the year,
-MM the month of year,
-DD the day of month and
-TTTT the time of day.
+.Ar YYYY Ns Ar MM Ar DD Ar TTTT ,
+where
+.Ar YYYY
+is the year,
+.Ar MM
+the month of year,
+.Ar DD
+the day of month and
+.Ar TTTT
+the time of day.
.It Ic reslist
-Show the access control (restrict) list for
+Display the access control (restrict) list for
.Nm .
+Authentication is required.
.It Ic saveconfig Ar filename
-Write the current configuration,
-including any runtime modifications given with
+Save the current configuration,
+including any runtime modifications made by
.Ic :config
or
.Ic config\-from\-file ,
-to the ntpd host's file
+to the NTP server host file
.Ar filename .
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-.Ic ntpd
+.Xr ntpd 8
configuration file.
.Ar filename
can use
-.Xr strftime
-format specifies to substitute the current date and time, for example,
-.Ic q]saveconfig ntp\-%Y%m%d\-%H%M%S.confq] .
+.Xr date 1
+format specifiers to substitute the current date and time, for
+example,
+.D1 Ic saveconfig Pa ntp\-%Y%m%d\-%H%M%S.conf .
The filename used is stored in system variable
-.Ic savedconfig .
+.Cm savedconfig .
Authentication is required.
+.It Ic sysinfo
+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.
+.It Ic sysstats
+Display system uptime and packet counts maintained in the
+protocol module:
+uptime, sysstats reset, packets received, current version,
+older version, bad length or format, authentication failed,
+declined, restricted, rate limited, KoD responses,
+processed for time.
.It Ic timerstats
-Display interval timer counters.
-.It Ic writelist Ar assocID
-Write the system or peer variables included in the variable list.
-.It Ic writevar Ar assocID Ar name Ns = Ns Ar value Op , ...
-Write the specified variables.
+Display interval timer counters:
+time since reset, timer overruns, calls to transmit.
+.It Ic writelist Ar associd
+Set all system or peer variables included in the variable list.
+.It Ic writevar Ar associd Ar name Ns = Ns Ar value Op , ...
+Set the specified variables in the variable list.
If the
-.Ar assocID
+.Ar associd
is zero, the variables are from the
.Sx System Variables
name space, otherwise they are from the
.Sx Peer Variables
name space.
The
-.Ar assocID
+.Ar associd
is required, as the same name can occur in both spaces.
-.It Ic sysinfo
-Display operational summary.
-.It Ic sysstats
-Print statistics counters maintained in the protocol module.
+Authentication is required.
.El
.Ss Status Words and Kiss Codes
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 in the
-.Ic rv
+These words are displayed by the
+.Ic readlist
and
-.Ic as
+.Ic associations
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"
in the reference identifier field in various billboards.
.Ss System Variables
The following system variables appear in the
-.Ic rv
+.Ic readlist
billboard.
Not all variables are displayed in some configurations.
+.Pp
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic status
+.It Cm status
.Lk decode.html#sys "system status word"
-.It Ic version
+.It Cm version
NTP software version and build time
-.It Ic processor
+.It Cm processor
hardware platform and version
-.It Ic system
+.It Cm system
operating system and version
-.It Ic leap
+.It Cm leap
leap warning indicator (0\-3)
-.It Ic stratum
+.It Cm stratum
stratum (1\-15)
-.It Ic precision
+.It Cm precision
precision (log2 s)
-.It Ic rootdelay
+.It Cm rootdelay
total roundtrip delay to the primary reference clock
-.It Ic rootdisp
+.It Cm rootdisp
total dispersion to the primary reference clock
-.It Ic peer
-system peer association ID
-.It Ic tc
-time constant and poll exponent (log2 s) (3\-17)
-.It Ic mintc
-minimum time constant (log2 s) (3\-10)
-.It Ic clock
-date and time of day
-.It Ic refid
-reference ID or
+.It Cm refid
+reference id or
.Lk decode.html#kiss "kiss code"
-.It Ic reftime
+.It Cm reftime
reference time
-.It Ic offset
-combined offset of server relative to this host
-.It Ic sys_jitter
+.It Ic clock
+date and time of day
+.It Cm peer
+system peer association id
+.It Cm tc
+time constant and poll exponent (log2 s) (3\-17)
+.It Cm mintc
+minimum time constant (log2 s) (3\-10)
+.It Cm offset
+combined offset of server relative to this host
+.It Cm frequency
+frequency drift (PPM) relative to hardware clock
+.It Cm sys_jitter
combined system jitter
-.It Ic frequency
-frequency offset (PPM) relative to hardware clock
-.It Ic clk_wander
+.It Cm clk_wander
clock frequency wander (PPM)
-.It Ic clk_jitter
+.It Cm clk_jitter
clock jitter
-.It Ic tai
+.It Cm tai
TAI\-UTC offset (s)
-.It Ic leapsec
+.It Cm leapsec
NTP seconds when the next leap second is/was inserted
-.It Ic expire
+.It Cm expire
NTP seconds when the NIST leapseconds file expires
.El
The jitter and wander statistics are exponentially\-weighted RMS averages.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic host
+.It Cm host
Autokey host name for this host
-.It Ic ident
+.It Cm ident
Autokey group name for this host
-.It Ic flags
+.It Cm flags
host flags (see Autokey specification)
-.It Ic digest
+.It Cm digest
OpenSSL message digest algorithm
-.It Ic signature
+.It Cm signature
OpenSSL digest/signature scheme
-.It Ic update
+.It Cm update
NTP seconds at last signature update
-.It Ic cert
+.It Cm cert
certificate subject, issuer and certificate flags
-.It Ic until
+.It Cm until
NTP seconds when the certificate expires
.El
.Ss Peer Variables
The following peer variables appear in the
-.Ic rv
+.Ic readlist
billboard for each association.
Not all variables are displayed in some configurations.
+.Pp
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic associd
-association ID
-.It Ic status
+.It Cm associd
+association id
+.It Cm status
.Lk decode.html#peer "peer status word"
-.It Ic srcadr
+.It Cm srcadr
source (remote) IP address
-.It Ic srcport
+.It Cm srcport
source (remote) port
-.It Ic dstadr
+.It Cm dstadr
destination (local) IP address
-.It Ic dstport
+.It Cm dstport
destination (local) port
-.It Ic leap
+.It Cm leap
leap indicator (0\-3)
-.It Ic stratum
+.It Cm stratum
stratum (0\-15)
-.It Ic precision
+.It Cm precision
precision (log2 s)
-.It Ic rootdelay
+.It Cm rootdelay
total roundtrip delay to the primary reference clock
-.It Ic rootdisp
+.It Cm rootdisp
total root dispersion to the primary reference clock
-.It Ic refid
-reference ID or
+.It Cm refid
+reference id or
.Lk decode.html#kiss "kiss code"
-.It Ic reftime
+.It Cm reftime
reference time
-.It Ic reach
+.It Cm rec
+last packet received time
+.It Cm reach
reach register (octal)
-.It Ic unreach
+.It Cm unreach
unreach counter
-.It Ic hmode
+.It Cm hmode
host mode (1\-6)
-.It Ic pmode
+.It Cm pmode
peer mode (1\-5)
-.It Ic hpoll
+.It Cm hpoll
host poll exponent (log2 s) (3\-17)
-.It Ic ppoll
+.It Cm ppoll
peer poll exponent (log2 s) (3\-17)
-.It Ic headway
+.It Cm headway
headway (see
.Lk rate.html "Rate Management and the Kiss\-o'\-Death Packet" )
-.It Ic flash
+.It Cm flash
.Lk decode.html#flash "flash status word"
-.It Ic offset
+.It Cm keyid
+symmetric key id
+.It Cm offset
filter offset
-.It Ic delay
+.It Cm delay
filter delay
-.It Ic dispersion
+.It Cm dispersion
filter dispersion
-.It Ic jitter
+.It Cm jitter
filter jitter
-.It Ic ident
-Autokey group name for this association
-.It Ic bias
+.It Cm bias
unicast/broadcast bias
-.It Ic xleave
+.It Cm xleave
interleave delay (see
.Lk xleave.html "NTP Interleaved Modes" )
.El
The
-.Ic bias
+.Cm bias
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.
+It represents the offset of the broadcast subgraph relative to the
+unicast subgraph.
The
-.Ic xleave
+.Cm xleave
variable appears only for the interleaved symmetric and interleaved modes.
It represents the internal queuing, buffering and transmission delays
for the preceding packet.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic flags
+.It Cm flags
peer flags (see Autokey specification)
-.It Ic host
+.It Cm host
Autokey server name
-.It Ic flags
+.It Cm flags
peer flags (see Autokey specification)
-.It Ic signature
+.It Cm signature
OpenSSL digest/signature scheme
-.It Ic initsequence
-initial key ID
-.It Ic initkey
+.It Cm initsequence
+initial key id
+.It Cm initkey
initial key index
-.It Ic timestamp
+.It Cm timestamp
Autokey signature timestamp
+.It Cm ident
+Autokey group name for this association
.El
.Ss Clock Variables
The following clock variables appear in the
-.Ic cv
+.Ic clocklist
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic associd
-association ID
-.It Ic status
+.It Cm associd
+association id
+.It Cm status
.Lk decode.html#clock "clock status word"
-.It Ic device
+.It Cm device
device description
-.It Ic timecode
+.It Cm timecode
ASCII time code string (specific to device)
-.It Ic poll
+.It Cm poll
poll messages sent
-.It Ic noreply
+.It Cm noreply
no reply
-.It Ic badformat
+.It Cm badformat
bad format
-.It Ic baddata
+.It Cm baddata
bad date or time
-.It Ic fudgetime1
+.It Cm fudgetime1
fudge time 1
-.It Ic fudgetime2
+.It Cm fudgetime2
fudge time 2
-.It Ic stratum
+.It Cm stratum
driver stratum
-.It Ic refid
-driver reference ID
-.It Ic flags
+.It Cm refid
+driver reference id
+.It Cm flags
driver flags
.El
.Sh "OPTIONS"
.Bl -tag
.It Fl 4 , Fl \-ipv4
-Force IPv4 DNS name resolution.
+Force IPv4 name resolution.
This option must not appear in combination with any of the following options:
ipv6.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv4 namespace.
.It Fl 6 , Fl \-ipv6
-Force IPv6 DNS name resolution.
+Force IPv6 name resolution.
This option must not appear in combination with any of the following options:
ipv4.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv6 namespace.
.It Fl c Ar cmd , Fl \-command Ns = Ns Ar cmd
run a command and exit.
numeric host addresses.
.sp
Output all host addresses in dotted\-quad numeric format rather than
-converting to the canonical host names.
+converting to the canonical host names.
.It Fl \-old\-rv
Always output status line with readvar.
.sp
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>ntpq: Network Time Protocol Query User’s Manual</title>
-
-<meta name="description" content="ntpq: Network Time Protocol Query User’s Manual">
-<meta name="keywords" content="ntpq: Network Time Protocol Query User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>ntpq: Network Time Protocol Query User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="ntpq: Network Time Protocol Query User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">ntpq: Network Time Protocol Query User’s Manual</h1>
-
-
-
-
-
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+<body>
+<h1 class="settitle">ntpq: Network Time Protocol Query User's Manual</h1>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">ntpq: Network Time Protocol Query User Manual</a>
</ul>
</div>
+
+<div class="node">
<a name="Top"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-Description">ntpq Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<a name="ntpq_003a-Network-Time-Protocol-Query-User-Manual"></a>
-<h1 class="top">ntpq: Network Time Protocol Query User Manual</h1>
+
+<h2 class="unnumbered">ntpq: Network Time Protocol Query User Manual</h2>
<p>The <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.8p9-win 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>
-
-<hr>
+
+ <p>This document applies to version 4.2.8p9 of <code>ntpq</code>.
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntpq-Description">ntpq Description</a>
+<li><a accesskey="2" href="#ntpq-Invocation">ntpq Invocation</a>: Invoking ntpq
+<li><a accesskey="3" href="#Usage">Usage</a>
+<li><a accesskey="4" href="#Internal-Commands">Internal Commands</a>
+<li><a accesskey="5" href="#Control-Message-Commands">Control Message Commands</a>
+<li><a accesskey="6" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>
+<li><a accesskey="7" href="#System-Variables">System Variables</a>
+<li><a accesskey="8" href="#Peer-Variables">Peer Variables</a>
+<li><a accesskey="9" href="#Clock-Variables">Clock Variables</a>
+</ul>
+
+<div class="node">
<a name="ntpq-Description"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Usage">Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
-<p>The <code>ntpq</code> utility program is used to monitor NTP daemon <code>ntpd</code> operations and determine performance.
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
+
+<p>The <code>ntpq</code> utility program is used to monitor NTP daemon <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.
+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>
-<hr>
+
+
<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>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><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>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>For examples and usage, see the <a href="debug.html">NTP Debugging Techniques</a> page.
+
+<div class="node">
<a name="ntpq-Invocation"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Invoking-ntpq"></a>
-<h3 class="section">1.1 Invoking ntpq</h3>
-<a name="index-ntpq"></a>
-<a name="index-standard-NTP-query-program"></a>
+<h3 class="section">Invoking ntpq</h3>
+
+<p><a name="index-ntpq-1"></a><a name="index-standard-NTP-query-program-2"></a>
-<p>The
<code>ntpq</code>
utility program is used to query NTP servers which
implement the standard NTP mode 6 control message formats defined
in Appendix B of the NTPv3 specification RFC1305, requesting
-information about current state and/or changes in that state.
+information about current state and/or changes in that state.
The same formats are used in NTPv4, although some of the
variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
+page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
-command line arguments.
+command line arguments.
Requests to read and write arbitrary
variables can be assembled, with raw and pretty-printed output
-options being available.
+options being available.
The
<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
+
+
<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.
+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.
+when no other host is specified.
The
<code>ntpq</code>
utility 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.
+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.
+large distances in terms of network topology.
The
<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>Specifying a
+
command line option other than
<code>-i</code>
or
<code>-n</code>
will
cause the specified query (queries) to be sent to the indicated
-host(s) immediately.
+host(s) immediately.
Otherwise,
<code>ntpq</code>
will attempt to read
interactive format commands from the standard input.
-</p><a name="Internal-Commands-1"></a>
-<h4 class="subsection">1.1.1 Internal Commands</h4>
+
+<h5 class="subsubsection">Internal Commands</h5>
+
<p>Interactive format commands consist of a keyword followed by zero
-to four arguments.
+to four arguments.
Only enough characters of the full keyword to
uniquely identify the command need be typed.
-</p>
-<p>A
+
number of interactive format commands are executed entirely within
the
<code>ntpq</code>
utility itself and do not result in NTP mode 6
-requests being sent to a server.
+requests being sent to a server.
These are described following.
-</p><dl compact="compact">
-<dt><code>?</code> <code>[<kbd>command_keyword</kbd>]</code></dt>
-<dt><code>help</code> <code>[<kbd>command_keyword</kbd>]</code></dt>
-<dd><p>A
+ <dl>
+<dt><code>?</code> <code>[</code><kbd>command_keyword</kbd><code>]</code><br><dt><code>help</code> <code>[</code><kbd>command_keyword</kbd><code>]</code><dd>A
‘?’
by itself will print a list of all the command
keywords known to this incarnation of
A
‘?’
followed by a command keyword will print function and usage
-information about the command.
+information about the command.
This command is probably a better
source of information about
<code>ntpq</code>
than this manual
-page.
-</p></dd>
-<dt><code>addvars</code> <kbd>variable_name</kbd><code>[<code>=value</code>]</code> <code>...</code></dt>
-<dt><code>rmvars</code> <kbd>variable_name</kbd> <code>...</code></dt>
-<dt><code>clearvars</code></dt>
-<dt><code>showvars</code></dt>
-<dd><p>The data carried by NTP mode 6 messages consists of a list of
+page.
+<br><dt><code>addvars</code> <kbd>variable_name</kbd><code>[=value]</code> <code>...</code><br><dt><code>rmvars</code> <kbd>variable_name</kbd> <code>...</code><br><dt><code>clearvars</code><br><dt><code>showvars</code><dd>The data carried by NTP mode 6 messages consists of a list of
items of the form
‘variable_name=value’,
where the
‘=value’
is ignored, and can be omitted,
-in requests to the server to read variables.
+in requests to the server to read variables.
The
<code>ntpq</code>
utility maintains an internal list in which data to be included in control
<code>readlist</code>
and
<code>writelist</code>
-commands described below.
+commands described below.
The
<code>addvars</code>
command allows variables and their optional values to be added to
-the list.
+the list.
If more than one variable is to be added, the list should
-be comma-separated and not contain white space.
+be comma-separated and not contain white space.
The
<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.
+list.
The
<code>showvars</code>
-command displays the current list of optional variables.
-</p></dd>
-<dt><code>authenticate</code> <code>[yes | no]</code></dt>
-<dd><p>Normally
+command displays the current list of optional variables.
+<br><dt><code>authenticate</code> <code>[yes | no]</code><dd>Normally
<code>ntpq</code>
does not authenticate requests unless
-they are write requests.
+they are write requests.
The command
‘authenticate yes’
causes
<code>ntpq</code>
to send authentication with all requests it
-makes.
+makes.
Authenticated requests causes some servers to handle
requests slightly differently, and can occasionally melt the CPU in
fuzzballs if you turn authentication on before doing a
<code>peer</code>
-display.
+display.
The command
‘authenticate’
causes
<code>ntpq</code>
to display whether or not
<code>ntpq</code>
-is currently autheinticating requests.
-</p></dd>
-<dt><code>cooked</code></dt>
-<dd><p>Causes output from query commands to be "cooked", so that
+is currently autheinticating requests.
+<br><dt><code>cooked</code><dd>Causes output from query commands to be "cooked", so that
variables which are recognized by
<code>ntpq</code>
will have their
-values reformatted for human consumption.
+values reformatted for human consumption.
Variables which
<code>ntpq</code>
-thinks should have a decodable value but didn’t are
+thinks should have a decodable value but didn't are
marked with a trailing
-‘?’.
-</p></dd>
-<dt><code>debug</code> <code>[<code>more</code> | <code>less</code> | <code>off</code>]</code></dt>
-<dd><p>With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
-</p></dd>
-<dt><code>delay</code> <kbd>milliseconds</kbd></dt>
-<dd><p>Specify a time interval to be added to timestamps included in
-requests which require authentication.
+‘?’.
+<br><dt><code>debug</code> <code>[more | less | off]</code><dd>With no argument, displays the current debug level.
+Otherwise, the debug level is changed to the indicated level.
+<br><dt><code>delay</code> <kbd>milliseconds</kbd><dd>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.
+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>exit</code></dt>
-<dd><p>Exit
+so this command may be obsolete.
+<br><dt><code>exit</code><dd>Exit
<code>ntpq</code>
-</p></dd>
-<dt><code>host</code> <kbd>hostname</kbd></dt>
-<dd><p>Set the host to which future queries will be sent.
+<br><dt><code>host</code> <kbd>hostname</kbd><dd>Set the host to which future queries will be sent.
<kbd>hostname</kbd>
-may be either a host name or a numeric address.
-</p></dd>
-<dt><code>hostnames</code> <code>[<code>yes</code> | <code>no</code>]</code></dt>
-<dd><p>If
+may be either a host name or a numeric address.
+<br><dt><code>hostnames</code> <code>[yes | no]</code><dd>If
<code>yes</code>
is specified, host names are printed in
-information displays.
+information displays.
If
<code>no</code>
is specified, numeric
-addresses are printed instead.
+addresses are printed instead.
The default is
<code>yes</code>,
unless
modified using the command line
<code>-n</code>
-switch.
-</p></dd>
-<dt><code>keyid</code> <kbd>keyid</kbd></dt>
-<dd><p>This command allows the specification of a key number to be
-used to authenticate configuration requests.
+switch.
+<br><dt><code>keyid</code> <kbd>keyid</kbd><dd>This command allows the specification of a key number to be
+used to authenticate configuration requests.
This must correspond
to the
<code>controlkey</code>
key number the server has been configured to use for this
-purpose.
-</p></dd>
-<dt><code>keytype</code> <code>[<code>md5</code> | <code>OpenSSLDigestType</code>]</code></dt>
-<dd><p>Specify the type of key to use for authenticating requests.
+purpose.
+<br><dt><code>keytype</code> <code>[md5 | OpenSSLDigestType]</code><dd>Specify the type of key to use for authenticating requests.
<code>md5</code>
-is alway supported.
+is alway supported.
If
<code>ntpq</code>
was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+any digest type supported by OpenSSL can also be provided.
If no argument is given, the current
<code>keytype</code>
-is displayed.
-</p></dd>
-<dt><code>ntpversion</code> <code>[<code>1</code> | <code>2</code> | <code>3</code> | <code>4</code>]</code></dt>
-<dd><p>Sets the NTP version number which
+is displayed.
+<br><dt><code>ntpversion</code> <code>[1 | 2 | 3 | 4]</code><dd>Sets the NTP version number which
<code>ntpq</code>
claims in
-packets.
+packets.
Defaults to 3, and note that mode 6 control messages (and
-modes, for that matter) didn’t exist in NTP version 1.
+modes, for that matter) didn't exist in NTP version 1.
There appear
-to be no servers left which demand version 1.
+to be no servers left which demand version 1.
With no argument, displays the current NTP version that will be used
-when communicating with servers.
-</p></dd>
-<dt><code>passwd</code></dt>
-<dd><p>This command prompts you to type in a password (which will not
+when communicating with servers.
+<br><dt><code>passwd</code><dd>This command prompts you to type in a password (which will not
be echoed) which will be used to authenticate configuration
-requests.
+requests.
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
-successful.
+successful.
<code>poll</code>
<kbd>n</kbd>
<code>verbose</code>
-</p></dd>
-<dt><code>quit</code></dt>
-<dd><p>Exit
+<br><dt><code>quit</code><dd>Exit
<code>ntpq</code>
-</p></dd>
-<dt><code>raw</code></dt>
-<dd><p>Causes all output from query commands is printed as received
-from the remote server.
+<br><dt><code>raw</code><dd>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> <kbd>milliseconds</kbd></dt>
-<dd><p>Specify a timeout period for responses to server queries.
+understandable) form.
+<br><dt><code>timeout</code> <kbd>milliseconds</kbd><dd>Specify a timeout period for responses to server queries.
The
-default is about 5000 milliseconds.
+default is about 5000 milliseconds.
Note that since
<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>
-<dd><p>Print the version of the
+a timeout will be twice the timeout value set.
+<br><dt><code>version</code><dd>Print the version of the
<code>ntpq</code>
-program.
-</p></dd>
+program.
</dl>
-<a name="Control-Message-Commands-1"></a>
-<h4 class="subsubsection">1.1.1.1 Control Message Commands</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 peer namespace.
-Most control commands send a single mode-6 message to the server and expect a single response message.
+<h5 class="subsubsection">Control Message Commands</h5>
+
+<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, which sends a series of messages,
and
<code>mreadvar</code>
commands, which iterate over a range of associations.
-</p><dl compact="compact">
-<dt><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></div>
-<dl compact="compact">
-<dt>Sy String 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>persistent,</code> <code>no</code>: <code>ephemeral</code></dt>
-<dt><code>reach</code> <code>Ta</code> <code>yes</code>: <code>reachable,</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>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>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>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>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code></dt>
-</dl>
-</dd>
-<dt><code>authinfo</code></dt>
-<dd><p>Display the authentication statistics.
-</p></dd>
-<dt><code>clockvar</code> <kbd>assocID</kbd> <code>[<kbd>name</kbd><code>[<code>=</code><kbd>value</kbd>]</code>]</code> <code>[...]</code></dt>
-<dt><code>cv</code> <kbd>assocID</kbd> <code>[<kbd>name</kbd><code>[<code>=</code><kbd>value</kbd>]</code>]</code> <code>[...]</code></dt>
-<dd><p>Display a list of clock variables for those associations supporting a reference clock.
-</p></dd>
-<dt><code>:config</code> <code>[...]</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 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>
-<dd><p>Send the each line of
+ <dl>
+<dt><code>associations</code><dd>Display a list of mobilized associations in the form:
+ <pre class="example"> ind assid status conf reach auth condition last_event cnt
+</pre>
+ <dl>
+<dt>Sy String Ta Sy Description<br><dt><code>ind</code> <code>Ta</code> <code>index</code> <code>on</code> <code>this</code> <code>list</code><br><dt><code>assid</code> <code>Ta</code> <code>association</code> <code>ID</code><br><dt><code>status</code> <code>Ta</code> <code>peer</code> <code>status</code> <code>word</code><br><dt><code>conf</code> <code>Ta</code> <code>yes</code>: <code>persistent,</code> <code>no</code>: <code>ephemeral</code><br><dt><code>reach</code> <code>Ta</code> <code>yes</code>: <code>reachable,</code> <code>no</code>: <code>unreachable</code><br><dt><code>auth</code> <code>Ta</code> <code>ok</code>, <code>yes</code>, <code>bad</code> <code>and</code> <code>none</code><br><dt><code>condition</code> <code>Ta</code> <code>selection</code> <code>status</code> <code>(see</code> <code>the</code> <code>select</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>last_event</code> <code>Ta</code> <code>event</code> <code>report</code> <code>(see</code> <code>the</code> <code>event</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>cnt</code> <code>Ta</code> <code>event</code> <code>count</code> <code>(see</code> <code>the</code> <code>count</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><dd></dl>
+ <br><dt><code>authinfo</code><dd>Display the authentication statistics.
+<br><dt><code>clockvar</code> <kbd>assocID</kbd> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code> <code>[...]</code><br><dt><code>cv</code> <kbd>assocID</kbd> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code> <code>[...]</code><dd>Display a list of clock variables for those associations supporting a reference clock.
+<br><dt><code>:config</code> <code>[...]</code><dd>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.
+<br><dt><code>config-from-file</code> <kbd>filename</kbd><dd>Send the each line of
<kbd>filename</kbd>
-to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
-</p></dd>
-<dt><code>ifstats</code></dt>
-<dd><p>Display statistics for each local network address. Authentication is required.
-</p></dd>
-<dt><code>iostats</code></dt>
-<dd><p>Display network and reference clock I/O statistics.
-</p></dd>
-<dt><code>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>lassociations</code></dt>
-<dd><p>Perform the same function as the associations command, except display mobilized and unmobilized associations.
-</p></dd>
-<dt><code>lopeers</code> <code>[<code>-4</code> | <code>-6</code>]</code></dt>
-<dd><p>Obtain and print a list of all peers and clients showing
+to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+<br><dt><code>ifstats</code><dd>Display statistics for each local network address. Authentication is required.
+<br><dt><code>iostats</code><dd>Display network and reference clock I/O statistics.
+<br><dt><code>kerninfo</code><dd>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.
+<br><dt><code>lassociations</code><dd>Perform the same function as the associations command, except display mobilized and unmobilized associations.
+<br><dt><code>lopeers</code> <code>[-4 | -6]</code><dd>Obtain and print a list of all peers and clients showing
<kbd>dstadr</kbd>
-(associated with any given IP version).
-</p></dd>
-<dt><code>lpeers</code> <code>[<code>-4</code> | <code>-6</code>]</code></dt>
-<dd><p>Print a peer spreadsheet for the appropriate IP version(s).
+(associated with any given IP version).
+<br><dt><code>lpeers</code> <code>[-4 | -6]</code><dd>Print a peer spreadsheet for the appropriate IP version(s).
<kbd>dstadr</kbd>
-(associated with any given IP version).
-</p></dd>
-<dt><code>monstats</code></dt>
-<dd><p>Display monitor facility statistics.
-</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>=<kbd>sortorder</kbd> | <code>resany</code>=<kbd>hexmask</kbd> | <code>resall</code>=<kbd>hexmask</kbd>]</code></dt>
-<dd><p>Obtain and print traffic counts collected and maintained by the monitor facility.
+(associated with any given IP version).
+<br><dt><code>monstats</code><dd>Display monitor facility statistics.
+<br><dt><code>mrulist</code> <code>[limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Obtain and print traffic counts collected and maintained by the monitor facility.
With the exception of
<code>sort</code>=<kbd>sortorder</kbd>,
the options filter the list returned by
<code>limited</code>
and
<code>kod</code>
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+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>
option filters entries representing less than
<kbd>count</kbd>
-packets.
+packets.
The
<code>laddr</code>=<kbd>localaddr</kbd>
option filters entries for packets received on any local address other than
-<kbd>localaddr</kbd>.
+<kbd>localaddr</kbd>.
<code>resany</code>=<kbd>hexmask</kbd>
and
<code>resall</code>=<kbd>hexmask</kbd>
filter entries containing none or less than all, respectively, of the bits in
<kbd>hexmask</kbd>,
which must begin with
-<code>0x</code>.
+<code>0x</code>.
The
<kbd>sortorder</kbd>
defaults to
<code>count</code>,
<code>avgint</code>,
<code>lstint</code>,
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by a minus sign (hyphen) to reverse the sort order.
The output columns are:
-</p><dl compact="compact">
-<dt>Column</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>lstint</code></dt>
-<dd><p>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
+ <dl>
+<dt>Column<dd>Description
+<br><dt><code>lstint</code><dd>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>
-</p></dd>
-<dt><code>avgint</code></dt>
-<dd><p>Average interval in s between packets from this address.
-</p></dd>
-<dt><code>rstr</code></dt>
-<dd><p>Restriction flags associated with this address.
+<br><dt><code>avgint</code><dd>Average interval in s between packets from this address.
+<br><dt><code>rstr</code><dd>Restriction flags associated with this address.
Most are copied unchanged from the matching
<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>
-<dd><p>Rate control indicator, either
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+<br><dt><code>r</code><dd>Rate control indicator, either
a period,
<code>L</code>
or
<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>
-<dd><p>Packet mode.
-</p></dd>
-<dt><code>v</code></dt>
-<dd><p>Packet version number.
-</p></dd>
-<dt><code>count</code></dt>
-<dd><p>Packets received from this address.
-</p></dd>
-<dt><code>rport</code></dt>
-<dd><p>Source port of last packet from this address.
-</p></dd>
-<dt><code>remote</code> <code>address</code></dt>
-<dd><p>DNS name, numeric address, or address followed by
-claimed DNS name which could not be verified in parentheses.
-</p></dd>
+rate limiting by discarding, or rate limiting with a KoD response, respectively.
+<br><dt><code>m</code><dd>Packet mode.
+<br><dt><code>v</code><dd>Packet version number.
+<br><dt><code>count</code><dd>Packets received from this address.
+<br><dt><code>rport</code><dd>Source port of last packet from this address.
+<br><dt><code>remote</code> <code>address</code><dd>DNS name, numeric address, or address followed by
+claimed DNS name which could not be verified in parentheses.
</dl>
-</dd>
-<dt><code>mreadvar</code> <code>assocID</code> <code>assocID</code> <code>[<kbd>variable_name</kbd><code>[=<kbd>value</kbd>]</code> ...]</code></dt>
-<dt><code>mrv</code> <code>assocID</code> <code>assocID</code> <code>[<kbd>variable_name</kbd><code>[=<kbd>value</kbd>]</code> ...]</code></dt>
-<dd><p>Perform the same function as the
+ <br><dt><code>mreadvar</code> <code>assocID</code> <code>assocID</code> <code>[</code><kbd>variable_name</kbd><code>[=</code><kbd>value</kbd><code>] ...]</code><br><dt><code>mrv</code> <code>assocID</code> <code>assocID</code> <code>[</code><kbd>variable_name</kbd><code>[=</code><kbd>value</kbd><code>] ...]</code><dd>Perform the same function as the
<code>readvar</code>
-command, except for a range of association IDs.
+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.
-</p></dd>
-<dt><code>opeers</code> <code>[<code>-4</code> | <code>-6</code>]</code></dt>
-<dd><p>Obtain and print the old-style list of all peers and clients showing
+command.
+<br><dt><code>opeers</code> <code>[-4 | -6]</code><dd>Obtain and print the old-style list of all peers and clients showing
<kbd>dstadr</kbd>
(associated with any given IP version),
rather than the
-<kbd>refid</kbd>.
-</p></dd>
-<dt><code>passociations</code></dt>
-<dd><p>Perform the same function as the
+<kbd>refid</kbd>.
+<br><dt><code>passociations</code><dd>Perform the same function as the
<code>associations</code>
command,
-except that it uses previously stored data rather than making a new query.
-</p></dd>
-<dt><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></div>
-<dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>[tally]</code></dt>
-<dd><p>single-character code indicating current value of the
+except that it uses previously stored data rather than making a new query.
+<br><dt><code>peers</code><dd>Display a list of peers in the form:
+ <pre class="example"> [tally]remote refid st t when pool reach delay offset jitter
+</pre>
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>[tally]</code><dd>single-character code indicating current value of the
<code>select</code>
field of the
-.Lk decode.html#peer "peer status word"
-</p></dd>
-<dt><code>remote</code></dt>
-<dd><p>host name (or IP number) of peer.
+.Lk decode.html#peer "peer status word"
+<br><dt><code>remote</code><dd>host name (or IP number) of peer.
The value displayed will be truncated to 15 characters unless the
<code>-w</code>
flag is given, in which case the full value will be displayed
on the first line,
-and the remaining data is displayed on the next line.
-</p></dd>
-<dt><code>refid</code></dt>
-<dd><p>association ID or
-.Lk decode.html#kiss "’kiss code"
-</p></dd>
-<dt><code>st</code></dt>
-<dd><p>stratum
-</p></dd>
-<dt><code>t</code></dt>
-<dd><p><code>u</code>:
+and the remaining data is displayed on the next line.
+<br><dt><code>refid</code><dd>association ID or
+.Lk decode.html#kiss "'kiss code"
+<br><dt><code>st</code><dd>stratum
+<br><dt><code>t</code><dd><code>u</code>:
unicast or manycast client,
<code>b</code>:
broadcast or multicast client,
broadcast server,
<code>M</code>:
multicast server
-</p></dd>
-<dt><code>when</code></dt>
-<dd><p>sec/min/hr since last received packet
-</p></dd>
-<dt><code>poll</code></dt>
-<dd><p>poll interval (log2 s)
-</p></dd>
-<dt><code>reach</code></dt>
-<dd><p>reach shift register (octal)
-</p></dd>
-<dt><code>delay</code></dt>
-<dd><p>roundtrip delay
-</p></dd>
-<dt><code>offset</code></dt>
-<dd><p>offset of server relative to this host
-</p></dd>
-<dt><code>jitter</code></dt>
-<dd><p>jitter
-</p></dd>
+<br><dt><code>when</code><dd>sec/min/hr since last received packet
+<br><dt><code>poll</code><dd>poll interval (log2 s)
+<br><dt><code>reach</code><dd>reach shift register (octal)
+<br><dt><code>delay</code><dd>roundtrip delay
+<br><dt><code>offset</code><dd>offset of server relative to this host
+<br><dt><code>jitter</code><dd>jitter
</dl>
-</dd>
-<dt><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></div>
-<p>where the output is just like the
+ <br><dt><code>apeers</code><dd>Display a list of peers in the form:
+ <pre class="example"> [tally]remote refid assid st t when pool reach delay offset jitter
+</pre>
+ <p>where the output is just like the
<code>peers</code>
command except that the
<code>refid</code>
-is displayed in hex format and the association number is also displayed.
-</p></dd>
-<dt><code>pstats</code> <kbd>assocID</kbd></dt>
-<dd><p>Show the statistics for the peer with the given
-<kbd>assocID</kbd>.
-</p></dd>
-<dt><code>readlist</code> <kbd>assocID</kbd></dt>
-<dt><code>rl</code> <kbd>assocID</kbd></dt>
-<dd><p>Read the system or peer variables included in the variable list.
-</p></dd>
-<dt><code>readvar</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=<kbd>value</kbd>]</code> <code>[, ...]</code></dt>
-<dt><code>rv</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=<kbd>value</kbd>]</code> <code>[, ...]</code></dt>
-<dd><p>Display the specified variables.
+is displayed in hex format and the association number is also displayed.
+<br><dt><code>pstats</code> <kbd>assocID</kbd><dd>Show the statistics for the peer with the given
+<kbd>assocID</kbd>.
+<br><dt><code>readlist</code> <kbd>assocID</kbd><br><dt><code>rl</code> <kbd>assocID</kbd><dd>Read the system or peer variables included in the variable list.
+<br><dt><code>readvar</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code> <code>[, ...]</code><br><dt><code>rv</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code> <code>[, ...]</code><dd>Display the specified variables.
If
<kbd>assocID</kbd>
is zero, the variables are from the
<a href="#System-Variables">System Variables</a>
name space, otherwise they are from the
<a href="#Peer-Variables">Peer Variables</a>
-name space.
+name space.
The
<kbd>assocID</kbd>
-is required, as the same name can occur in both spaces.
+is required, as the same name can occur in both spaces.
If no
<kbd>name</kbd>
is included, all operative variables in the name space are displayed.
-</p>
-<p>In this case only, if the
+
+
<p>In this case only, if the
<kbd>assocID</kbd>
-is omitted, it is assumed zero.
-Multiple names are specified with comma separators and without whitespace.
+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).
+and frequency values in parts-per-million (PPM).
Some NTP timestamps are represented in the format
YYYYMMDDTTTT ,
where YYYY is the year,
MM the month of year,
DD the day of month and
-TTTT the time of day.
-</p></dd>
-<dt><code>reslist</code></dt>
-<dd><p>Show the access control (restrict) list for
+TTTT the time of day.
+<br><dt><code>reslist</code><dd>Show the access control (restrict) list for
<code>ntpq</code>
-</p>
-</dd>
-<dt><code>saveconfig</code> <kbd>filename</kbd></dt>
-<dd><p>Write the current configuration,
+
+ <br><dt><code>saveconfig</code> <kbd>filename</kbd><dd>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>.
+to the ntpd host's file
+<kbd>filename</kbd>.
This command will be rejected by the server unless
-.Lk miscopt.html#saveconfigdir "saveconfigdir"
+.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
<code>ntpd</code>
-configuration file.
+configuration file.
<kbd>filename</kbd>
can use
<code>strftime()</code>
format specifies to substitute the current date and time, for example,
-<code>q]saveconfig</code> <code>ntp-%Y%m%d-%H%M%S.confq]</code>.
+<code>q]saveconfig</code> <code>ntp-%Y%m%d-%H%M%S.confq]</code>.
The filename used is stored in system variable
-<code>savedconfig</code>.
-Authentication is required.
-</p></dd>
-<dt><code>timerstats</code></dt>
-<dd><p>Display interval timer counters.
-</p></dd>
-<dt><code>writelist</code> <kbd>assocID</kbd></dt>
-<dd><p>Write the 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>
-<dd><p>Write the specified variables.
+<code>savedconfig</code>.
+Authentication is required.
+<br><dt><code>timerstats</code><dd>Display interval timer counters.
+<br><dt><code>writelist</code> <kbd>assocID</kbd><dd>Write the system or peer variables included in the variable list.
+<br><dt><code>writevar</code> <kbd>assocID</kbd> <kbd>name</kbd>=<kbd>value</kbd> <code>[, ...]</code><dd>Write the specified variables.
If the
<kbd>assocID</kbd>
is zero, the variables are from the
<a href="#System-Variables">System Variables</a>
name space, otherwise they are from the
<a href="#Peer-Variables">Peer Variables</a>
-name space.
+name space.
The
<kbd>assocID</kbd>
-is required, as the same name can occur in both spaces.
-</p></dd>
-<dt><code>sysinfo</code></dt>
-<dd><p>Display operational summary.
-</p></dd>
-<dt><code>sysstats</code></dt>
-<dd><p>Print statistics counters maintained in the protocol module.
-</p></dd>
+is required, as the same name can occur in both spaces.
+<br><dt><code>sysinfo</code><dd>Display operational summary.
+<br><dt><code>sysstats</code><dd>Print statistics counters maintained in the protocol module.
</dl>
-<a name="Status-Words-and-Kiss-Codes-1"></a>
-<h4 class="subsubsection">1.1.1.2 Status Words and Kiss Codes</h4>
+<h5 class="subsubsection">Status Words and Kiss Codes</h5>
<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.
+maintained by the system.
+Status information is also available on a per-association basis.
These words are displayed in the
<code>rv</code>
and
<code>as</code>
-commands both in hexadecimal and in decoded short tip strings.
+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"
-page.
+.Lk decode.html "Event Messages and Status Words"
+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
+
+
<p>Information resulting from protocol machine state transitions
is displayed using an informal set of ASCII strings called
-.Lk decode.html#kiss "kiss codes" .
-The original purpose was for kiss-o’-death (KoD) packets
-sent by the server to advise the client of an unusual condition.
+.Lk decode.html#kiss "kiss codes" .
+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>
-<a name="System-Variables-1"></a>
-<h4 class="subsubsection">1.1.1.3 System Variables</h4>
+
+<h5 class="subsubsection">System Variables</h5>
+
<p>The following system variables appear in the
<code>rv</code>
-billboard.
+billboard.
Not all variables are displayed in some configurations.
-</p><dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>status</code></dt>
-<dd><p>.Lk decode.html#sys "system status word"
-</p></dd>
-<dt><code>version</code></dt>
-<dd><p>NTP software version and build time
-</p></dd>
-<dt><code>processor</code></dt>
-<dd><p>hardware platform and version
-</p></dd>
-<dt><code>system</code></dt>
-<dd><p>operating system and version
-</p></dd>
-<dt><code>leap</code></dt>
-<dd><p>leap warning indicator (0-3)
-</p></dd>
-<dt><code>stratum</code></dt>
-<dd><p>stratum (1-15)
-</p></dd>
-<dt><code>precision</code></dt>
-<dd><p>precision (log2 s)
-</p></dd>
-<dt><code>rootdelay</code></dt>
-<dd><p>total roundtrip delay to the primary reference clock
-</p></dd>
-<dt><code>rootdisp</code></dt>
-<dd><p>total dispersion to the primary reference clock
-</p></dd>
-<dt><code>peer</code></dt>
-<dd><p>system peer association ID
-</p></dd>
-<dt><code>tc</code></dt>
-<dd><p>time constant and poll exponent (log2 s) (3-17)
-</p></dd>
-<dt><code>mintc</code></dt>
-<dd><p>minimum time constant (log2 s) (3-10)
-</p></dd>
-<dt><code>clock</code></dt>
-<dd><p>date and time of day
-</p></dd>
-<dt><code>refid</code></dt>
-<dd><p>reference ID or
-.Lk decode.html#kiss "kiss code"
-</p></dd>
-<dt><code>reftime</code></dt>
-<dd><p>reference time
-</p></dd>
-<dt><code>offset</code></dt>
-<dd><p>combined offset of server relative to this host
-</p></dd>
-<dt><code>sys_jitter</code></dt>
-<dd><p>combined system jitter
-</p></dd>
-<dt><code>frequency</code></dt>
-<dd><p>frequency offset (PPM) relative to hardware clock
-</p></dd>
-<dt><code>clk_wander</code></dt>
-<dd><p>clock frequency wander (PPM)
-</p></dd>
-<dt><code>clk_jitter</code></dt>
-<dd><p>clock jitter
-</p></dd>
-<dt><code>tai</code></dt>
-<dd><p>TAI-UTC offset (s)
-</p></dd>
-<dt><code>leapsec</code></dt>
-<dd><p>NTP seconds when the next leap second is/was inserted
-</p></dd>
-<dt><code>expire</code></dt>
-<dd><p>NTP seconds when the NIST leapseconds file expires
-</p></dd>
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>status</code><dd>.Lk decode.html#sys "system status word"
+<br><dt><code>version</code><dd>NTP software version and build time
+<br><dt><code>processor</code><dd>hardware platform and version
+<br><dt><code>system</code><dd>operating system and version
+<br><dt><code>leap</code><dd>leap warning indicator (0-3)
+<br><dt><code>stratum</code><dd>stratum (1-15)
+<br><dt><code>precision</code><dd>precision (log2 s)
+<br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock
+<br><dt><code>rootdisp</code><dd>total dispersion to the primary reference clock
+<br><dt><code>peer</code><dd>system peer association ID
+<br><dt><code>tc</code><dd>time constant and poll exponent (log2 s) (3-17)
+<br><dt><code>mintc</code><dd>minimum time constant (log2 s) (3-10)
+<br><dt><code>clock</code><dd>date and time of day
+<br><dt><code>refid</code><dd>reference ID or
+.Lk decode.html#kiss "kiss code"
+<br><dt><code>reftime</code><dd>reference time
+<br><dt><code>offset</code><dd>combined offset of server relative to this host
+<br><dt><code>sys_jitter</code><dd>combined system jitter
+<br><dt><code>frequency</code><dd>frequency offset (PPM) relative to hardware clock
+<br><dt><code>clk_wander</code><dd>clock frequency wander (PPM)
+<br><dt><code>clk_jitter</code><dd>clock jitter
+<br><dt><code>tai</code><dd>TAI-UTC offset (s)
+<br><dt><code>leapsec</code><dd>NTP seconds when the next leap second is/was inserted
+<br><dt><code>expire</code><dd>NTP seconds when the NIST leapseconds file expires
</dl>
-<p>The jitter and wander statistics are exponentially-weighted RMS averages.
+ The jitter and wander statistics are exponentially-weighted RMS averages.
The system jitter is defined in the NTPv4 specification;
the clock jitter statistic is computed by the clock discipline module.
-</p>
-<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
+
+
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional system variables are displayed,
including some or all of the following,
depending on the particular Autokey dance:
-</p>
-<dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>host</code></dt>
-<dd><p>Autokey host name for this host
-</p></dd>
-<dt><code>ident</code></dt>
-<dd><p>Autokey group name for this host
-</p></dd>
-<dt><code>flags</code></dt>
-<dd><p>host flags (see Autokey specification)
-</p></dd>
-<dt><code>digest</code></dt>
-<dd><p>OpenSSL message digest algorithm
-</p></dd>
-<dt><code>signature</code></dt>
-<dd><p>OpenSSL digest/signature scheme
-</p></dd>
-<dt><code>update</code></dt>
-<dd><p>NTP seconds at last signature update
-</p></dd>
-<dt><code>cert</code></dt>
-<dd><p>certificate subject, issuer and certificate flags
-</p></dd>
-<dt><code>until</code></dt>
-<dd><p>NTP seconds when the certificate expires
-</p></dd>
+
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>host</code><dd>Autokey host name for this host
+<br><dt><code>ident</code><dd>Autokey group name for this host
+<br><dt><code>flags</code><dd>host flags (see Autokey specification)
+<br><dt><code>digest</code><dd>OpenSSL message digest algorithm
+<br><dt><code>signature</code><dd>OpenSSL digest/signature scheme
+<br><dt><code>update</code><dd>NTP seconds at last signature update
+<br><dt><code>cert</code><dd>certificate subject, issuer and certificate flags
+<br><dt><code>until</code><dd>NTP seconds when the certificate expires
</dl>
-<a name="Peer-Variables-1"></a>
-<h4 class="subsubsection">1.1.1.4 Peer Variables</h4>
+
+<h5 class="subsubsection">Peer Variables</h5>
+
<p>The following peer variables appear in the
<code>rv</code>
-billboard for each association.
+billboard for each association.
Not all variables are displayed in some configurations.
-</p>
-<dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>associd</code></dt>
-<dd><p>association ID
-</p></dd>
-<dt><code>status</code></dt>
-<dd><p>.Lk decode.html#peer "peer status word"
-</p></dd>
-<dt><code>srcadr</code></dt>
-<dd><p>source (remote) IP address
-</p></dd>
-<dt><code>srcport</code></dt>
-<dd><p>source (remote) port
-</p></dd>
-<dt><code>dstadr</code></dt>
-<dd><p>destination (local) IP address
-</p></dd>
-<dt><code>dstport</code></dt>
-<dd><p>destination (local) port
-</p></dd>
-<dt><code>leap</code></dt>
-<dd><p>leap indicator (0-3)
-</p></dd>
-<dt><code>stratum</code></dt>
-<dd><p>stratum (0-15)
-</p></dd>
-<dt><code>precision</code></dt>
-<dd><p>precision (log2 s)
-</p></dd>
-<dt><code>rootdelay</code></dt>
-<dd><p>total roundtrip delay to the primary reference clock
-</p></dd>
-<dt><code>rootdisp</code></dt>
-<dd><p>total root dispersion to the primary reference clock
-</p></dd>
-<dt><code>refid</code></dt>
-<dd><p>reference ID or
-.Lk decode.html#kiss "kiss code"
-</p></dd>
-<dt><code>reftime</code></dt>
-<dd><p>reference time
-</p></dd>
-<dt><code>reach</code></dt>
-<dd><p>reach register (octal)
-</p></dd>
-<dt><code>unreach</code></dt>
-<dd><p>unreach counter
-</p></dd>
-<dt><code>hmode</code></dt>
-<dd><p>host mode (1-6)
-</p></dd>
-<dt><code>pmode</code></dt>
-<dd><p>peer mode (1-5)
-</p></dd>
-<dt><code>hpoll</code></dt>
-<dd><p>host poll exponent (log2 s) (3-17)
-</p></dd>
-<dt><code>ppoll</code></dt>
-<dd><p>peer poll exponent (log2 s) (3-17)
-</p></dd>
-<dt><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>
-<dd><p>.Lk decode.html#flash "flash status word"
-</p></dd>
-<dt><code>offset</code></dt>
-<dd><p>filter offset
-</p></dd>
-<dt><code>delay</code></dt>
-<dd><p>filter delay
-</p></dd>
-<dt><code>dispersion</code></dt>
-<dd><p>filter dispersion
-</p></dd>
-<dt><code>jitter</code></dt>
-<dd><p>filter jitter
-</p></dd>
-<dt><code>ident</code></dt>
-<dd><p>Autokey group name for this association
-</p></dd>
-<dt><code>bias</code></dt>
-<dd><p>unicast/broadcast bias
-</p></dd>
-<dt><code>xleave</code></dt>
-<dd><p>interleave delay (see
-.Lk xleave.html "NTP Interleaved Modes" )
-</p></dd>
+
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>associd</code><dd>association ID
+<br><dt><code>status</code><dd>.Lk decode.html#peer "peer status word"
+<br><dt><code>srcadr</code><dd>source (remote) IP address
+<br><dt><code>srcport</code><dd>source (remote) port
+<br><dt><code>dstadr</code><dd>destination (local) IP address
+<br><dt><code>dstport</code><dd>destination (local) port
+<br><dt><code>leap</code><dd>leap indicator (0-3)
+<br><dt><code>stratum</code><dd>stratum (0-15)
+<br><dt><code>precision</code><dd>precision (log2 s)
+<br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock
+<br><dt><code>rootdisp</code><dd>total root dispersion to the primary reference clock
+<br><dt><code>refid</code><dd>reference ID or
+.Lk decode.html#kiss "kiss code"
+<br><dt><code>reftime</code><dd>reference time
+<br><dt><code>reach</code><dd>reach register (octal)
+<br><dt><code>unreach</code><dd>unreach counter
+<br><dt><code>hmode</code><dd>host mode (1-6)
+<br><dt><code>pmode</code><dd>peer mode (1-5)
+<br><dt><code>hpoll</code><dd>host poll exponent (log2 s) (3-17)
+<br><dt><code>ppoll</code><dd>peer poll exponent (log2 s) (3-17)
+<br><dt><code>headway</code><dd>headway (see
+.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
+<br><dt><code>flash</code><dd>.Lk decode.html#flash "flash status word"
+<br><dt><code>offset</code><dd>filter offset
+<br><dt><code>delay</code><dd>filter delay
+<br><dt><code>dispersion</code><dd>filter dispersion
+<br><dt><code>jitter</code><dd>filter jitter
+<br><dt><code>ident</code><dd>Autokey group name for this association
+<br><dt><code>bias</code><dd>unicast/broadcast bias
+<br><dt><code>xleave</code><dd>interleave delay (see
+.Lk xleave.html "NTP Interleaved Modes" )
</dl>
-<p>The
+ The
<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.
+after the calibration volley.
+It represents the offset of the broadcast subgraph relative to the unicast subgraph.
The
<code>xleave</code>
-variable appears only for the interleaved symmetric and interleaved modes.
+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,
+
+
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional peer variables are displayed, including the following:
-</p><dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>flags</code></dt>
-<dd><p>peer flags (see Autokey specification)
-</p></dd>
-<dt><code>host</code></dt>
-<dd><p>Autokey server name
-</p></dd>
-<dt><code>flags</code></dt>
-<dd><p>peer flags (see Autokey specification)
-</p></dd>
-<dt><code>signature</code></dt>
-<dd><p>OpenSSL digest/signature scheme
-</p></dd>
-<dt><code>initsequence</code></dt>
-<dd><p>initial key ID
-</p></dd>
-<dt><code>initkey</code></dt>
-<dd><p>initial key index
-</p></dd>
-<dt><code>timestamp</code></dt>
-<dd><p>Autokey signature timestamp
-</p></dd>
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>flags</code><dd>peer flags (see Autokey specification)
+<br><dt><code>host</code><dd>Autokey server name
+<br><dt><code>flags</code><dd>peer flags (see Autokey specification)
+<br><dt><code>signature</code><dd>OpenSSL digest/signature scheme
+<br><dt><code>initsequence</code><dd>initial key ID
+<br><dt><code>initkey</code><dd>initial key index
+<br><dt><code>timestamp</code><dd>Autokey signature timestamp
</dl>
-<a name="Clock-Variables-1"></a>
-<h4 class="subsubsection">1.1.1.5 Clock Variables</h4>
+<h5 class="subsubsection">Clock Variables</h5>
+
<p>The following clock variables appear in the
<code>cv</code>
-billboard for each association with a reference clock.
+billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
-</p><dl compact="compact">
-<dt>Variable</dt>
-<dd><p>Description
-</p></dd>
-<dt><code>associd</code></dt>
-<dd><p>association ID
-</p></dd>
-<dt><code>status</code></dt>
-<dd><p>.Lk decode.html#clock "clock status word"
-</p></dd>
-<dt><code>device</code></dt>
-<dd><p>device description
-</p></dd>
-<dt><code>timecode</code></dt>
-<dd><p>ASCII time code string (specific to device)
-</p></dd>
-<dt><code>poll</code></dt>
-<dd><p>poll messages sent
-</p></dd>
-<dt><code>noreply</code></dt>
-<dd><p>no reply
-</p></dd>
-<dt><code>badformat</code></dt>
-<dd><p>bad format
-</p></dd>
-<dt><code>baddata</code></dt>
-<dd><p>bad date or time
-</p></dd>
-<dt><code>fudgetime1</code></dt>
-<dd><p>fudge time 1
-</p></dd>
-<dt><code>fudgetime2</code></dt>
-<dd><p>fudge time 2
-</p></dd>
-<dt><code>stratum</code></dt>
-<dd><p>driver stratum
-</p></dd>
-<dt><code>refid</code></dt>
-<dd><p>driver reference ID
-</p></dd>
-<dt><code>flags</code></dt>
-<dd><p>driver flags
-</p></dd>
+ <dl>
+<dt>Variable<dd>Description
+<br><dt><code>associd</code><dd>association ID
+<br><dt><code>status</code><dd>.Lk decode.html#clock "clock status word"
+<br><dt><code>device</code><dd>device description
+<br><dt><code>timecode</code><dd>ASCII time code string (specific to device)
+<br><dt><code>poll</code><dd>poll messages sent
+<br><dt><code>noreply</code><dd>no reply
+<br><dt><code>badformat</code><dd>bad format
+<br><dt><code>baddata</code><dd>bad date or time
+<br><dt><code>fudgetime1</code><dd>fudge time 1
+<br><dt><code>fudgetime2</code><dd>fudge time 2
+<br><dt><code>stratum</code><dd>driver stratum
+<br><dt><code>refid</code><dd>driver reference ID
+<br><dt><code>flags</code><dd>driver flags
</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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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-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>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntpq-usage">ntpq usage</a>: ntpq help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntpq-ipv4">ntpq ipv4</a>: ipv4 option (-4)
+<li><a accesskey="3" href="#ntpq-ipv6">ntpq ipv6</a>: ipv6 option (-6)
+<li><a accesskey="4" href="#ntpq-command">ntpq command</a>: command option (-c)
+<li><a accesskey="5" href="#ntpq-interactive">ntpq interactive</a>: interactive option (-i)
+<li><a accesskey="6" href="#ntpq-numeric">ntpq numeric</a>: numeric option (-n)
+<li><a accesskey="7" href="#ntpq-old_002drv">ntpq old-rv</a>: old-rv option
+<li><a accesskey="8" href="#ntpq-peers">ntpq peers</a>: peers option (-p)
+<li><a accesskey="9" href="#ntpq-refid">ntpq refid</a>: refid option (-r)
+<li><a href="#ntpq-wide">ntpq wide</a>: wide option (-w)
+<li><a href="#ntpq-config">ntpq config</a>: presetting/configuring ntpq
+<li><a href="#ntpq-exit-status">ntpq exit status</a>: exit status
+</ul>
+
+<div class="node">
<a name="ntpq-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-ipv4">ntpq ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="ntpq-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.1.2 ntpq help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">ntpq help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntpq-help-3"></a>
+This is the automatically generated usage text for ntpq.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
Usage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
Flg Arg Option-Name Description
- reading file ./.ntprc
- examining environment variables named NTPQ_*
-The valid "refid" option keywords are:
+The valid "refid" option keywords are:
hash ipv4
or an integer from 0 through 1
Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org>
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<a name="ntpq-ipv4"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-ipv6">ntpq ipv6</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-usage">ntpq usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="ipv4-option-_0028_002d4_0029"></a>
-<h4 class="subsection">1.1.3 ipv4 option (-4)</h4>
-<a name="index-ntpq_002dipv4"></a>
-
-<p>This is the “force ipv4 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv4 option (-4)</h4>
+
+<p><a name="index-ntpq_002dipv4-4"></a>
+This is the “force ipv4 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv6.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv4 namespace.
+<div class="node">
<a name="ntpq-ipv6"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-command">ntpq command</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-ipv4">ntpq ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="ipv6-option-_0028_002d6_0029"></a>
-<h4 class="subsection">1.1.4 ipv6 option (-6)</h4>
-<a name="index-ntpq_002dipv6"></a>
-
-<p>This is the “force ipv6 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv6 option (-6)</h4>
+
+<p><a name="index-ntpq_002dipv6-5"></a>
+This is the “force ipv6 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv4.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+to the IPv6 namespace.
+<div class="node">
<a name="ntpq-command"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-interactive">ntpq interactive</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-ipv6">ntpq ipv6</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="command-option-_0028_002dc_0029"></a>
-<h4 class="subsection">1.1.5 command option (-c)</h4>
-<a name="index-ntpq_002dcommand"></a>
-
-<p>This is the “run a command and exit” option.
-This option takes a string argument <samp>cmd</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>The following argument is interpreted as an interactive format command
+
+<h4 class="subsection">command option (-c)</h4>
+
+<p><a name="index-ntpq_002dcommand-6"></a>
+This is the “run a command and exit” option.
+This option takes a string argument <samp><span class="file">cmd</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</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>
+host(s).
+<div class="node">
<a name="ntpq-interactive"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-numeric">ntpq numeric</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-command">ntpq command</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="interactive-option-_0028_002di_0029"></a>
-<h4 class="subsection">1.1.6 interactive option (-i)</h4>
-<a name="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:
-<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.
+
+<h4 class="subsection">interactive option (-i)</h4>
+
+<p><a name="index-ntpq_002dinteractive-7"></a>
+This is the “force ntpq to operate in interactive mode” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+command, peers.
+</ul>
+
+ <p>Force <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>
+commands read from the standard input.
+<div class="node">
<a name="ntpq-numeric"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-old_002drv">ntpq old-rv</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-interactive">ntpq interactive</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="numeric-option-_0028_002dn_0029"></a>
-<h4 class="subsection">1.1.7 numeric option (-n)</h4>
-<a name="index-ntpq_002dnumeric"></a>
-<p>This is the “numeric host addresses” option.
+<h4 class="subsection">numeric option (-n)</h4>
+
+<p><a name="index-ntpq_002dnumeric-8"></a>
+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>
+<div class="node">
+<a name="ntpq-old-rv"></a>
<a name="ntpq-old_002drv"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-peers">ntpq peers</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-numeric">ntpq numeric</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="old_002drv-option"></a>
-<h4 class="subsection">1.1.8 old-rv option</h4>
-<a name="index-ntpq_002dold_002drv"></a>
-<p>This is the “always output status line with readvar” option.
+<h4 class="subsection">old-rv option</h4>
+
+<p><a name="index-ntpq_002dold_002drv-9"></a>
+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>.
+<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>.
+for a single-variable <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.
-</p><hr>
+newer <code>ntpq</code> to behave identically in this regard.
+<div class="node">
<a name="ntpq-peers"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-refid">ntpq refid</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-old_002drv">ntpq old-rv</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="peers-option-_0028_002dp_0029"></a>
-<h4 class="subsection">1.1.9 peers option (-p)</h4>
-<a name="index-ntpq_002dpeers"></a>
-
-<p>This is the “print a list of the peers” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">peers option (-p)</h4>
+
+<p><a name="index-ntpq_002dpeers-10"></a>
+This is the “print a list of the peers” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+interactive.
+</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.
+<div class="node">
<a name="ntpq-refid"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpq-wide" accesskey="n" rel="next">ntpq wide</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-wide">ntpq wide</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-peers">ntpq peers</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="refid-option-_0028_002dr_0029"></a>
-<h4 class="subsection">1.1.10 refid option (-r)</h4>
-<a name="index-ntpq_002drefid"></a>
-<p>This is the “set default display type for s2+ refids” option.
+<h4 class="subsection">refid option (-r)</h4>
+
+<p><a name="index-ntpq_002drefid-11"></a>
+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.
-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></div>
-<p>or their numeric equivalent.</p></li></ul>
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<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:
+ <pre class="example"> hash ipv4
+</pre>
+ <p>or their numeric equivalent.</ul>
-<p>Set the default display format for S2+ refids.
-</p><hr>
+ <p>Set the default display format for S2+ refids.
+<div class="node">
<a name="ntpq-wide"></a>
-<div class="header">
-<p>
-Next: <a href="#ntpq-config" accesskey="n" rel="next">ntpq config</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-config">ntpq config</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-refid">ntpq refid</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="wide-option-_0028_002dw_0029"></a>
-<h4 class="subsection">1.1.11 wide option (-w)</h4>
-<a name="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
+<h4 class="subsection">wide option (-w)</h4>
+
+<p><a name="index-ntpq_002dwide-12"></a>
+This is the “display the full 'remote' value” option.
+Display the full value of the 'remote' value. If this requires
more than 15 characters, display the full value, emit a newline,
and continue the data display properly indented on the next line.
-</p>
-<hr>
+<div class="node">
<a name="ntpq-config"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpq-exit-status">ntpq exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-wide">ntpq wide</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="presetting_002fconfiguring-ntpq"></a>
-<h4 class="subsection">1.1.12 presetting/configuring ntpq</h4>
+
+<h4 class="subsection">presetting/configuring ntpq</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
-the options listed above in upper case and segmented with underscores.
+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
+the options listed above in upper case and segmented with underscores.
The <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
-</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>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
+
+<p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
+ <ul>
+<li>$HOME
+<li>$PWD
+</ul>
+ The environment variables <code>HOME</code>, and <code>PWD</code>
+are expanded and replaced when <samp><span class="file">ntpq</span></samp> runs.
+For any of these that are plain files, they are simply processed.
+For any that are directories, then a file named <samp><span class="file">.ntprc</span></samp> is searched for
within that directory and processed.
-</p>
-<p>Configuration files may be in a wide variety of formats.
+
+ <p>Configuration files may be in a wide variety of formats.
The basic format is an option name followed by a value (argument) on the
same line. Values may be separated from the option name with a colon,
equal sign or simply white space. Values may be continued across multiple
lines by escaping the newline with a backslash.
-</p>
-<p>Multiple programs may also share the same initialization file.
+
+ <p>Multiple programs may also share the same initialization file.
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></div>
-<p>or by
-</p><div class="example">
-<pre class="example"><?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
+<pre class="example"> [NTPQ]
+</pre>
+ <p class="noindent">or by
+<pre class="example"> <?program ntpq>
+</pre>
+ <p class="noindent">Do not mix these styles within one configuration file.
+
+ <p>Compound values and carefully constructed string values may also be
specified using XML syntax:
-</p><div class="example">
-<pre class="example"><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><div class="example">
-<pre class="example">"...<...>..."
-</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
+<pre class="example"> <option-name>
+ <sub-opt>...&lt;...&gt;...</sub-opt>
+ </option-name>
+</pre>
+ <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
+<pre class="example"> "...<...>..."
+</pre>
+ <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
the associated name/value pair list (see: optionFindValue).
-</p>
-<p>The command line options relating to configuration and/or usage help are:
-</p>
-<a name="version-_0028_002d_0029"></a>
-<h4 class="subsubheading">version (-)</h4>
+
+ <p>The command line options relating to configuration and/or usage help are:
+
+<h5 class="subsubheading">version (-)</h5>
<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 infomation may be selected with an option argument.
+detail to provide. The default is to print just the version. The licensing infomation 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>
-<dd><p>Only print the version. This is the default.
-</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
-<dd><p>Name the copyright usage licensing terms.
-</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
-<dd><p>Print the full copyright usage licensing terms.
-</p></dd>
+
+ <dl>
+<dt>‘<samp><span class="samp">version</span></samp>’<dd>Only print the version. This is the default.
+<br><dt>‘<samp><span class="samp">copyright</span></samp>’<dd>Name the copyright usage licensing terms.
+<br><dt>‘<samp><span class="samp">verbose</span></samp>’<dd>Print the full copyright usage licensing terms.
</dl>
-<hr>
+<div class="node">
<a name="ntpq-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntpq-config">ntpq config</a>,
+Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
+
</div>
-<a name="ntpq-exit-status-1"></a>
-<h4 class="subsection">1.1.13 ntpq exit status</h4>
+
+<h4 class="subsection">ntpq exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<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>
-<dd><p>A specified configuration file could not be loaded.
-</p></dd>
-<dt>‘<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>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
+<br><dt>‘<samp><span class="samp">66 (EX_NOINPUT)</span></samp>’<dd>A specified configuration file could not be loaded.
+<br><dt>‘<samp><span class="samp">70 (EX_SOFTWARE)</span></samp>’<dd>libopts had an internal operational error. Please report
+it to autogen-users@lists.sourceforge.net. Thank you.
</dl>
-<hr>
+<div class="node">
<a name="Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Internal-Commands">Internal Commands</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpq-Description">ntpq Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Usage-1"></a>
-<h3 class="section">1.2 Usage</h3>
-
-<table>
-<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>
-</table>
-
-<hr>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</h3>
+
+<p><table summary=""><tr align="left"><th valign="top" width="23%">What </th><th valign="top" width="23%">Default </th><th valign="top" width="5%">Flag </th><th valign="top" width="15%">Option
+<br></th></tr><tr align="left"><td valign="top" width="23%">configuration file
+</td><td valign="top" width="23%"><code>/etc/ntp.conf</code>
+</td><td valign="top" width="5%"><code>-c</code>
+</td><td valign="top" width="15%"><code>conffile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">frequency file
+</td><td valign="top" width="23%">none
+</td><td valign="top" width="5%"><code>-f</code>
+</td><td valign="top" width="15%"><code>driftfile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">leapseconds file
+</td><td valign="top" width="23%">none
+</td><td valign="top" width="5%">
+</td><td valign="top" width="15%"><code>leapfile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">process ID file
+</td><td valign="top" width="23%">none
+</td><td valign="top" width="5%"><code>-p</code>
+</td><td valign="top" width="15%"><code>pidfile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">log file
+</td><td valign="top" width="23%">system log
+</td><td valign="top" width="5%"><code>-l</code>
+</td><td valign="top" width="15%"><code>logfile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">include file
+</td><td valign="top" width="23%">none
+</td><td valign="top" width="5%">none
+</td><td valign="top" width="15%"><code>includefile</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">statistics path
+</td><td valign="top" width="23%"><code>/var/NTP</code>
+</td><td valign="top" width="5%"><code>-s</code>
+</td><td valign="top" width="15%"><code>statsdir</code>
+<br></td></tr><tr align="left"><td valign="top" width="23%">keys path
+</td><td valign="top" width="23%"><code>/usr/local/etc</code>
+</td><td valign="top" width="5%"><code>-k</code>
+</td><td valign="top" width="15%"><code>keysdir</code>
+<br></td></tr></table>
+
+<div class="node">
<a name="Internal-Commands"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Control-Message-Commands">Control Message Commands</a>,
+Previous: <a rel="previous" accesskey="p" href="#Usage">Usage</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Internal-Commands-2"></a>
-<h3 class="section">1.3 Internal Commands</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Internal Commands</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>
-<dl compact="compact">
-<dt><code><a name="help"></a><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.
-</p>
-</dd>
-<dt><code><a name="addvars"></a>><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>
-<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,
-and can be omitted in read requests.
+
+ <dl>
+<dt><code><a name="help"></a>? [</code><kbd>command_keyword</kbd><code>]</code><dt><code>help [</code><kbd>command_keyword</kbd><code>]</code><dd>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.
+
+ <br><dt><code><a name="addvars"></a>>addvars </code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code>] [...]</code><dt><code>rmvars </code><kbd>name</kbd><code> [...]</code><dt><code>clearvars</dt></code><dd>The arguments to these commands consist of a list of items of the form
+<kbd>name</kbd><code> = </code><kbd>value</kbd>, where the <code>= </code><kbd>value</kbd> 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.
+and <code>writelist</code> commands described below.
The <code>addvars</code> command allows variables and optional values
-to be added to the list.
+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 list should be comma-separated and not contain white space.
The <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.
-</p>
-</dd>
-<dt><code><a name="cooked"></a><code>cooked</code></code></dt>
-<dd><p>Display server messages in prettyprint format.
-</p>
-</dd>
-<dt><code><a name="debug"></a><code>debug more | less | off</code></code></dt>
-<dd><p>Turns internal query program debugging on and off.
-</p>
-</dd>
-<dt><code><a name="delay"></a><code>delay <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><a name="host"></a><code>host <kbd>name</kbd></code></code></dt>
-<dd><p>Set the host to which future queries will be sent.
+
+ <br><dt><code><a name="cooked"></a>cooked</code><dd>Display server messages in prettyprint format.
+
+ <br><dt><code><a name="debug"></a>debug more | less | off</code><dd>Turns internal query program debugging on and off.
+
+ <br><dt><code><a name="delay"></a>delay </code><kbd>milliseconds</kbd><dd>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.
+
+ <br><dt><code><a name="host"></a>host </code><kbd>name</kbd><dd>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><a name="hostnames"></a><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.
+
+ <br><dt><code><a name="hostnames"></a>hostnames [yes | no]</code><dd>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.
-</p>
-</dd>
-<dt><code><a name="keyid"></a><code>keyid <kbd>keyid</kbd></code></code></dt>
-<dd><p>This command specifies the key number to be used
-to authenticate configuration requests.
+
+ <br><dt><code><a name="keyid"></a>keyid </code><kbd>keyid</kbd><dd>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.
-</p>
-</dd>
-<dt><code><a name="keytype"></a><code>keytype</code></code></dt>
-<dd><p>Specify the digest algorithm to use for authenticated requests,
-with default <code>MD5</code>.
+
+ <br><dt><code><a name="keytype"></a>keytype</code><dd>Specify the digest algorithm to use for authenticated requests,
+with default <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>MD2</code>, <code>MD4</code>, <code>MD5</code>, <code>MDC2</code>, <code>RIPEMD160</code>, <code>SHA</code> and <code>SHA1</code>.
-</p>
-</dd>
-<dt><code><a name="ntpversion"></a><code>ntpversion 1 | 2 | 3 | 4</code></code></dt>
-<dd><p>Sets the NTP version number which <code>ntpq</code> claims in packets.
-Defaults to 2.
+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>.
+
+ <br><dt><code><a name="ntpversion"></a>ntpversion 1 | 2 | 3 | 4</code><dd>Sets the NTP version number which <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><a name="passwd"></a><code>passwd</code></code></dt>
-<dd><p>This command prompts for a password to authenticate requests.
+didn't exist in NTP version 1.
+
+ <br><dt><code><a name="passwd"></a>passwd</code><dd>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.
-</p>
-</dd>
-<dt><code><a name="quit"></a><code>quit</code></code></dt>
-<dd><p>Exit <code>ntpq</code>.
-</p>
-</dd>
-<dt><code><a name="raw"></a><code>raw</code></code></dt>
-<dd><p>Display server messages as received and without reformatting.
-</p>
-</dd>
-<dt><code><a name="timeout"></a><code>timeout <kbd>millseconds</kbd></code></code></dt>
-<dd><p>Specify a timeout period for responses to server queries.
-The default is about 5000 milliseconds.
+
+ <br><dt><code><a name="quit"></a>quit</code><dd>Exit <code>ntpq</code>.
+
+ <br><dt><code><a name="raw"></a>raw</code><dd>Display server messages as received and without reformatting.
+
+ <br><dt><code><a name="timeout"></a>timeout </code><kbd>millseconds</kbd><dd>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
the total waiting time for a timeout will be twice the timeout value set.
-</p>
-</dd>
-</dl>
-<hr>
+ </dl>
+
+<div class="node">
<a name="Control-Message-Commands"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>,
+Previous: <a rel="previous" accesskey="p" href="#Internal-Commands">Internal Commands</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Control-Message-Commands-2"></a>
-<h3 class="section">1.4 Control Message Commands</h3>
-<p>Association IDs are used to identify system, peer and clock variables.
+<!-- node-name, next, previous, up -->
+<h3 class="section">Control Message Commands</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.
+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.
+and expect a single response message.
The exceptions are the <code>peers</code> command,
which sends a series of messages,
and the <code>mreadlist</code> and <code>mreadvar</code> commands,
which iterate over a range of associations.
-</p>
-<a name="as"></a><dl compact="compact">
-<dt><code><code>associations</code></code></dt>
-<dd><p>Display a list of mobilized associations in the form:
+
+ <p><a name="as"></a>
+ <dl>
+<dt><code>associations</code><dd>Display a list of mobilized associations in the form:
<br>
<code>ind assid status conf reach auth condition last_event cnt</code>
-</p>
-<table>
-<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>
-</table>
-
-</dd>
-<dt><code><a name="cv"></a>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>
-<dd><p>Display a list of ‘clock variables’ for those associations supporting a reference clock.
-</p>
-</dd>
-<dt><code><a name="g_t_003aconfig"></a>:config [...]</code></dt>
-<dd><p>Send the remainder of the command line, including whitespace, to the server
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="40%">Description
+
+ <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>ind</code>
+</td><td valign="top" width="40%">index on this list
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>assid</code>
+</td><td valign="top" width="40%">association ID
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
+</td><td valign="top" width="40%"><a href="decode.html#peer">peer status word</a>
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>conf</code>
+</td><td valign="top" width="40%"><code>yes</code>: persistent, <code>no</code>: ephemeral
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
+</td><td valign="top" width="40%"><code>yes</code>: reachable, <code>no</code>: unreachable
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>auth</code>
+</td><td valign="top" width="40%"><code>ok</code>, <code>yes</code>, <code>bad</code> and <code>none</code>
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>condition</code>
+</td><td valign="top" width="40%">selection status (see the <code>select</code> field of the <a href="decode.html#peer">peer status word</a>)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>last_event</code>
+</td><td valign="top" width="40%">event report (see the <code>event</code> field of the <a href="decode.html#peer">peer status word</a>)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cnt</code>
+event count (see the <code>count</code> field of the <a href="decode.html#peer">peer status word</a>)
+
+ <br></td></tr></table>
+
+ <br><dt><code><a name="cv"></a>clockvar </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...]] [...]]</code><dt><code>cv </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...] ][...]]</code><dd>Display a list of <a href="#clock">clock variables</a> for those associations supporting a reference clock.
+
+ <br><dt><code><a name="g_t_003aconfig"></a>:config [...]</code><dd>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.
-This command is experimental until further notice and clarification.
+as the configuration file.
+This command is experimental until further notice and clarification.
Authentication is of course required.
-</p>
-</dd>
-<dt><code><a name="config_002dfrom_002dfile"></a>config-from-file <kbd>filename</kbd></code></dt>
-<dd><p>Send the each line of <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.
+
+ <br><dt><code><a name="config_002dfrom_002dfile"></a>config-from-file </code><kbd>filename</kbd><dd>Send the each line of <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><a name="ifstats"></a>ifstats</code></dt>
-<dd><p>Display statistics for each local network address.
+
+ <br><dt><code><a name="ifstats"></a>ifstats</code><dd>Display statistics for each local network address.
Authentication is required.
-</p>
-</dd>
-<dt><code><a name="iostats"></a>iostats</code></dt>
-<dd><p>Display network and reference clock I/O statistics.
-</p>
-</dd>
-<dt><code><a name="kerninfo"></a>kerninfo</code></dt>
-<dd><p>Display kernel loop and PPS statistics.
-As with other ntpq output, times are in milliseconds.
+
+ <br><dt><code><a name="iostats"></a>iostats</code><dd>Display network and reference clock I/O statistics.
+
+ <br><dt><code><a name="kerninfo"></a>kerninfo</code><dd>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><a name="lassoc"></a>lassociations</code></dt>
-<dd><p>Perform the same function as the associations command,
+
+ <br><dt><code><a name="lassoc"></a>lassociations</code><dd>Perform the same function as the associations command,
except display mobilized and unmobilized associations.
-</p>
-</dd>
-<dt><code><a name="monstats"></a>monstats</code></dt>
-<dd><p>Display monitor facility statistics.
-</p>
-</dd>
-<dt><code><a name="mrulist"></a>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>
-<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>.
+
+ <br><dt><code><a name="monstats"></a>monstats</code><dd>Display monitor facility statistics.
+
+ <br><dt><code><a name="mrulist"></a>mrulist [limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Obtain and print traffic counts collected and maintained by
+the monitor facility.
+With the exception of <code>sort=</code><kbd>sortorder</kbd>,
+the options filter the list returned by <code>ntpd</code>.
The <code>limited</code> and <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>
+triggered either discarding or a KoD response.
+The <code>mincount=</code><kbd>count</kbd> option filters entries representing
+less than <kbd>count</kbd> packets.
+The <code>laddr=</code><kbd>localaddr</kbd> option filters entries for packets
+received on any local address other than <kbd>localaddr</kbd>.
+<code>resany=</code><kbd>hexmask</kbd> and <code>resall=</code><kbd>hexmask</kbd>
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 <kbd>hexmask</kbd>, which must begin with <code>0x</code>.
<br>
-The <code><kbd>sortorder</kbd></code> defaults to <code>lstint</code> and may be any of
+The <kbd>sortorder</kbd> defaults to <code>lstint</code> and may be any of
<code>addr</code>, <code>count</code>, <code>avgint</code>, <code>lstint</code>, or
-any of those preceded by a minus sign (hyphen) to reverse the sort order.
+any of those preceded by a minus sign (hyphen) to reverse the sort order.
The output columns are:
-</p>
-<table>
-<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.
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Column </th><th valign="top" width="40%">Description
+
+ <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>lstint</code>
+</td><td valign="top" 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>
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>avgint</code>
+</td><td valign="top" width="40%">
+Average interval in s between packets from this address.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rstr</code>
+</td><td valign="top" width="40%">
+Restriction flags associated with this address.
Most are copied unchanged from the matching <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
+the last packet from this address triggered a rate control response.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>r</code>
+</td><td valign="top" width="40%">
+Rate control indicator, either a period, <code>L</code> or <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
-could not be verified in parentheses.</td></tr>
-</table>
-
-</dd>
-<dt><code><a name="mreadvar"></a><code>mreadvar <kbd>assocID</kbd> <kbd>assocID</kbd> [ <kbd>variable_name</kbd> [ = <kbd>value</kbd>[ ... ]</code></code></dt>
-<dt><code><a name="mrv"></a><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,
-except for a range of association IDs.
+rate limiting with a KoD response, respectively.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>m</code>
+</td><td valign="top" width="40%">
+Packet mode.
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>v</code>
+</td><td valign="top" width="40%">
+Packet version number.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>count</code>
+</td><td valign="top" width="40%">
+Packets received from this address.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rport</code>
+</td><td valign="top" width="40%">
+Source port of last packet from this address.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote address</code>
+</td><td valign="top" width="40%">
+DNS name, numeric address, or address followed by claimed DNS name which
+could not be verified in parentheses.
+
+ <br></td></tr></table>
+
+ <br><dt><code><a name="mreadvar"></a>mreadvar </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dt><code><a name="mrv"></a>mrv </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dd>Perform the same function as the <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.
-</p>
-</dd>
-<dt><code><a name="passoc"></a><code>passociations</code></code></dt>
-<dd><p>Perform the same function as the <code>associations command</code>, except that
+
+ <br><dt><code><a name="passoc"></a>passociations</code><dd>Perform the same function as the <code>associations command</code>, except that
it uses previously stored data rather than making a new query.
-</p>
-</dd>
-<dt><code><a name="pe"></a><code>peers</code></code></dt>
-<dd><p>Display a list of peers in the form:
+
+ <br><dt><code><a name="pe"></a>peers</code><dd>Display a list of peers in the form:
<br>
<code>[tally]remote refid st t when pool reach delay offset jitter</code>
-</p>
-<table>
-<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,
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+<br></th></tr><tr align="left"><td valign="top" width="10%"><code>[tally]</code>
+</td><td valign="top" 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>.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote</code>
+</td><td valign="top" width="20%">
+host name (or IP number) of peer
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
+</td><td valign="top" width="20%">
+association ID or <a href="decode.html#kiss">kiss code</a>.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>st</code>
+</td><td valign="top" width="20%">
+stratum
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>t</code>
+</td><td valign="top" 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>
-</table>
-
-</dd>
-<dt><code><a name="rv"></a>readvar <kbd>assocID</kbd> <kbd>name</kbd> [ = <kbd>value</kbd> ] [,...]</code></dt>
-<dt><code>rv <kbd>assocID</kbd> [ <kbd>name</kbd> ] [,...]</code></dt>
-<dd><p>Display the specified variables.
-If <code><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.
+<code>M</code>: multicast server.
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>when</code>
+</td><td valign="top" width="20%">
+sec/min/hr since last received packet
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code>
+</td><td valign="top" width="20%">
+poll interval (log(2) s)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
+</td><td valign="top" width="20%">
+reach shift register (octal)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code>
+</td><td valign="top" width="20%">
+roundtrip delay
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
+</td><td valign="top" width="20%">
+offset of server relative to this host
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code>
+</td><td valign="top" width="20%">
+jitter
+
+ <br></td></tr></table>
+
+ <br><dt><code><a name="rv"></a>readvar </code><kbd>assocID</kbd> <kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> ] [,...]</code><dt><code>rv </code><kbd>assocID</kbd><code> [ </code><kbd>name</kbd><code> ] [,...]</code><dd>Display the specified variables.
+If <kbd>assocID</kbd> is zero,
+the variables are from the <a href="#system">system variables</a> name space,
+otherwise they are from the <a href="#peer">peer variables</a> name space.
+The <kbd>assocID</kbd> is required, as the same name can occur in both spaces.
If no <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.
-Multiple names are specified with comma separators and without whitespace.
+all operative variables in the name space are displayed.
+In this case only, if the <kbd>assocID</kbd> 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).
+frequency values in parts-per-million (PPM).
Some NTP timestamps are represented in the format YYYYMMDDTTTT,
where YYYY is the year, MM the month of year, DD the day of month and
TTTT the time of day.
-</p>
-</dd>
-<dt><code><a name="saveconfig"></a><code>saveconfig <kbd>filename</kbd></code></code></dt>
-<dd><p>Write the current configuration, including any runtime modifications
+
+ <br><dt><code><a name="saveconfig"></a>saveconfig </code><kbd>filename</kbd><dd>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>.
+to the ntpd host's file <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.
+appears in the <code>ntpd</code> configuration file.
<kbd>filename</kbd> can use <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>saveconfig ntp-%Y%m%d-%H%M%S.conf</code>.
+The filename used is stored in system variable <code>savedconfig</code>.
Authentication is required.
-</p>
-</dd>
-<dt><code><a name="writevar"></a>writevar <kbd>assocID</kbd> <kbd>name</kbd> = <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
-‘system variables’ name space, otherwise they are from the
-‘peer variables’ name space.
-The <code><kbd>assocID</kbd></code> is required,
+
+ <br><dt><code><a name="writevar"></a>writevar </code><kbd>assocID</kbd> <kbd>name</kbd><code> = </code><kbd>value</kbd><code> [,...]</code><dd>Write the specified variables.
+If the <kbd>assocID</kbd> is zero, the variables are from the
+<a href="#system">system variables</a> name space, otherwise they are from the
+<a href="#peer">peer variables</a> name space.
+The <kbd>assocID</kbd> is required,
as the same name can occur in both spaces.
-</p>
-</dd>
-<dt><code><a name="sysinfo"></a><code>sysinfo</code></code></dt>
-<dd><p>Display operational summary.
-</p>
-</dd>
-<dt><code><a name="sysstats"></a><code>sysstats</code></code></dt>
-<dd><p>Print statistics counters maintained in the protocol module.
-</p>
-</dd>
-</dl>
-<hr>
+ <br><dt><code><a name="sysinfo"></a>sysinfo</code><dd>Display operational summary.
+
+ <br><dt><code><a name="sysstats"></a>sysstats</code><dd>Print statistics counters maintained in the protocol module.
+
+ </dl>
+
+<div class="node">
<a name="Status-Words-and-Kiss-Codes"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#System-Variables">System Variables</a>,
+Previous: <a rel="previous" accesskey="p" href="#Control-Message-Commands">Control Message Commands</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Status-Words-and-Kiss-Codes-2"></a>
-<h3 class="section">1.5 Status Words and Kiss Codes</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Status Words and Kiss Codes</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.
+and each association separately.
These words are displayed in the <code>rv</code> and <code>as</code> commands
-both in hexadecimal and decoded short tip strings.
+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 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
+
+
<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>.
-The original purpose was for kiss-o’-death (KoD) packets sent
-by the server to advise the client of an unusual condition.
+<a 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>
+
+<div class="node">
<a name="System-Variables"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Peer-Variables">Peer Variables</a>,
+Previous: <a rel="previous" accesskey="p" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="System-Variables-2"></a>
-<h3 class="section">1.6 System Variables</h3>
-<p>The following system variables appear in the <code>rv</code> billboard.
+<!-- node-name, next, previous, up -->
+<h3 class="section">System Variables</h3>
+
+<p>The following system variables appear in the <code>rv</code> billboard.
Not all variables are displayed in some configurations.
-</p>
-<table>
-<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>
-time constant and poll exponent (log(2) s) (3-17)</td></tr>
-<tr><td width="10%"><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>
-</table>
-
-<p>The jitter and wander statistics are exponentially-weighted RMS averages.
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+
+<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
+</td><td valign="top" width="20%">
+<a href="decode.html#sys">system status word</a>
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>version</code>
+</td><td valign="top" width="20%">
+NTP software version and build time
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>processor</code>
+</td><td valign="top" width="20%">
+hardware platform and version
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>system</code>
+</td><td valign="top" width="20%">
+operating system and version
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code>
+</td><td valign="top" width="20%">
+leap warning indicator (0-3)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
+</td><td valign="top" width="20%">
+stratum (1-15)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code>
+</td><td valign="top" width="20%">
+precision (log(2) s)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code>
+</td><td valign="top" width="20%">
+total roundtrip delay to the primary reference clock
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code>
+</td><td valign="top" width="20%">
+total dispersion to the primary reference clock
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>peer</code>
+</td><td valign="top" width="20%">
+system peer association ID
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tc</code>
+time constant and poll exponent (log(2) s) (3-17)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>mintc</code>
+minimum time constant (log(2) s) (3-10)
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clock</code>
+</td><td valign="top" width="20%">
+date and time of day
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
+reference ID or <a href="decode.html#kiss">kiss code</a>
+
+ <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code>
+</td><td valign="top" width="20%">
+reference time
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
+</td><td valign="top" width="20%">
+combined offset of server relative to this host
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>sys_jitter</code>
+</td><td valign="top" width="20%">
+combined system jitter
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>frequency</code>
+</td><td valign="top" width="20%">
+frequency offset (PPM) relative to hardware clock
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_wander</code>
+</td><td valign="top" width="20%">
+clock frequency wander (PPM)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_jitter</code>
+</td><td valign="top" width="20%">
+clock jitter
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tai</code>
+</td><td valign="top" width="20%">
+TAI-UTC offset (s)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leapsec</code>
+</td><td valign="top" width="20%">
+NTP seconds when the next leap second is/was inserted
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>expire</code>
+</td><td valign="top" width="20%">
+NTP seconds when the NIST leapseconds file expires
+
+ <br></td></tr></table>
+
+ <p>The jitter and wander statistics are exponentially-weighted RMS averages.
The system jitter is defined in the NTPv4 specification;
the clock jitter statistic is computed by the clock discipline module.
-</p>
-<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
+
+
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional system variables are displayed, including some or all of the
following, depending on the particular Autokey dance:
-</p>
-<table>
-<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>
-</table>
-
-<hr>
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+
+<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>host</code>
+</td><td valign="top" width="20%">
+Autokey host name for this host
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code>
+</td><td valign="top" width="20%">
+Autokey group name for this host
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
+</td><td valign="top" width="20%">
+host flags (see Autokey specification)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>digest</code>
+</td><td valign="top" width="20%">
+OpenSSL message digest algorithm
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code>
+</td><td valign="top" width="20%">
+OpenSSL digest/signature scheme
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>update</code>
+</td><td valign="top" width="20%">
+NTP seconds at last signature update
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cert</code>
+</td><td valign="top" width="20%">
+certificate subject, issuer and certificate flags
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>until</code>
+</td><td valign="top" width="20%">
+NTP seconds when the certificate expires
+
+ <br></td></tr></table>
+
+<div class="node">
<a name="Peer-Variables"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Clock-Variables">Clock Variables</a>,
+Previous: <a rel="previous" accesskey="p" href="#System-Variables">System Variables</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Peer-Variables-2"></a>
-<h3 class="section">1.7 Peer Variables</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Peer Variables</h3>
<p>The following peer variables appear in the <code>rv</code> billboard
-for each association.
+for each association.
Not all variables are displayed in some configurations.
-</p>
-<table>
-<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>
-<p><code>srcport</code>
-</p></td><td width="20%">source (remote) IP address and port</td></tr>
-<tr><td width="10%"><code>dstadr</code>
-<p><code>dstport</code>
-</p></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>
-</table>
-
-<p>The bias variable is calculated when the first broadcast packet is received
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+
+<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code>
+</td><td valign="top" width="20%">
+association ID
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
+</td><td valign="top" width="20%">
+<a href="decode.html#peer">peer status word</a>
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcadr</code>
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcport</code>
+</td><td valign="top" width="20%">
+source (remote) IP address and port
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstadr</code>
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstport</code>
+</td><td valign="top" width="20%">
+destination (local) IP address and port
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code>
+</td><td valign="top" width="20%">
+leap indicator (0-3)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
+</td><td valign="top" width="20%">
+stratum (0-15)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code>
+</td><td valign="top" width="20%">
+precision (log(2) s)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code>
+</td><td valign="top" width="20%">
+total roundtrip delay to the primary reference clock
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code>
+</td><td valign="top" width="20%">total root dispersion to the primary reference clock
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
+</td><td valign="top" width="20%">
+reference ID or <a href="decode.html#kiss">kiss code</a>
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code>
+</td><td valign="top" width="20%">
+reference time
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
+</td><td valign="top" width="20%">
+reach register (octal)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>unreach</code>
+</td><td valign="top" width="20%">
+unreach counter
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hmode</code>
+</td><td valign="top" width="20%">
+host mode (1-6)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>pmode</code>
+</td><td valign="top" width="20%">
+peer mode (1-5)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hpoll</code>
+</td><td valign="top" width="20%">
+host poll exponent (log(2) s) (3-17)
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>ppoll</code>
+</td><td valign="top" width="20%">
+peer poll exponent (log(2) s) (3-17)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>headway</code>
+</td><td valign="top" width="20%">
+headway (see <a href="rate.html">Rate Management and the Kiss-o'-Death Packet</a>)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flash</code>
+</td><td valign="top" width="20%">
+<a href="decode.html#flash">flash status word</a>
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
+</td><td valign="top" width="20%">
+filter offset
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code>
+</td><td valign="top" width="20%">
+filter delay
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dispersion</code>
+</td><td valign="top" width="20%">
+filter dispersion
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code>
+</td><td valign="top" width="20%">
+filter jitter
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code>
+</td><td valign="top" width="20%">
+Autokey group name for this association
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>bias</code>
+</td><td valign="top" width="20%">
+unicast/broadcast bias
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>xleave</code>
+</td><td valign="top" width="20%">
+interleave delay (see <a href="xleave.html">NTP Interleaved Modes</a>)
+
+ <br></td></tr></table>
+
+ <p>The bias 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 xleave variable appears
only 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,
+
+
<p>When the NTPv4 daemon is compiled with the OpenSSL software library,
additional peer variables are displayed, including the following:
-</p>
-<table>
-<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>
-</table>
-
-<hr>
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+
+<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
+</td><td valign="top" width="20%">
+peer flags (see Autokey specification)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>host</code>
+</td><td valign="top" width="20%">
+Autokey server name
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
+</td><td valign="top" width="20%">
+peer flags (see Autokey specification)
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code>
+</td><td valign="top" width="20%">
+OpenSSL digest/signature scheme
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initsequence</code>
+</td><td valign="top" width="20%">
+initial key ID
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initkey</code>
+</td><td valign="top" width="20%">
+initial key index
+
+<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>timestamp</code>
+</td><td valign="top" width="20%">
+Autokey signature timestamp
+
+ <br></td></tr></table>
+
+<div class="node">
<a name="Clock-Variables"></a>
-<div class="header">
-<p>
-Previous: <a href="#Peer-Variables" accesskey="p" rel="prev">Peer Variables</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#Peer-Variables">Peer Variables</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Clock-Variables-2"></a>
-<h3 class="section">1.8 Clock Variables</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Clock Variables</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>
-<table>
-<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>
-</table>
-<hr>
-
-
-
-</body>
-</html>
+
+ <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
+<br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code>
+</td><td valign="top" width="20%">association ID
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
+</td><td valign="top" width="20%"><a href="decode.html#clock">clock status word</a>
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>device</code>
+</td><td valign="top" width="20%">device description
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>timecode</code>
+</td><td valign="top" width="20%">ASCII time code string (specific to device)
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code>
+</td><td valign="top" width="20%">poll messages sent
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>noreply</code>
+</td><td valign="top" width="20%">no reply
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>badformat</code>
+</td><td valign="top" width="20%">bad format
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>baddata</code>
+</td><td valign="top" width="20%">bad date or time
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime1</code>
+</td><td valign="top" width="20%">fudge time 1
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime2</code>
+</td><td valign="top" width="20%">fudge time 2
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
+</td><td valign="top" width="20%">driver stratum
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
+</td><td valign="top" width="20%">driver reference ID
+<br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
+</td><td valign="top" width="20%">driver flags
+ <br></td></tr></table>
+
+</body></html>
+
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntpq @NTPQ_MS@ "02 Jan 2017" "4.2.8p9" "User Commands"
+.TH ntpq @NTPQ_MS@ "19 Mar 2017" "4.2.8p9" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:23 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:34 AM by AutoGen 5.18.5
.\" From the definitions ntpq-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.ne 2
.SH DESCRIPTION
+.sp \n(Ppu
+.ne 2
+
The
\f\*[B-Font]ntpq\fP
-utility program is used to query NTP servers which
-implement the standard NTP mode 6 control message formats defined
-in Appendix B of the NTPv3 specification RFC1305, requesting
+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.
-The same formats are used in NTPv4, although some of the
-variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
command line arguments.
Requests to read and write arbitrary
utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
+.sp \n(Ppu
+.ne 2
+
If one or more request options is included on the command line
when
\f\*[B-Font]ntpq\fP
\f\*[B-Font]ntpq\fP
utility will prompt for
commands if the standard input is a terminal device.
+.sp \n(Ppu
+.ne 2
+
\f\*[B-Font]ntpq\fP
uses NTP mode 6 packets to communicate with the
NTP server, and hence can be used to query any compatible server on
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
+.sp \n(Ppu
+.ne 2
+
+Note that in contexts where a host name is expected, a
+\f\*[B-Font]\-4\f[]
+qualifier preceding the host name forces resolution to the IPv4
+namespace, while a
+\f\*[B-Font]\-6\f[]
+qualifier forces resolution to the IPv6 namespace.
+For examples and usage, see the
+\*[Lq]NTP Debugging Techniques\*[Rq]
+page.
+.sp \n(Ppu
+.ne 2
+
Specifying a
command line option other than
\f\*[B-Font]\-i\f[]
will attempt to read
interactive format commands from the standard input.
.SS "Internal Commands"
+.sp \n(Ppu
+.ne 2
+
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.
+.sp \n(Ppu
+.ne 2
+
A
number of interactive format commands are executed entirely within
the
\f\*[B-Font]ntpq\fP
-utility itself and do not result in NTP mode 6
+utility itself and do not result in NTP
requests being sent to a server.
These are described following.
-.TP 20
-.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command_keyword\f[]]
+.TP 15
+.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command\f[]]
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command_keyword\f[]]
+.TP 15
+.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command\f[]]
A
\[oq]\&?\[cq]
-by itself will print a list of all the command
-keywords known to this incarnation of
+by itself will print a list of all the commands
+known to
\f\*[B-Font]ntpq\fP.
A
\[oq]\&?\[cq]
-followed by a command keyword will print function and usage
+followed by a command name will print function and usage
information about the command.
-This command is probably a better
-source of information about
-\f\*[B-Font]ntpq\fP
-than this manual
-page.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]variable_name\f[][\f\*[B-Font]=value\f[]] \f\*[B-Font]...\f[]
+.TP 15
+.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[][,...]
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]variable_name\f[] \f\*[B-Font]...\f[]
+.TP 15
+.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]name\f[][,...]
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]clearvars\f[]
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]showvars\f[]
-The data carried by NTP mode 6 messages consists of a list of
+The arguments to this command consist of a list of
items of the form
-\[oq]variable_name=value\[cq],
+\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]],
where the
-\[oq]=value\[cq]
+.NOP \&=\f\*[I-Font]value\f[]
is ignored, and can be omitted,
in requests to the server to read variables.
The
\f\*[B-Font]ntpq\fP
-utility maintains an internal list in which data to be included in control
-messages can be assembled, and sent using the
+utility maintains an internal list in which data to be included in
+messages can be assembled, and displayed or set using the
\f\*[B-Font]readlist\f[]
and
\f\*[B-Font]writelist\f[]
\f\*[B-Font]rmvars\f[]
command can be used to remove individual variables from the list,
while the
-\f\*[B-Font]clearlist\f[]
+\f\*[B-Font]clearvars\f[]
command removes all variables from the
list.
The
command displays the current list of optional variables.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]authenticate\f[] [yes | no]
+.TP 15
+.NOP \f\*[B-Font]authenticate\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
Normally
\f\*[B-Font]ntpq\fP
does not authenticate requests unless
they are write requests.
The command
-\[oq]authenticate yes\[cq]
+\f\*[B-Font]authenticate\f[] \f\*[B-Font]yes\f[]
causes
\f\*[B-Font]ntpq\fP
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
-requests slightly differently, and can occasionally melt the CPU in
-fuzzballs if you turn authentication on before doing a
-\f\*[B-Font]peer\f[]
-display.
+requests slightly differently.
The command
-\[oq]authenticate\[cq]
+\f\*[B-Font]authenticate\f[]
causes
\f\*[B-Font]ntpq\fP
to display whether or not
-\f\*[B-Font]ntpq\fP
-is currently autheinticating requests.
+it is currently authenticating requests.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]cooked\f[]
Causes output from query commands to be "cooked", so that
variables which are recognized by
values reformatted for human consumption.
Variables which
\f\*[B-Font]ntpq\fP
-thinks should have a decodable value but didn't are
+could not decode completely are
marked with a trailing
\[oq]\&?\[cq].
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[] | \f\*[B-Font]less\f[] | \f\*[B-Font]off\f[]]
+.TP 15
+.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[]|\f\*[B-Font]less\f[]|\f\*[B-Font]off\f[]]
With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
+Otherwise, the debugging level is changed as indicated.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[]
+.TP 15
+.NOP \f\*[B-Font]delay\f[] [\f\*[I-Font]milliseconds\f[]]
Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
Actually the
server does not now require timestamps in authenticated requests,
so this command may be obsolete.
+Without any arguments, displays the current delay.
+.br
+.ns
+.TP 15
+.NOP \f\*[B-Font]drefid\f[] [\f\*[B-Font]hash\f[]|\f\*[B-Font]ipv4\f[]]
+Display refids as IPv4 or hash.
+Without any arguments, displays whether refids are shown as IPv4
+addresses or hashes.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]exit\f[]
Exit
\f\*[B-Font]ntpq\fP.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[]
+.TP 15
+.NOP \f\*[B-Font]host\f[] [\f\*[I-Font]name\f[]]
Set the host to which future queries will be sent.
-\f\*[I-Font]hostname\f[]
+The
+\f\*[I-Font]name\f[]
may be either a host name or a numeric address.
+Without any arguments, displays the current host.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]]
+.TP 15
+.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
If
\f\*[B-Font]yes\f[]
is specified, host names are printed in
modified using the command line
\f\*[B-Font]\-n\f[]
switch.
+Without any arguments, displays whether host names or numeric addresses
+are shown.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[]
+.TP 15
+.NOP \f\*[B-Font]keyid\f[] [\f\*[I-Font]keyid\f[]]
This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
\f\*[B-Font]controlkey\f[]
key number the server has been configured to use for this
purpose.
+Without any arguments, displays the current
+\f\*[I-Font]keyid\f[].
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]keytype\f[] [\f\*[B-Font]md5\f[] | \f\*[B-Font]OpenSSLDigestType\f[]]
-Specify the type of key to use for authenticating requests.
-\f\*[B-Font]md5\f[]
-is alway supported.
+.TP 15
+.NOP \f\*[B-Font]keytype\f[] [\f\*[I-Font]digest\f[]]
+Specify the digest algorithm to use for authenticating requests, with default
+\f\*[B-Font]MD5\f[].
If
\f\*[B-Font]ntpq\fP
-was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+was built with OpenSSL support, and OpenSSL is installed,
+\f\*[I-Font]digest\f[]
+can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-\f\*[B-Font]keytype\f[]
-is displayed.
+\f\*[B-Font]keytype\f[] \f\*[I-Font]digest\f[]
+algorithm used is displayed.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[] | \f\*[B-Font]2\f[] | \f\*[B-Font]3\f[] | \f\*[B-Font]4\f[]]
+.TP 15
+.NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[]|\f\*[B-Font]2\f[]|\f\*[B-Font]3\f[]|\f\*[B-Font]4\f[]]
Sets the NTP version number which
\f\*[B-Font]ntpq\fP
claims in
when communicating with servers.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]passwd\f[]
This command prompts you to type in a password (which will not
be echoed) which will be used to authenticate configuration
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
successful.
-.\" Not yet implemented.
-.\" .It Ic poll
-.\" .Op Ar n
-.\" .Op Ic verbose
-.\" Poll an NTP server in client mode
-.\" .Ar n
-.\" times.
.br
.ns
-.TP 20
+.TP 15
+.NOP \f\*[B-Font]poll\f[] [\f\*[I-Font]n\f[]] [\f\*[B-Font]verbose\f[]]
+Poll an NTP server in client mode
+\f\*[I-Font]n\f[]
+times.
+Poll not implemented yet.
+.br
+.ns
+.TP 15
.NOP \f\*[B-Font]quit\f[]
Exit
\f\*[B-Font]ntpq\fP.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]raw\f[]
Causes all output from query commands is printed as received
from the remote server.
understandable) form.
.br
.ns
-.TP 20
-.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[]
+.TP 15
+.NOP \f\*[B-Font]timeout\f[] [\f\*[I-Font]milliseconds\f[]]
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
\f\*[B-Font]ntpq\fP
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
.br
.ns
-.TP 20
+.TP 15
.NOP \f\*[B-Font]version\f[]
-Print the version of the
+Display the version of the
\f\*[B-Font]ntpq\fP
program.
.PP
.SS "Control Message Commands"
-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.
+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 message to the server and expect a
+single response message.
The exceptions are the
-\f[C]peers\f[]
+\f\*[B-Font]peers\f[]
command, which sends a series of messages,
and the
-\f[C]mreadlist\f[]
+\f\*[B-Font]mreadlist\f[]
and
-\f[C]mreadvar\f[]
+\f\*[B-Font]mreadvar\f[]
commands, which iterate over a range of associations.
.TP 10
+.NOP \f\*[B-Font]apeers\f[]
+Display a list of peers in the form:
+.Dl [tally]remote refid assid st t when pool reach delay offset jitter
+where the output is just like the
+\f\*[B-Font]peers\f[]
+command except that the
+\f\*[B-Font]refid\f[]
+is displayed in hex format and the association number is also displayed.
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]associations\f[]
Display a list of mobilized associations in the form:
.Dl ind assid status conf reach auth condition last_event cnt
.RS
.IP \fB\(bu\fP 2
-.IP \fB\(bu\fP 2 \f[C]ind\f[] \f[C]Ta\f[] \f[C]index\f[] \f[C]on\f[] \f[C]this\f[] \f[C]list\f[]
-.IP \fB\(bu\fP 2 \f[C]assid\f[] \f[C]Ta\f[] \f[C]association\f[] \f[C]ID\f[]
-.IP \fB\(bu\fP 2 \f[C]status\f[] \f[C]Ta\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word\f[]
-.IP \fB\(bu\fP 2 \f[C]conf\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]persistent,\f[] \f[C]no\f[]: \f[C]ephemeral\f[]
-.IP \fB\(bu\fP 2 \f[C]reach\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]reachable,\f[] \f[C]no\f[]: \f[C]unreachable\f[]
-.IP \fB\(bu\fP 2 \f[C]auth\f[] \f[C]Ta\f[] \f[C]ok\f[], \f[C]yes\f[], \f[C]bad\f[] \f[C]and\f[] \f[C]none\f[]
-.IP \fB\(bu\fP 2 \f[C]condition\f[] \f[C]Ta\f[] \f[C]selection\f[] \f[C]status\f[] \f[C](see\f[] \f[C]the\f[] \f[C]select\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
-.IP \fB\(bu\fP 2 \f[C]last_event\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]report\f[] \f[C](see\f[] \f[C]the\f[] \f[C]event\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
-.IP \fB\(bu\fP 2 \f[C]cnt\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]count\f[] \f[C](see\f[] \f[C]the\f[] \f[C]count\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]ind\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]index\f[] \f\*[B-Font]on\f[] \f\*[B-Font]this\f[] \f\*[B-Font]list\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]assid\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]association\f[] \f\*[B-Font]id\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]status\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]conf\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]persistent,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]ephemeral\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]reach\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]reachable,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]unreachable\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]auth\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]ok\f[], \f\*[B-Font]yes\f[], \f\*[B-Font]bad\f[] \f\*[B-Font]No\f[] \f\*[B-Font]and\f[] \f\*[B-Font]none\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]condition\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]selection\f[] \f\*[B-Font]status\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]select\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]last_event\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]report\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]event\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
+.IP \fB\(bu\fP 2 \f\*[B-Font]cnt\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]count\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]count\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
.RE
.br
.ns
.TP 10
.NOP \f\*[B-Font]authinfo\f[]
-Display the authentication statistics.
+Display the authentication statistics counters:
+time since reset, stored keys, free keys, key lookups, keys not found,
+uncached keys, expired keys, encryptions, decryptions.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]clocklist\f[] [\f\*[I-Font]associd\f[]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]clockvar\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
+.NOP \f\*[B-Font]cl\f[] [\f\*[I-Font]associd\f[]]
+Display all clock variables in the variable list for those associations
+supporting a reference clock.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]cv\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
-Display a list of clock variables for those associations supporting a reference clock.
+.NOP \f\*[B-Font]clockvar\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]:config\f[] [...]
-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.
+.NOP \f\*[B-Font]cv\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
+Display a list of clock variables for those associations supporting a
+reference clock.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]:config\f[] \f\*[I-Font]configuration command line\f[]
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[]
-Send the each line of
+Send each line of
\f\*[I-Font]filename\f[]
-to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]ifstats\f[]
-Display statistics for each local network address. Authentication is required.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]iostats\f[]
-Display network and reference clock I/O statistics.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]kerninfo\f[]
-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.
+Display kernel loop and PPS statistics:
+associd, status, pll offset, pll frequency, maximum error,
+estimated error, kernel status, pll time constant, precision,
+frequency tolerance, pps frequency, pps stability, pps jitter,
+calibration interval, calibration cycles, jitter exceeded,
+stability exceeded, calibration errors.
+As with other ntpq output, times are in milliseconds; very small values
+may be shown as exponentials.
+The precision value displayed is in milliseconds as well, unlike the
+precision system variable.
.br
.ns
.TP 10
.NOP \f\*[B-Font]lassociations\f[]
-Perform the same function as the associations command, except display mobilized and unmobilized associations.
+Perform the same function as the associations command, except display
+mobilized and unmobilized associations, including all clients.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
-Obtain and print a list of all peers and clients showing
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version).
+.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
+Display a list of all peers and clients showing
+\f\*[B-Font]dstadr\f[]
+(associated with the given IP version).
.br
.ns
.TP 10
-.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
-Print a peer spreadsheet for the appropriate IP version(s).
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version).
+.NOP \f\*[B-Font]lpassociations\f[]
+Display the last obtained list of associations, including all clients.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
+Display a list of all peers and clients (associated with the given IP version).
.br
.ns
.TP 10
.NOP \f\*[B-Font]monstats\f[]
-Display monitor facility statistics.
+Display monitor facility status, statistics, and limits:
+enabled, addresses, peak addresses, maximum addresses,
+reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mreadlist\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mrl\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
+Perform the same function as the
+\f\*[B-Font]readlist\f[]
+command for a range of association ids.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mreadvar\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
+This range may be determined from the list displayed by any
+command showing associations.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[]]
-Obtain and print traffic counts collected and maintained by the monitor facility.
+.NOP \f\*[B-Font]mrv\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
+Perform the same function as the
+\f\*[B-Font]readvar\f[]
+command for a range of association ids.
+This range may be determined from the list displayed by any
+command showing associations.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]\&=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]\&=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]\&=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]\&=\f\*[I-Font]hexmask\f[]]
+Display traffic counts of the most recently seen source addresses
+collected and maintained by the monitor facility.
With the exception of
-\f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[],
+\f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[],
the options filter the list returned by
-\f\*[B-Font]ntpd.\f[]
+\fCntpd\f[]\fR(8)\f[].
The
\f\*[B-Font]limited\f[]
and
\f\*[B-Font]kod\f[]
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+options return only entries representing client addresses from which the
+last packet received triggered either discarding or a KoD response.
The
\f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[]
option filters entries representing less than
\f\*[I-Font]sortorder\f[]
defaults to
\f\*[B-Font]lstint\f[]
-and may be any of
+and may be
\f\*[B-Font]addr\f[],
-\f\*[B-Font]count\f[],
\f\*[B-Font]avgint\f[],
+\f\*[B-Font]count\f[],
\f\*[B-Font]lstint\f[],
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by
+\[oq]\&-\[cq]
+to reverse the sort order.
The output columns are:
.RS
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]lstint\f[]
-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
+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
\f\*[B-Font]ntpq\fP.
.br
.ns
Restriction flags associated with this address.
Most are copied unchanged from the matching
\f\*[B-Font]restrict\f[]
-command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
+the last packet from this address triggered a rate control response.
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[]
-DNS name, numeric address, or address followed by
+host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
.RE
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mreadvar\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]mrv\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
-Perform the same function as the
-\f\*[B-Font]readvar\f[]
-command, except for a range of association IDs.
-This range is determined from the association list cached by the most recent
-\f\*[B-Font]associations\f[]
-command.
-.br
-.ns
-.TP 10
.NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
Obtain and print the old-style list of all peers and clients showing
-\f\*[I-Font]dstadr\f[]
-(associated with any given IP version),
+\f\*[B-Font]dstadr\f[]
+(associated with the given IP version),
rather than the
-\f\*[I-Font]refid\f[].
+\f\*[B-Font]refid\f[].
.br
.ns
.TP 10
.TP 10
.NOP \f\*[B-Font]remote\f[]
host name (or IP number) of peer.
-The value displayed will be truncated to 15 characters unless the
+The value displayed will be truncated to 15 characters unless the
+\f\*[B-Font]ntpq\fP
\f\*[B-Font]\-w\f[]
-flag is given, in which case the full value will be displayed
-on the first line,
-and the remaining data is displayed on the next line.
+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.
.br
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-association ID or
+source IP address or
.Lk decode.html#kiss "'kiss code"
.br
.ns
.TP 10
.NOP \f\*[B-Font]st\f[]
-stratum
+stratum: 0 for local reference clocks, 1 for servers with local
+reference clocks, ..., 16 for unsynchronized server clocks
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]when\f[]
-sec/min/hr since last received packet
+time in seconds, minutes, hours, or days since the last packet
+was received, or
+\[oq]\&-\[cq]
+if a packet has never been received
.br
.ns
.TP 10
.NOP \f\*[B-Font]poll\f[]
-poll interval (log2 s)
+poll interval (s)
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]jitter\f[]
-jitter
+offset RMS error estimate.
.RE
.br
.ns
.TP 10
-.NOP \f\*[B-Font]apeers\f[]
-Display a list of peers in the form:
-.Dl [tally]remote refid assid st t when pool reach delay offset jitter
-where the output is just like the
-\f\*[B-Font]peers\f[]
-command except that the
-\f\*[B-Font]refid\f[]
-is displayed in hex format and the association number is also displayed.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]assocID\f[]
-Show the statistics for the peer with the given
-\f\*[I-Font]assocID\f[].
+.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]associd\f[]
+Display the statistics for the peer with the given
+\f\*[I-Font]associd\f[]:
+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.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]readlist\f[] \f\*[I-Font]assocID\f[]
+.NOP \f\*[B-Font]readlist\f[] [\f\*[I-Font]associd\f[]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]rl\f[] \f\*[I-Font]assocID\f[]
-Read the system or peer variables included in the variable list.
+.NOP \f\*[B-Font]rl\f[] [\f\*[I-Font]associd\f[]]
+Display all system or peer variables.
+If the
+\f\*[I-Font]associd\f[]
+is omitted, it is assumed to be zero.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]readvar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
+.NOP \f\*[B-Font]readvar\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
.br
.ns
.TP 10
-.NOP \f\*[B-Font]rv\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
-Display the specified variables.
+.NOP \f\*[B-Font]rv\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
+Display the specified system or peer variables.
If
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is zero, the variables are from the
\fISystem\f[] \fIVariables\f[]
name space, otherwise they are from the
\fIPeer\f[] \fIVariables\f[]
name space.
The
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is required, as the same name can occur in both spaces.
If no
\f\*[I-Font]name\f[]
is included, all operative variables in the name space are displayed.
In this case only, if the
-\f\*[I-Font]assocID\f[]
-is omitted, it is assumed zero.
+\f\*[I-Font]associd\f[]
+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
-YYYYMMDDTTTT ,
-where YYYY is the year,
-MM the month of year,
-DD the day of month and
-TTTT the time of day.
+\f\*[I-Font]YYYY\f[]\f\*[I-Font]MM\f[] \f\*[I-Font]DD\f[] \f\*[I-Font]TTTT\f[],
+where
+\f\*[I-Font]YYYY\f[]
+is the year,
+\f\*[I-Font]MM\f[]
+the month of year,
+\f\*[I-Font]DD\f[]
+the day of month and
+\f\*[I-Font]TTTT\f[]
+the time of day.
.br
.ns
.TP 10
.NOP \f\*[B-Font]reslist\f[]
-Show the access control (restrict) list for
+Display the access control (restrict) list for
\f\*[B-Font]ntpq\fP.
+Authentication is required.
.br
.ns
.TP 10
.NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[]
-Write the current configuration,
-including any runtime modifications given with
+Save the current configuration,
+including any runtime modifications made by
\f\*[B-Font]:config\f[]
or
\f\*[B-Font]config-from-file\f[],
-to the ntpd host's file
+to the NTP server host file
\f\*[I-Font]filename\f[].
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-\f\*[B-Font]ntpd\f[]
+\fCntpd\f[]\fR(8)\f[]
configuration file.
\f\*[I-Font]filename\f[]
can use
-\fCstrftime\f[]\fR()\f[]
-format specifies to substitute the current date and time, for example,
-\f\*[B-Font]q]saveconfig\f[] \f\*[B-Font]ntp-%Y%m%d-%H%M%S.confq]\f[].
+\fCdate\f[]\fR(1)\f[]
+format specifiers to substitute the current date and time, for
+example,
+.in +4
+\f\*[B-Font]saveconfig\f[] \fIntp-%Y%m%d-%H%M%S.conf\f[].
+.in -4
The filename used is stored in system variable
\f\*[B-Font]savedconfig\f[].
Authentication is required.
.br
.ns
.TP 10
+.NOP \f\*[B-Font]sysinfo\f[]
+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.
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]sysstats\f[]
+Display system uptime and packet counts maintained in the
+protocol module:
+uptime, sysstats reset, packets received, current version,
+older version, bad length or format, authentication failed,
+declined, restricted, rate limited, KoD responses,
+processed for time.
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]timerstats\f[]
-Display interval timer counters.
+Display interval timer counters:
+time since reset, timer overruns, calls to transmit.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]assocID\f[]
-Write the system or peer variables included in the variable list.
+.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]associd\f[]
+Set all system or peer variables included in the variable list.
.br
.ns
.TP 10
-.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
-Write the specified variables.
+.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]associd\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
+Set the specified variables in the variable list.
If the
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is zero, the variables are from the
\fISystem\f[] \fIVariables\f[]
name space, otherwise they are from the
\fIPeer\f[] \fIVariables\f[]
name space.
The
-\f\*[I-Font]assocID\f[]
+\f\*[I-Font]associd\f[]
is required, as the same name can occur in both spaces.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]sysinfo\f[]
-Display operational summary.
-.br
-.ns
-.TP 10
-.NOP \f\*[B-Font]sysstats\f[]
-Print statistics counters maintained in the protocol module.
+Authentication is required.
.PP
.SS Status Words and Kiss Codes
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 in the
-\f\*[B-Font]rv\f[]
+These words are displayed by the
+\f\*[B-Font]readlist\f[]
and
-\f\*[B-Font]as\f[]
+\f\*[B-Font]associations\f[]
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"
in the reference identifier field in various billboards.
.SS System Variables
The following system variables appear in the
-\f\*[B-Font]rv\f[]
+\f\*[B-Font]readlist\f[]
billboard.
Not all variables are displayed in some configurations.
+.sp \n(Ppu
+.ne 2
+
.TP 10
.NOP Variable
Description
.br
.ns
.TP 10
-.NOP \f\*[B-Font]peer\f[]
-system peer association ID
+.NOP \f\*[B-Font]refid\f[]
+reference id or
+.Lk decode.html#kiss "kiss code"
.br
.ns
.TP 10
-.NOP \f\*[B-Font]tc\f[]
-time constant and poll exponent (log2 s) (3-17)
+.NOP \f\*[B-Font]reftime\f[]
+reference time
.br
.ns
.TP 10
-.NOP \f\*[B-Font]mintc\f[]
-minimum time constant (log2 s) (3-10)
+.NOP \f\*[B-Font]clock\f[]
+date and time of day
.br
.ns
.TP 10
-.NOP \f\*[B-Font]clock\f[]
-date and time of day
+.NOP \f\*[B-Font]peer\f[]
+system peer association id
.br
.ns
.TP 10
-.NOP \f\*[B-Font]refid\f[]
-reference ID or
-.Lk decode.html#kiss "kiss code"
+.NOP \f\*[B-Font]tc\f[]
+time constant and poll exponent (log2 s) (3-17)
.br
.ns
.TP 10
-.NOP \f\*[B-Font]reftime\f[]
-reference time
+.NOP \f\*[B-Font]mintc\f[]
+minimum time constant (log2 s) (3-10)
.br
.ns
.TP 10
.NOP \f\*[B-Font]offset\f[]
-combined offset of server relative to this host
+combined offset of server relative to this host
.br
.ns
.TP 10
-.NOP \f\*[B-Font]sys_jitter\f[]
-combined system jitter
+.NOP \f\*[B-Font]frequency\f[]
+frequency drift (PPM) relative to hardware clock
.br
.ns
.TP 10
-.NOP \f\*[B-Font]frequency\f[]
-frequency offset (PPM) relative to hardware clock
+.NOP \f\*[B-Font]sys_jitter\f[]
+combined system jitter
.br
.ns
.TP 10
.PP
.SS Peer Variables
The following peer variables appear in the
-\f\*[B-Font]rv\f[]
+\f\*[B-Font]readlist\f[]
billboard for each association.
Not all variables are displayed in some configurations.
+.sp \n(Ppu
+.ne 2
+
.TP 10
.NOP Variable
Description
.ns
.TP 10
.NOP \f\*[B-Font]associd\f[]
-association ID
+association id
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-reference ID or
+reference id or
.Lk decode.html#kiss "kiss code"
.br
.ns
.br
.ns
.TP 10
+.NOP \f\*[B-Font]rec\f[]
+last packet received time
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]reach\f[]
reach register (octal)
.br
.br
.ns
.TP 10
+.NOP \f\*[B-Font]keyid\f[]
+symmetric key id
+.br
+.ns
+.TP 10
.NOP \f\*[B-Font]offset\f[]
filter offset
.br
.br
.ns
.TP 10
-.NOP \f\*[B-Font]ident\f[]
-Autokey group name for this association
-.br
-.ns
-.TP 10
.NOP \f\*[B-Font]bias\f[]
unicast/broadcast bias
.br
\f\*[B-Font]bias\f[]
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.
+It represents the offset of the broadcast subgraph relative to the
+unicast subgraph.
The
\f\*[B-Font]xleave\f[]
variable appears only for the interleaved symmetric and interleaved modes.
.ns
.TP 10
.NOP \f\*[B-Font]initsequence\f[]
-initial key ID
+initial key id
.br
.ns
.TP 10
.TP 10
.NOP \f\*[B-Font]timestamp\f[]
Autokey signature timestamp
+.br
+.ns
+.TP 10
+.NOP \f\*[B-Font]ident\f[]
+Autokey group name for this association
.PP
.SS Clock Variables
The following clock variables appear in the
-\f\*[B-Font]cv\f[]
+\f\*[B-Font]clocklist\f[]
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]associd\f[]
-association ID
+association id
.br
.ns
.TP 10
.ns
.TP 10
.NOP \f\*[B-Font]refid\f[]
-driver reference ID
+driver reference id
.br
.ns
.TP 10
.SH "OPTIONS"
.TP
.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[]
-Force IPv4 DNS name resolution.
+Force IPv4 name resolution.
This option must not appear in combination with any of the following options:
ipv6.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv4 namespace.
.TP
.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[]
-Force IPv6 DNS name resolution.
+Force IPv6 name resolution.
This option must not appear in combination with any of the following options:
ipv4.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv6 namespace.
.TP
.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[]
numeric host addresses.
.sp
Output all host addresses in dotted-quad numeric format rather than
-converting to the canonical host names.
+converting to the canonical host names.
.TP
.NOP \f\*[B-Font]\-\-old\-rv\f[]
Always output status line with readvar.
-.Dd January 2 2017
+.Dd March 19 2017
.Dt NTPQ @NTPQ_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntpq-opts.mdoc)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:20 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:31 AM by AutoGen 5.18.5
.\" From the definitions ntpq-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
[ host ...]
.Pp
.Sh DESCRIPTION
+.Pp
The
.Nm
-utility program is used to query NTP servers which
-implement the standard NTP mode 6 control message formats defined
-in Appendix B of the NTPv3 specification RFC1305, requesting
+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.
-The same formats are used in NTPv4, although some of the
-variables have changed and new ones added. The description on this
-page is for the NTPv4 variables.
The program may be run either in interactive mode or controlled using
command line arguments.
Requests to read and write arbitrary
utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
+.Pp
If one or more request options is included on the command line
when
.Nm
.Nm
utility will prompt for
commands if the standard input is a terminal device.
+.Pp
.Nm
uses NTP mode 6 packets to communicate with the
NTP server, and hence can be used to query any compatible server on
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
+.Pp
+Note that in contexts where a host name is expected, a
+.Fl 4
+qualifier preceding the host name forces resolution to the IPv4
+namespace, while a
+.Fl 6
+qualifier forces resolution to the IPv6 namespace.
+For examples and usage, see the
+.Dq NTP Debugging Techniques
+page.
+.Pp
Specifying a
command line option other than
.Fl i
will attempt to read
interactive format commands from the standard input.
.Ss "Internal Commands"
+.Pp
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.
+.Pp
A
number of interactive format commands are executed entirely within
the
.Nm
-utility itself and do not result in NTP mode 6
+utility itself and do not result in NTP
requests being sent to a server.
These are described following.
-.Bl -tag -width "? [command_keyword]" -compact -offset indent
-.It Ic ? Op Ar command_keyword
-.It Ic help Op Ar command_keyword
+.Bl -tag -width "help [command]" -compact -offset indent
+.It Ic ? Op Ar command
+.It Ic help Op Ar command
A
.Ql \&?
-by itself will print a list of all the command
-keywords known to this incarnation of
+by itself will print a list of all the commands
+known to
.Nm .
A
.Ql \&?
-followed by a command keyword will print function and usage
+followed by a command name will print function and usage
information about the command.
-This command is probably a better
-source of information about
-.Nm
-than this manual
-page.
-.It Ic addvars Ar variable_name Ns Xo Op Ic =value
-.Ic ...
-.Xc
-.It Ic rmvars Ar variable_name Ic ...
+.It Ic addvars Ar name Ns Oo \&= Ns Ar value Ns Op ,...
+.It Ic rmvars Ar name Ns Op ,...
.It Ic clearvars
.It Ic showvars
-The data carried by NTP mode 6 messages consists of a list of
+The arguments to this command consist of a list of
items of the form
-.Ql variable_name=value ,
+.Ar name Ns Op \&= Ns Ar value ,
where the
-.Ql =value
+.No \&= Ns Ar value
is ignored, and can be omitted,
in requests to the server to read variables.
The
.Nm
-utility maintains an internal list in which data to be included in control
-messages can be assembled, and sent using the
+utility maintains an internal list in which data to be included in
+messages can be assembled, and displayed or set using the
.Ic readlist
and
.Ic writelist
.Ic rmvars
command can be used to remove individual variables from the list,
while the
-.Ic clearlist
+.Ic clearvars
command removes all variables from the
list.
The
.Ic showvars
command displays the current list of optional variables.
-.It Ic authenticate Op yes | no
+.It Ic authenticate Op Cm yes Ns | Ns Cm no
Normally
.Nm
does not authenticate requests unless
they are write requests.
The command
-.Ql authenticate yes
+.Ic authenticate Cm yes
causes
.Nm
to send authentication with all requests it
makes.
Authenticated requests causes some servers to handle
-requests slightly differently, and can occasionally melt the CPU in
-fuzzballs if you turn authentication on before doing a
-.Ic peer
-display.
+requests slightly differently.
The command
-.Ql authenticate
+.Ic authenticate
causes
.Nm
to display whether or not
-.Nm
-is currently autheinticating requests.
+it is currently authenticating requests.
.It Ic cooked
Causes output from query commands to be "cooked", so that
variables which are recognized by
values reformatted for human consumption.
Variables which
.Nm
-thinks should have a decodable value but didn't are
+could not decode completely are
marked with a trailing
.Ql \&? .
-.It Xo
-.Ic debug
-.Oo
-.Cm more |
-.Cm less |
-.Cm off
-.Oc
-.Xc
+.It Ic debug Op Cm more Ns | Ns Cm less Ns | Ns Cm off
With no argument, displays the current debug level.
-Otherwise, the debug level is changed to the indicated level.
-.It Ic delay Ar milliseconds
+Otherwise, the debugging level is changed as indicated.
+.It Ic delay Op Ar milliseconds
Specify a time interval to be added to timestamps included in
requests which require authentication.
This is used to enable
Actually the
server does not now require timestamps in authenticated requests,
so this command may be obsolete.
+Without any arguments, displays the current delay.
+.It Ic drefid Op Cm hash Ns | Ns Cm ipv4
+Display refids as IPv4 or hash.
+Without any arguments, displays whether refids are shown as IPv4
+addresses or hashes.
.It Ic exit
Exit
.Nm .
-.It Ic host Ar hostname
+.It Ic host Op Ar name
Set the host to which future queries will be sent.
-.Ar hostname
+The
+.Ar name
may be either a host name or a numeric address.
-.It Ic hostnames Op Cm yes | Cm no
+Without any arguments, displays the current host.
+.It Ic hostnames Op Cm yes Ns | Ns Cm no
If
.Cm yes
is specified, host names are printed in
modified using the command line
.Fl n
switch.
-.It Ic keyid Ar keyid
+Without any arguments, displays whether host names or numeric addresses
+are shown.
+.It Ic keyid Op Ar keyid
This command allows the specification of a key number to be
used to authenticate configuration requests.
This must correspond
.Cm controlkey
key number the server has been configured to use for this
purpose.
-.It Ic keytype Xo Oo
-.Cm md5 |
-.Cm OpenSSLDigestType
-.Oc
-.Xc
-Specify the type of key to use for authenticating requests.
-.Cm md5
-is alway supported.
+Without any arguments, displays the current
+.Ar keyid .
+.It Ic keytype Op Ar digest
+Specify the digest algorithm to use for authenticating requests, with default
+.Cm MD5 .
If
.Nm
-was built with OpenSSL support,
-any digest type supported by OpenSSL can also be provided.
+was built with OpenSSL support, and OpenSSL is installed,
+.Ar digest
+can be any message digest algorithm supported by OpenSSL.
If no argument is given, the current
-.Ic keytype
-is displayed.
-.It Ic ntpversion Xo Oo
-.Cm 1 |
-.Cm 2 |
-.Cm 3 |
-.Cm 4
-.Oc
-.Xc
+.Ic keytype Ar digest
+algorithm used is displayed.
+.It Ic ntpversion Op Cm 1 Ns | Ns Cm 2 Ns | Ns Cm 3 Ns | Ns Cm 4
Sets the NTP version number which
.Nm
claims in
The password must correspond to the key configured for
use by the NTP server for this purpose if such requests are to be
successful.
-.\" Not yet implemented.
-.\" .It Ic poll
-.\" .Op Ar n
-.\" .Op Ic verbose
-.\" Poll an NTP server in client mode
-.\" .Ar n
-.\" times.
+.It Ic poll Oo Ar n Oc Op Cm verbose
+Poll an NTP server in client mode
+.Ar n
+times.
+Poll not implemented yet.
.It Ic quit
Exit
.Nm .
The only formating/interpretation done on
the data is to transform nonascii data into a printable (but barely
understandable) form.
-.It Ic timeout Ar milliseconds
+.It Ic timeout Op Ar milliseconds
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
.Nm
retries each query once after a timeout, the total waiting time for
a timeout will be twice the timeout value set.
.It Ic version
-Print the version of the
+Display the version of the
.Nm
program.
.El
.Ss "Control Message Commands"
-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.
+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 message to the server and expect a
+single response message.
The exceptions are the
-.Li peers
+.Ic peers
command, which sends a series of messages,
and the
-.Li mreadlist
+.Ic mreadlist
and
-.Li mreadvar
+.Ic mreadvar
commands, which iterate over a range of associations.
.Bl -tag -width "something" -compact -offset indent
-.It Cm associations
+.It Ic apeers
+Display a list of peers in the form:
+.Dl [tally]remote refid assid st t when pool reach delay offset jitter
+where the output is just like the
+.Ic peers
+command except that the
+.Cm refid
+is displayed in hex format and the association number is also displayed.
+.It Ic associations
Display a list of mobilized associations in the form:
.Dl ind assid status conf reach auth condition last_event cnt
-.Bl -column -offset indent ".Sy Variable" ".Sy Description"
-.It Sy String Ta Sy Description
-.It Li ind Ta index on this list
-.It Li assid Ta association ID
-.It Li status Ta peer status word
-.It Li conf Ta Li yes : persistent, Li no : ephemeral
-.It Li reach Ta Li yes : reachable, Li no : unreachable
-.It Li auth Ta Li ok , Li yes , Li bad and Li none
-.It Li condition Ta selection status (see the Li select field of the peer status word)
-.It Li last_event Ta event report (see the Li event field of the peer status word)
-.It Li cnt Ta event count (see the Li count field of the peer status word)
+.Bl -column -offset indent ".Sy Variable" "see the select field of the peer status word"
+.It Sy Variable Ta Sy Description
+.It Cm ind Ta index on this list
+.It Cm assid Ta association id
+.It Cm status Ta peer status word
+.It Cm conf Ta Cm yes : No persistent, Cm no : No ephemeral
+.It Cm reach Ta Cm yes : No reachable, Cm no : No unreachable
+.It Cm auth Ta Cm ok , Cm yes , Cm bad No and Cm none
+.It Cm condition Ta selection status \&(see the Cm select No field of the peer status word\&)
+.It Cm last_event Ta event report \&(see the Cm event No field of the peer status word\&)
+.It Cm cnt Ta event count \&(see the Cm count No field of the peer status word\&)
.El
-.It Cm authinfo
-Display the authentication statistics.
-.It Cm clockvar Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
-.It Cm cv Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
-Display a list of clock variables for those associations supporting a reference clock.
-.It Cm :config Op ...
-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.
-.It Cm config\-from\-file Ar filename
-Send the each line of
+.It Ic authinfo
+Display the authentication statistics counters:
+time since reset, stored keys, free keys, key lookups, keys not found,
+uncached keys, expired keys, encryptions, decryptions.
+.It Ic clocklist Op Ar associd
+.It Ic cl Op Ar associd
+Display all clock variables in the variable list for those associations
+supporting a reference clock.
+.It Ic clockvar Oo Ar associd Oc Oo Ar name Ns Oo \&= Ns Ar value Oc Ns Oc Ns Op ,...
+.It Ic cv Oo Ar associd Oc Oo Ar name Ns Oo \&= Ns Ar value Oc Ns Oc Ns Op ,...
+Display a list of clock variables for those associations supporting a
+reference clock.
+.It Ic :config Ar "configuration command line"
+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.
+.It Ic config\-from\-file Ar filename
+Send each line of
.Ar filename
-to the server as run\-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
+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.
.It Ic ifstats
-Display statistics for each local network address. Authentication is required.
+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.
.It Ic iostats
-Display network and reference clock I/O statistics.
+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.
.It Ic kerninfo
-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.
+Display kernel loop and PPS statistics:
+associd, status, pll offset, pll frequency, maximum error,
+estimated error, kernel status, pll time constant, precision,
+frequency tolerance, pps frequency, pps stability, pps jitter,
+calibration interval, calibration cycles, jitter exceeded,
+stability exceeded, calibration errors.
+As with other ntpq output, times are in milliseconds; very small values
+may be shown as exponentials.
+The precision value displayed is in milliseconds as well, unlike the
+precision system variable.
.It Ic lassociations
-Perform the same function as the associations command, except display mobilized and unmobilized associations.
-.It Ic lopeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
-Obtain and print a list of all peers and clients showing
-.Ar dstadr
-(associated with any given IP version).
-.It Ic lpeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
-Print a peer spreadsheet for the appropriate IP version(s).
-.Ar dstadr
-(associated with any given IP version).
+Perform the same function as the associations command, except display
+mobilized and unmobilized associations, including all clients.
+.It Ic lopeers Op Fl 4 Ns | Ns Fl 6
+Display a list of all peers and clients showing
+.Cm dstadr
+(associated with the given IP version).
+.It Ic lpassociations
+Display the last obtained list of associations, including all clients.
+.It Ic lpeers Op Fl 4 Ns | Ns Fl 6
+Display a list of all peers and clients (associated with the given IP version).
.It Ic monstats
-Display monitor facility statistics.
-.It Ic mrulist Oo Ic limited | Ic kod | Ic mincount Ns = Ns Ar count | Ic laddr Ns = Ns Ar localaddr | Ic sort Ns = Ns Ar sortorder | Ic resany Ns = Ns Ar hexmask | Ic resall Ns = Ns Ar hexmask Oc
-Obtain and print traffic counts collected and maintained by the monitor facility.
+Display monitor facility status, statistics, and limits:
+enabled, addresses, peak addresses, maximum addresses,
+reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
+.It Ic mreadlist Ar associdlo Ar associdhi
+.It Ic mrl Ar associdlo Ar associdhi
+Perform the same function as the
+.Ic readlist
+command for a range of association ids.
+.It Ic mreadvar Ar associdlo Ar associdhi Oo Ar name Oc Ns Op ,...
+This range may be determined from the list displayed by any
+command showing associations.
+.It Ic mrv Ar associdlo Ar associdhi Oo Ar name Oc Ns Op ,...
+Perform the same function as the
+.Ic readvar
+command for a range of association ids.
+This range may be determined from the list displayed by any
+command showing associations.
+.It Xo Ic mrulist Oo Cm limited | Cm kod | Cm mincount Ns \&= Ns Ar count |
+.Cm laddr Ns \&= Ns Ar localaddr | Cm sort Ns \&= Ns Oo \&\- Oc Ns Ar sortorder |
+.Cm resany Ns \&= Ns Ar hexmask | Cm resall Ns \&= Ns Ar hexmask Oc
+.Xc
+Display traffic counts of the most recently seen source addresses
+collected and maintained by the monitor facility.
With the exception of
-.Cm sort Ns = Ns Ar sortorder ,
+.Cm sort Ns \&= Ns Oo \&\- Oc Ns Ar sortorder ,
the options filter the list returned by
-.Cm ntpd.
+.Xr ntpd 8 .
The
.Cm limited
and
.Cm kod
-options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
+options return only entries representing client addresses from which the
+last packet received triggered either discarding or a KoD response.
The
.Cm mincount Ns = Ns Ar count
option filters entries representing less than
.Ar sortorder
defaults to
.Cm lstint
-and may be any of
+and may be
.Cm addr ,
-.Cm count ,
.Cm avgint ,
+.Cm count ,
.Cm lstint ,
-or any of those preceded by a minus sign (hyphen) to reverse the sort order.
+or any of those preceded by
+.Ql \&\-
+to reverse the sort order.
The output columns are:
.Bl -tag -width "something" -compact -offset indent
.It Column
Description
.It Ic lstint
-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
+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
.Nm .
.It Ic avgint
Average interval in s between packets from this address.
Restriction flags associated with this address.
Most are copied unchanged from the matching
.Ic restrict
-command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
+command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
+the last packet from this address triggered a rate control response.
.It Ic r
Rate control indicator, either
a period,
.It Ic rport
Source port of last packet from this address.
.It Ic remote address
-DNS name, numeric address, or address followed by
+host or DNS name, numeric address, or address followed by
claimed DNS name which could not be verified in parentheses.
.El
-.It Ic mreadvar assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
-.It Ic mrv assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
-Perform the same function as the
-.Ic readvar
-command, except for a range of association IDs.
-This range is determined from the association list cached by the most recent
-.Ic associations
-command.
-.It Ic opeers Xo
-.Oo Ic \-4 |
-.Ic \-6
-.Oc
-.Xc
+.It Ic opeers Op Fl 4 | Fl 6
Obtain and print the old\-style list of all peers and clients showing
-.Ar dstadr
-(associated with any given IP version),
+.Cm dstadr
+(associated with the given IP version),
rather than the
-.Ar refid .
+.Cm refid .
.It Ic passociations
Perform the same function as the
.Ic associations
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic [tally]
+.It Cm [tally]
single\-character code indicating current value of the
.Ic select
field of the
.Lk decode.html#peer "peer status word"
-.It Ic remote
+.It Cm remote
host name (or IP number) of peer.
-The value displayed will be truncated to 15 characters unless the
+The value displayed will be truncated to 15 characters unless the
+.Nm
.Fl w
-flag is given, in which case the full value will be displayed
-on the first line,
-and the remaining data is displayed on the next line.
-.It Ic refid
-association ID or
+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.
+.It Cm refid
+source IP address or
.Lk decode.html#kiss "'kiss code"
-.It Ic st
-stratum
-.It Ic t
+.It Cm st
+stratum: 0 for local reference clocks, 1 for servers with local
+reference clocks, ..., 16 for unsynchronized server clocks
+.It Cm t
.Ic u :
unicast or manycast client,
.Ic b :
broadcast server,
.Ic M :
multicast server
-.It Ic when
-sec/min/hr since last received packet
-.It Ic poll
-poll interval (log2 s)
-.It Ic reach
+.It Cm when
+time in seconds, minutes, hours, or days since the last packet
+was received, or
+.Ql \&\-
+if a packet has never been received
+.It Cm poll
+poll interval (s)
+.It Cm reach
reach shift register (octal)
-.It Ic delay
+.It Cm delay
roundtrip delay
-.It Ic offset
+.It Cm offset
offset of server relative to this host
-.It Ic jitter
-jitter
+.It Cm jitter
+offset RMS error estimate.
.El
-.It Ic apeers
-Display a list of peers in the form:
-.Dl [tally]remote refid assid st t when pool reach delay offset jitter
-where the output is just like the
-.Ic peers
-command except that the
-.Ic refid
-is displayed in hex format and the association number is also displayed.
-.It Ic pstats Ar assocID
-Show the statistics for the peer with the given
-.Ar assocID .
-.It Ic readlist Ar assocID
-.It Ic rl Ar assocID
-Read the system or peer variables included in the variable list.
-.It Ic readvar Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc Oo , ... Oc
-.It Ic rv Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc Oo , ... Oc
-Display the specified variables.
+.It Ic pstats Ar associd
+Display the statistics for the peer with the given
+.Ar associd :
+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.
+.It Ic readlist Op Ar associd
+.It Ic rl Op Ar associd
+Display all system or peer variables.
+If the
+.Ar associd
+is omitted, it is assumed to be zero.
+.It Ic readvar Op Ar associd Ar name Ns Oo Ns = Ns Ar value Oc Op , ...
+.It Ic rv Op Ar associd Ar name Ns Oo Ns = Ns Ar value Oc Op , ...
+Display the specified system or peer variables.
If
-.Ar assocID
+.Ar associd
is zero, the variables are from the
.Sx System Variables
name space, otherwise they are from the
.Sx Peer Variables
name space.
The
-.Ar assocID
+.Ar associd
is required, as the same name can occur in both spaces.
If no
.Ar name
is included, all operative variables in the name space are displayed.
In this case only, if the
-.Ar assocID
-is omitted, it is assumed zero.
+.Ar associd
+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
-YYYYMMDDTTTT ,
-where YYYY is the year,
-MM the month of year,
-DD the day of month and
-TTTT the time of day.
+.Ar YYYY Ns Ar MM Ar DD Ar TTTT ,
+where
+.Ar YYYY
+is the year,
+.Ar MM
+the month of year,
+.Ar DD
+the day of month and
+.Ar TTTT
+the time of day.
.It Ic reslist
-Show the access control (restrict) list for
+Display the access control (restrict) list for
.Nm .
+Authentication is required.
.It Ic saveconfig Ar filename
-Write the current configuration,
-including any runtime modifications given with
+Save the current configuration,
+including any runtime modifications made by
.Ic :config
or
.Ic config\-from\-file ,
-to the ntpd host's file
+to the NTP server host file
.Ar filename .
This command will be rejected by the server unless
.Lk miscopt.html#saveconfigdir "saveconfigdir"
appears in the
-.Ic ntpd
+.Xr ntpd 8
configuration file.
.Ar filename
can use
-.Xr strftime
-format specifies to substitute the current date and time, for example,
-.Ic q]saveconfig ntp\-%Y%m%d\-%H%M%S.confq] .
+.Xr date 1
+format specifiers to substitute the current date and time, for
+example,
+.D1 Ic saveconfig Pa ntp\-%Y%m%d\-%H%M%S.conf .
The filename used is stored in system variable
-.Ic savedconfig .
+.Cm savedconfig .
Authentication is required.
+.It Ic sysinfo
+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.
+.It Ic sysstats
+Display system uptime and packet counts maintained in the
+protocol module:
+uptime, sysstats reset, packets received, current version,
+older version, bad length or format, authentication failed,
+declined, restricted, rate limited, KoD responses,
+processed for time.
.It Ic timerstats
-Display interval timer counters.
-.It Ic writelist Ar assocID
-Write the system or peer variables included in the variable list.
-.It Ic writevar Ar assocID Ar name Ns = Ns Ar value Op , ...
-Write the specified variables.
+Display interval timer counters:
+time since reset, timer overruns, calls to transmit.
+.It Ic writelist Ar associd
+Set all system or peer variables included in the variable list.
+.It Ic writevar Ar associd Ar name Ns = Ns Ar value Op , ...
+Set the specified variables in the variable list.
If the
-.Ar assocID
+.Ar associd
is zero, the variables are from the
.Sx System Variables
name space, otherwise they are from the
.Sx Peer Variables
name space.
The
-.Ar assocID
+.Ar associd
is required, as the same name can occur in both spaces.
-.It Ic sysinfo
-Display operational summary.
-.It Ic sysstats
-Print statistics counters maintained in the protocol module.
+Authentication is required.
.El
.Ss Status Words and Kiss Codes
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 in the
-.Ic rv
+These words are displayed by the
+.Ic readlist
and
-.Ic as
+.Ic associations
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"
in the reference identifier field in various billboards.
.Ss System Variables
The following system variables appear in the
-.Ic rv
+.Ic readlist
billboard.
Not all variables are displayed in some configurations.
+.Pp
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic status
+.It Cm status
.Lk decode.html#sys "system status word"
-.It Ic version
+.It Cm version
NTP software version and build time
-.It Ic processor
+.It Cm processor
hardware platform and version
-.It Ic system
+.It Cm system
operating system and version
-.It Ic leap
+.It Cm leap
leap warning indicator (0\-3)
-.It Ic stratum
+.It Cm stratum
stratum (1\-15)
-.It Ic precision
+.It Cm precision
precision (log2 s)
-.It Ic rootdelay
+.It Cm rootdelay
total roundtrip delay to the primary reference clock
-.It Ic rootdisp
+.It Cm rootdisp
total dispersion to the primary reference clock
-.It Ic peer
-system peer association ID
-.It Ic tc
-time constant and poll exponent (log2 s) (3\-17)
-.It Ic mintc
-minimum time constant (log2 s) (3\-10)
-.It Ic clock
-date and time of day
-.It Ic refid
-reference ID or
+.It Cm refid
+reference id or
.Lk decode.html#kiss "kiss code"
-.It Ic reftime
+.It Cm reftime
reference time
-.It Ic offset
-combined offset of server relative to this host
-.It Ic sys_jitter
+.It Ic clock
+date and time of day
+.It Cm peer
+system peer association id
+.It Cm tc
+time constant and poll exponent (log2 s) (3\-17)
+.It Cm mintc
+minimum time constant (log2 s) (3\-10)
+.It Cm offset
+combined offset of server relative to this host
+.It Cm frequency
+frequency drift (PPM) relative to hardware clock
+.It Cm sys_jitter
combined system jitter
-.It Ic frequency
-frequency offset (PPM) relative to hardware clock
-.It Ic clk_wander
+.It Cm clk_wander
clock frequency wander (PPM)
-.It Ic clk_jitter
+.It Cm clk_jitter
clock jitter
-.It Ic tai
+.It Cm tai
TAI\-UTC offset (s)
-.It Ic leapsec
+.It Cm leapsec
NTP seconds when the next leap second is/was inserted
-.It Ic expire
+.It Cm expire
NTP seconds when the NIST leapseconds file expires
.El
The jitter and wander statistics are exponentially\-weighted RMS averages.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic host
+.It Cm host
Autokey host name for this host
-.It Ic ident
+.It Cm ident
Autokey group name for this host
-.It Ic flags
+.It Cm flags
host flags (see Autokey specification)
-.It Ic digest
+.It Cm digest
OpenSSL message digest algorithm
-.It Ic signature
+.It Cm signature
OpenSSL digest/signature scheme
-.It Ic update
+.It Cm update
NTP seconds at last signature update
-.It Ic cert
+.It Cm cert
certificate subject, issuer and certificate flags
-.It Ic until
+.It Cm until
NTP seconds when the certificate expires
.El
.Ss Peer Variables
The following peer variables appear in the
-.Ic rv
+.Ic readlist
billboard for each association.
Not all variables are displayed in some configurations.
+.Pp
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic associd
-association ID
-.It Ic status
+.It Cm associd
+association id
+.It Cm status
.Lk decode.html#peer "peer status word"
-.It Ic srcadr
+.It Cm srcadr
source (remote) IP address
-.It Ic srcport
+.It Cm srcport
source (remote) port
-.It Ic dstadr
+.It Cm dstadr
destination (local) IP address
-.It Ic dstport
+.It Cm dstport
destination (local) port
-.It Ic leap
+.It Cm leap
leap indicator (0\-3)
-.It Ic stratum
+.It Cm stratum
stratum (0\-15)
-.It Ic precision
+.It Cm precision
precision (log2 s)
-.It Ic rootdelay
+.It Cm rootdelay
total roundtrip delay to the primary reference clock
-.It Ic rootdisp
+.It Cm rootdisp
total root dispersion to the primary reference clock
-.It Ic refid
-reference ID or
+.It Cm refid
+reference id or
.Lk decode.html#kiss "kiss code"
-.It Ic reftime
+.It Cm reftime
reference time
-.It Ic reach
+.It Cm rec
+last packet received time
+.It Cm reach
reach register (octal)
-.It Ic unreach
+.It Cm unreach
unreach counter
-.It Ic hmode
+.It Cm hmode
host mode (1\-6)
-.It Ic pmode
+.It Cm pmode
peer mode (1\-5)
-.It Ic hpoll
+.It Cm hpoll
host poll exponent (log2 s) (3\-17)
-.It Ic ppoll
+.It Cm ppoll
peer poll exponent (log2 s) (3\-17)
-.It Ic headway
+.It Cm headway
headway (see
.Lk rate.html "Rate Management and the Kiss\-o'\-Death Packet" )
-.It Ic flash
+.It Cm flash
.Lk decode.html#flash "flash status word"
-.It Ic offset
+.It Cm keyid
+symmetric key id
+.It Cm offset
filter offset
-.It Ic delay
+.It Cm delay
filter delay
-.It Ic dispersion
+.It Cm dispersion
filter dispersion
-.It Ic jitter
+.It Cm jitter
filter jitter
-.It Ic ident
-Autokey group name for this association
-.It Ic bias
+.It Cm bias
unicast/broadcast bias
-.It Ic xleave
+.It Cm xleave
interleave delay (see
.Lk xleave.html "NTP Interleaved Modes" )
.El
The
-.Ic bias
+.Cm bias
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.
+It represents the offset of the broadcast subgraph relative to the
+unicast subgraph.
The
-.Ic xleave
+.Cm xleave
variable appears only for the interleaved symmetric and interleaved modes.
It represents the internal queuing, buffering and transmission delays
for the preceding packet.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic flags
+.It Cm flags
peer flags (see Autokey specification)
-.It Ic host
+.It Cm host
Autokey server name
-.It Ic flags
+.It Cm flags
peer flags (see Autokey specification)
-.It Ic signature
+.It Cm signature
OpenSSL digest/signature scheme
-.It Ic initsequence
-initial key ID
-.It Ic initkey
+.It Cm initsequence
+initial key id
+.It Cm initkey
initial key index
-.It Ic timestamp
+.It Cm timestamp
Autokey signature timestamp
+.It Cm ident
+Autokey group name for this association
.El
.Ss Clock Variables
The following clock variables appear in the
-.Ic cv
+.Ic clocklist
billboard for each association with a reference clock.
Not all variables are displayed in some configurations.
.Bl -tag -width "something" -compact -offset indent
.It Variable
Description
-.It Ic associd
-association ID
-.It Ic status
+.It Cm associd
+association id
+.It Cm status
.Lk decode.html#clock "clock status word"
-.It Ic device
+.It Cm device
device description
-.It Ic timecode
+.It Cm timecode
ASCII time code string (specific to device)
-.It Ic poll
+.It Cm poll
poll messages sent
-.It Ic noreply
+.It Cm noreply
no reply
-.It Ic badformat
+.It Cm badformat
bad format
-.It Ic baddata
+.It Cm baddata
bad date or time
-.It Ic fudgetime1
+.It Cm fudgetime1
fudge time 1
-.It Ic fudgetime2
+.It Cm fudgetime2
fudge time 2
-.It Ic stratum
+.It Cm stratum
driver stratum
-.It Ic refid
-driver reference ID
-.It Ic flags
+.It Cm refid
+driver reference id
+.It Cm flags
driver flags
.El
.Sh "OPTIONS"
.Bl -tag
.It Fl 4 , Fl \-ipv4
-Force IPv4 DNS name resolution.
+Force IPv4 name resolution.
This option must not appear in combination with any of the following options:
ipv6.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv4 namespace.
.It Fl 6 , Fl \-ipv6
-Force IPv6 DNS name resolution.
+Force IPv6 name resolution.
This option must not appear in combination with any of the following options:
ipv4.
.sp
-Force DNS resolution of following host names on the command line
+Force resolution of following host names on the command line
to the IPv6 namespace.
.It Fl c Ar cmd , Fl \-command Ns = Ns Ar cmd
run a command and exit.
numeric host addresses.
.sp
Output all host addresses in dotted\-quad numeric format rather than
-converting to the canonical host names.
+converting to the canonical host names.
.It Fl \-old\-rv
Always output status line with readvar.
.sp
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual</title>
-
-<meta name="description" content="ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual">
-<meta name="keywords" content="ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>ntpsnmpd: Network Time Protocol SNMP Daemon User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="ntpsnmpd: Network Time Protocol SNMP Daemon User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">ntpsnmpd: Network Time Protocol SNMP Daemon User's Manual</h1>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">ntpsnmpd: Network Time Protocol Query User Manual</a>
+</ul>
+</div>
+
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsnmpd-Description">ntpsnmpd Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+</div>
+<h2 class="unnumbered">ntpsnmpd: Network Time Protocol Query User Manual</h2>
+<p>The <code>ntpsnmpd</code> utility program is used to monitor NTP daemon <code>ntpd</code>
+operations and determine performance. It uses the standard NTP mode 6 control
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
+ <p>This document applies to version 4.2.8p9 of <code>ntpsnmpd</code>.
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+<ul class="menu">
+<li><a accesskey="1" href="#ntpsnmpd-Description">ntpsnmpd Description</a>: Description
+<li><a accesskey="2" href="#ntpsnmpd-Invocation">ntpsnmpd Invocation</a>: Invoking ntpsnmpd
+<li><a accesskey="3" href="#Usage">Usage</a>: Usage
</ul>
-</div>
+<div class="node">
+<a name="ntpsnmpd-Description"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Usage">Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<a name="Top"></a>
-<div class="header">
-<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>
</div>
-<a name="ntpsnmpd_003a-Network-Time-Protocol-Query-User-Manual"></a>
-<h1 class="top">ntpsnmpd: Network Time Protocol Query User Manual</h1>
-<p>The <code>ntpsnmpd</code> utility program is used to monitor NTP daemon <code>ntpd</code>
-operations and determine performance. It uses the standard NTP mode 6 control
-</p>
-<p>This document applies to version 4.2.8p9-win of <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>
-
-<hr>
-<a name="ntpsnmpd-Description"></a>
-<div class="header">
-<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>
-</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>The <code>ntpsnmpd</code> utility program provides an SNMP MIB agent for <code>ntpd</code>.
-</p>
-<hr>
+
+<div class="node">
<a name="Usage"></a>
-<div class="header">
-<p>
-Previous: <a href="#ntpsnmpd-Description" accesskey="p" rel="prev">ntpsnmpd Description</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntpsnmpd-Description">ntpsnmpd Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Usage-1"></a>
-<h3 class="section">1.1 Usage</h3>
-<p>(what should we say here?)
-</p><hr>
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</h3>
+<p>(what should we say here?)
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Ntp-wait User’s Manual</title>
-
-<meta name="description" content="Ntp-wait User’s Manual">
-<meta name="keywords" content="Ntp-wait User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Ntp-wait User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Ntp-wait User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Ntp-wait User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">Ntp-wait User's Manual</h1>
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-Description">ntp-wait Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<h1 class="node-heading">Top</h1>
-<p>This document describes the use of the NTP Project’s <code>ntp-wait</code> program.
-</p>
-<p>If there are time-sensitive applications,
+ <p>This document describes the use of the NTP Project's <code>ntp-wait</code> program.
+
+
<p>If there are time-sensitive applications,
the proper sequence of events is to
run <code>ntpd -g</code> as early as possible,
then invoke all of the non-time-sensitive process,
run <code>ntp-wait</code> to block
-until the system’s time has stabilized and synchronized,
+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.8p9-win of <code>ntp-wait</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-<div class="shortcontents">
-<li><a name="stoc-Invoking-ntp_002dwait" href="#toc-Invoking-ntp_002dwait">1 Invoking ntp-wait</a></li>
+ <p>This document applies to version 4.2.8p9 of <code>ntp-wait</code>.
+<div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002dwait-Description">ntp-wait Description</a>: Description
+<li><a accesskey="2" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>: Invoking ntp-wait
+</ul>
-<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>
+<div class="node">
+<a name="ntp-wait-Invocation"></a>
<a name="ntp_002dwait-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<a name="Invoking-ntp_002dwait"></a>
-<h3 class="section">1 Invoking ntp-wait</h3>
-<a name="index-ntp_002dwait"></a>
-<a name="index-Wait-for-ntpd-to-stabilize-the-system-clock"></a>
+<h3 class="section">0.1 Invoking ntp-wait</h3>
+<p><a name="index-ntp_002dwait-1"></a><a name="index-Wait-for-ntpd-to-stabilize-the-system-clock-2"></a>
-<p><code>ntp-wait</code>
+
<p><code>ntp-wait</code>
will send at most
<kbd>num-tries</kbd>
queries to
after each status return that says
<code>ntpd(8)</code>
has not yet produced a synchronized and stable system clock.
-</p>
-<p><code>ntp-wait</code>
+
+
<p><code>ntp-wait</code>
will do this quietly, unless the
<code>-v</code>
-flag is provided.
+flag is provided.
This can be useful at boot time, to delay the boot sequence until after
<kbd>ntpd</kbd> <kbd>-g</kbd>
has set the time.
-</p>
-<p>This section was generated by <strong>AutoGen</strong>,
+
+
<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>
-<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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002dwait-usage">ntp-wait usage</a>: ntp-wait help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntp_002dwait-tries">ntp-wait tries</a>: tries option (-n)
+<li><a accesskey="3" href="#ntp_002dwait-sleep">ntp-wait sleep</a>: sleep option (-s)
+<li><a accesskey="4" href="#ntp_002dwait-verbose">ntp-wait verbose</a>: verbose option (-v)
+<li><a accesskey="5" href="#ntp_002dwait-exit-status">ntp-wait exit status</a>: exit status
+<li><a accesskey="6" href="#ntp_002dwait-Authors">ntp-wait Authors</a>: Authors
+<li><a accesskey="7" href="#ntp_002dwait-Notes">ntp-wait Notes</a>: Notes
+</ul>
+
+<div class="node">
+<a name="ntp-wait-usage"></a>
<a name="ntp_002dwait-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-tries">ntp-wait tries</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="ntp_002dwait-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.1 ntp-wait help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">0.1.1 ntp-wait help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntp_002dwait-help-3"></a>
+This is the automatically generated usage text for ntp-wait.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
-USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
-n, --tries=num Number of times to check ntpd
-s, --sleep=num How long to sleep between tries
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
+<a name="ntp-wait-tries"></a>
<a name="ntp_002dwait-tries"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-sleep">ntp-wait sleep</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-usage">ntp-wait usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="tries-option-_0028_002dn_0029"></a>
-<h4 class="subsection">1.2 tries option (-n)</h4>
-<a name="index-ntp_002dwait_002dtries"></a>
-<p>This is the “number of times to check ntpd” option.
-This option takes a number argument.
+<h4 class="subsection">0.1.2 tries option (-n)</h4>
+
+<p><a name="index-ntp_002dwait_002dtries-4"></a>
+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
- it has been able to synchronize and stabilize the system clock.
-</p><hr>
+ it has been able to synchronize and stabilize the system clock.
+<div class="node">
+<a name="ntp-wait-sleep"></a>
<a name="ntp_002dwait-sleep"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-verbose">ntp-wait verbose</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-tries">ntp-wait tries</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="sleep-option-_0028_002ds_0029"></a>
-<h4 class="subsection">1.3 sleep option (-s)</h4>
-<a name="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".
-</p><hr>
+
+<h4 class="subsection">0.1.3 sleep option (-s)</h4>
+
+<p><a name="index-ntp_002dwait_002dsleep-5"></a>
+This is the “how long to sleep between tries” option.
+This option takes a number argument <samp><span class="file">secs-between-tries</span></samp>.
+ We will sleep for <samp><span class="file">secs-between-tries</span></samp> after each query
+ of <code>ntpd</code> that returns "the time is not yet stable".
+<div class="node">
+<a name="ntp-wait-verbose"></a>
<a name="ntp_002dwait-verbose"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-exit-status">ntp-wait exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-sleep">ntp-wait sleep</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="verbose-option-_0028_002dv_0029"></a>
-<h4 class="subsection">1.4 verbose option (-v)</h4>
-<a name="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.
-</p><hr>
+
+<h4 class="subsection">0.1.4 verbose option (-v)</h4>
+
+<p><a name="index-ntp_002dwait_002dverbose-6"></a>
+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.
+<div class="node">
+<a name="ntp-wait-exit-status"></a>
<a name="ntp_002dwait-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-Authors">ntp-wait Authors</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-verbose">ntp-wait verbose</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="ntp_002dwait-exit-status-1"></a>
-<h4 class="subsection">1.5 ntp-wait exit status</h4>
+
+<h4 class="subsection">0.1.5 ntp-wait exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
+ <div class="node">
+<a name="ntp-wait-Authors"></a>
<a name="ntp_002dwait-Authors"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-Notes">ntp-wait Notes</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-exit-status">ntp-wait exit status</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="ntp_002dwait-Authors-1"></a>
-<h4 class="subsection">1.6 ntp-wait Authors</h4>
-<hr>
+
+<h4 class="subsection">0.1.6 ntp-wait Authors</h4>
+
+<div class="node">
+<a name="ntp-wait-Notes"></a>
<a name="ntp_002dwait-Notes"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait-Authors">ntp-wait Authors</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
</div>
-<a name="ntp_002dwait-Notes-1"></a>
-<h4 class="subsection">1.7 ntp-wait Notes</h4>
-<hr>
+<h4 class="subsection">0.1.7 ntp-wait Notes</h4>
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>ntpsweep User’s Manual</title>
-
-<meta name="description" content="ntpsweep User’s Manual">
-<meta name="keywords" content="ntpsweep User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>ntpsweep User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="ntpsweep User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">ntpsweep User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">ntpsweep User's Manual</h1>
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<h1 class="node-heading">Top</h1>
-<p>This document describes the use of the NTP Project’s <code>ntpsweep</code> program.
-</p>
-<p>This document applies to version 4.2.8p9-win of <code>ntpsweep</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
+ <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program.
-<div class="shortcontents">
-<li><a name="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li>
+ <p>This document applies to version 4.2.8p9 of <code>ntpsweep</code>.
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description
+<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep
+</ul>
-<table class="menu" border="0" cellspacing="0">
-<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
-</td></tr>
-</table>
-
-<hr>
+<div class="node">
<a name="ntpsweep-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<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>
+<h3 class="section">0.1 Invoking ntpsweep</h3>
+
+<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a>
+<code>ntpsweep</code>
prints per host the NTP stratum level, the clock offset in seconds, the daemon
version, the operating system and the processor. Optionally recursing through
all peers.
-</p>
-<p>This section was generated by <strong>AutoGen</strong>,
+
+
<p>This section was generated by <strong>AutoGen</strong>,
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>)
-</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)
-</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)
-</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)
-</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)
-</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)
-</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
-</td></tr>
-</table>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l)
+<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p)
+<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m)
+<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s)
+<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h)
+<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status
+</ul>
+
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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>
-<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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">0.1.1 ntpsweep help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntpsweep-help-3"></a>
+This is the automatically generated usage text for ntpsweep.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit
with a status code of 0.
-</p>
-<div class="example">
+
<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p9
USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile]
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
+<a name="ntpsweep-host-list"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">0.1.2 host-list option (-l)</h4>
+
+<p><a name="index-ntpsweep_002dhost_002dlist-4"></a>
+This is the “host to execute actions on” option.
This option takes a string argument.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>Use this option to specify the host on which this script operates.
- May appear multiple times.
-</p><hr>
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</ul>
+
+ <p>Use this option to specify the host on which this script operates.
+ May appear multiple times.
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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>
+<h4 class="subsection">0.1.3 peers option (-p)</h4>
+
+<p><a name="index-ntpsweep_002dpeers-5"></a>
+This is the “recursively list all peers a host synchronizes to” option.
+This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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>
+
+<h4 class="subsection">0.1.4 maxlevel option (-m)</h4>
+
+<p><a name="index-ntpsweep_002dmaxlevel-6"></a>
+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><span class="samp">doc</span></samp>’ documentation.
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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>
+<h4 class="subsection">0.1.5 strip option (-s)</h4>
+
+<p><a name="index-ntpsweep_002dstrip-7"></a>
+This is the “strip this string from hostnames” option.
+This option takes a string argument.
+This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<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.
-This option has no ‘<samp>doc</samp>’ documentation.
-</p>
-<p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong>
-</p><hr>
+<h4 class="subsection">0.1.6 host option (-h)</h4>
+
+<p><a name="index-ntpsweep_002dhost-8"></a>
+This is the “specify a single host” option.
+This option takes a string argument.
+This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+
+ <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong>
+<div class="node">
<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>,
+Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
+
</div>
-<a name="ntpsweep-exit-status-1"></a>
-<h4 class="subsection">1.7 ntpsweep exit status</h4>
+
+<h4 class="subsection">0.1.7 ntpsweep exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
-
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Ntptrace User’s Manual</title>
-
-<meta name="description" content="Ntptrace User’s Manual">
-<meta name="keywords" content="Ntptrace User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Ntptrace User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Ntptrace User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">Ntptrace User's Manual</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntptrace-Description">ntptrace Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Ntptrace User’s Manual</h1>
-
-
+</div>
+<h2 class="unnumbered">Simple Network Time Protocol User Manual</h2>
+<p>This document describes the use of the NTP Project's <code>ntptrace</code> program.
+This document applies to version 4.2.8p9 of <code>ntptrace</code>.
-<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>
-<a name="Simple-Network-Time-Protocol-User-Manual"></a>
-<h1 class="top">Simple Network Time Protocol User Manual</h1>
-
-<p>This document describes the use of the NTP Project’s <code>ntptrace</code> program.
-This document applies to version 4.2.8p9-win of <code>ntptrace</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Invoking-ntptrace" href="#toc-Invoking-ntptrace">1 Invoking ntptrace</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Simple Network Time Protocol User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#ntptrace-Description">ntptrace Description</a>: Description
+<li><a accesskey="2" href="#ntptrace-Invocation">ntptrace Invocation</a>: Invoking ntptrace
+</ul>
-<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>
-
-<hr>
+<div class="node">
<a name="ntptrace-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntptrace-Description">ntptrace Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Invoking-ntptrace"></a>
-<h2 class="chapter">1 Invoking ntptrace</h2>
-<a name="index-ntptrace"></a>
-<a name="index-Trace-peers-of-an-NTP-server"></a>
-<p><code>ntptrace</code> is a perl script that uses the ntpq utility program to follow
+<h3 class="section">Invoking ntptrace</h3>
+
+<p><a name="index-ntptrace-1"></a><a name="index-Trace-peers-of-an-NTP-server-2"></a>
+<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.
-</p>
-<p>If given no arguments, ntptrace starts with localhost. Here is an example of
+
+
<p>If given no arguments, ntptrace starts with localhost. Here is an example of
the output from ntptrace:
-</p>
-<div class="example">
-<pre class="example">% 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,
+
+<pre class="example"> % 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>
+ <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>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
estimated error relative to the primary source. These terms are precisely
defined in RFC-1305.
-</p>
-<p>This section was generated by <strong>AutoGen</strong>,
+
<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>
-<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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntptrace-usage">ntptrace usage</a>: ntptrace help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntptrace-numeric">ntptrace numeric</a>: numeric option (-n)
+<li><a accesskey="3" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>: max-hosts option (-m)
+<li><a accesskey="4" href="#ntptrace-host">ntptrace host</a>: host option (-r)
+<li><a accesskey="5" href="#ntptrace-exit-status">ntptrace exit status</a>: exit status
+</ul>
+
+<div class="node">
<a name="ntptrace-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntptrace-numeric">ntptrace numeric</a>,
+Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>
+
</div>
-<a name="ntptrace-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h3 class="section">1.1 ntptrace help/usage (<samp>--help</samp>)</h3>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">ntptrace help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntptrace-help-3"></a>
+This is the automatically generated usage text for ntptrace.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host]
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<a name="ntptrace-numeric"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntptrace-usage">ntptrace usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>
+
</div>
-<a name="numeric-option-_0028_002dn_0029"></a>
-<h4 class="subsection">1.1.1 numeric option (-n)</h4>
-<a name="index-ntptrace_002dnumeric"></a>
-<p>This is the “print ip addresses instead of hostnames” option.
+<h4 class="subsection">numeric option (-n)</h4>
+
+<p><a name="index-ntptrace_002dnumeric-4"></a>
+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>
+the canonical host names.
+<div class="node">
+<a name="ntptrace-max-hosts"></a>
<a name="ntptrace-max_002dhosts"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntptrace-host">ntptrace host</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntptrace-numeric">ntptrace numeric</a>,
+Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>
+
</div>
-<a name="max_002dhosts-option-_0028_002dm_0029"></a>
-<h4 class="subsection">1.1.2 max-hosts option (-m)</h4>
-<a name="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.
-</p><hr>
+
+<h4 class="subsection">max-hosts option (-m)</h4>
+
+<p><a name="index-ntptrace_002dmax_002dhosts-5"></a>
+This is the “maximum number of peers to trace” option.
+This option takes a number argument.
+This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+<div class="node">
<a name="ntptrace-host"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntptrace-exit-status">ntptrace exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>,
+Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>
+
</div>
-<a name="host-option-_0028_002dr_0029"></a>
-<h4 class="subsection">1.1.3 host option (-r)</h4>
-<a name="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.
-</p><hr>
+
+<h4 class="subsection">host option (-r)</h4>
+
+<p><a name="index-ntptrace_002dhost-6"></a>
+This is the “single remote host” option.
+This option takes a string argument.
+This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+<div class="node">
<a name="ntptrace-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntptrace-host">ntptrace host</a>,
+Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>
+
</div>
-<a name="ntptrace-exit-status-1"></a>
-<h4 class="subsection">1.1.4 ntptrace exit status</h4>
+
+<h4 class="subsection">ntptrace exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
-
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Plot_summary User’s Manual</title>
-
-<meta name="description" content="Plot_summary User’s Manual">
-<meta name="keywords" content="Plot_summary User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Plot_summary User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Plot_summary User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">Plot_summary User's Manual</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Plot_summary User’s Manual</h1>
-
-
+</div>
+<h2 class="unnumbered">Plot_summary User Manual</h2>
+<p>This document describes the use of the NTP Project's <code>plot_summary</code> program.
+This document applies to version 4.2.8p9 of <code>plot_summary</code>.
-<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>
-<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.8p9-win of <code>plot_summary</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Plot_summary User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description
+<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary
+</ul>
-<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
-</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
-</td></tr>
-</table>
-
-<hr>
+<div class="node">
+<a name="plot_summary-Invocation"></a>
<a name="plot_005fsummary-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<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>
+<h3 class="section">Invoking plot_summary</h3>
-<p>This section was generated by <strong>AutoGen</strong>,
+<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></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>)
-</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
-</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
-</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
-</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
-</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
-</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
-</td></tr>
-</table>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option
+<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option
+<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option
+<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option
+<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option
+<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status
+</ul>
+
+<div class="node">
+<a name="plot_summary-usage"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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>
-<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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">plot_summary help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-plot_005fsummary-help-3"></a>
+This is the automatically generated usage text for plot_summary.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit
with a status code of 0.
-</p>
-<div class="example">
+
<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p9
-USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
--directory=str Where the summary files are
--identifier=str Origin of the data
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
+<a name="plot_summary-directory"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">directory option</h4>
+
+<p><a name="index-plot_005fsummary_002ddirectory-4"></a>
+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>
+ *_summary files generated by <code>summary</code> script.
+<div class="node">
+<a name="plot_summary-identifier"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>,
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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
+<h4 class="subsection">identifier option</h4>
+
+<p><a name="index-plot_005fsummary_002didentifier-5"></a>
+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>
+<div class="node">
+<a name="plot_summary-peer"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">peer option</h4>
+
+<p><a name="index-plot_005fsummary_002dpeer-6"></a>
+This is the “peers to generate plots for” option.
This option takes a string argument.
-</p>
-<p>This option has some usage constraints. It:
-</p><ul>
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<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>
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>may appear an unlimited number of times.
+</ul>
+
+ <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.
+<div class="node">
+<a name="plot_summary-plot-term"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">plot-term option</h4>
+
+<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a>
+This is the “gnuplot terminal” option.
+This option takes a string argument.
This is string is passed directly to the <code>gnuplot set terminal</code>
command. Default is <code>x11</code> if <code>DISPLAY</code> is set and
- <code>dumb</code> is it’s not’. See output from (gnuplot -e "set
- terminal") for the list of available options.
-</p><hr>
+ <code>dumb</code> is it's not'. See output from -e "set
+ terminal") for the list of available options.
+<div class="node">
+<a name="plot_summary-output-file"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<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>
+
+<h4 class="subsection">output-file option</h4>
+
+<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a>
+This is the “output file” option.
+This option takes a str argument.
+ Output file for <code>gnuplot</code>, default to stdout.
+<div class="node">
+<a name="plot_summary-exit-status"></a>
<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
+Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
+
</div>
-<a name="plot_005fsummary-exit-status-1"></a>
-<h4 class="subsection">1.1.6 plot_summary exit status</h4>
+
+<h4 class="subsection">plot_summary exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
-
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Summary User’s Manual</title>
-
-<meta name="description" content="Summary User’s Manual">
-<meta name="keywords" content="Summary User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Summary User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Summary User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
+<body>
+<h1 class="settitle">Summary User's Manual</h1>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Summary User’s Manual</h1>
-
-
+</div>
+<h2 class="unnumbered">Summary User Manual</h2>
+<p>This document describes the use of the NTP Project's <code>summary</code> program.
+This document applies to version 4.2.8p9 of <code>summary</code>.
-<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>
-<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.8p9-win of <code>summary</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Summary User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#summary-Description">summary Description</a>: Description
+<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: Invoking summary
+</ul>
-<table class="menu" border="0" cellspacing="0">
-<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
-</td></tr>
-</table>
-
-<hr>
+<div class="node">
<a name="summary-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
-</div>
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
+<h3 class="section">Invoking summary</h3>
+<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a>
-<p>This section was generated by <strong>AutoGen</strong>,
+
<p>This section was generated by <strong>AutoGen</strong>,
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>)
-</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
-</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
-</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
-</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
-</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
-</td></tr>
-</table>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#summary-usage">summary usage</a>: summary help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#summary-directory">summary directory</a>: directory option
+<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>: end-date option
+<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>: output-directory option
+<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>: start-date option
+<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>: exit status
+</ul>
+
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<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>
-<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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">summary help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-summary-help-3"></a>
+This is the automatically generated usage text for summary.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit
with a status code of 0.
-</p>
-<div class="example">
+
<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p9
-USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
--directory=str Directory containing stat files
--end-date=num End date
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>,
+Previous: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">directory option</h4>
+
+<p><a name="index-summary_002ddirectory-4"></a>
+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>
+ by <code>ntpd</code>.
+<div class="node">
+<a name="summary-end-date"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>,
+Previous: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">end-date option</h4>
+
+<p><a name="index-summary_002dend_002ddate-5"></a>
+This is the “end date” option.
+This option takes a number argument.
Process all files with the date suffix less or equal to value of this
option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>)
- to get the timestamp.
-</p><hr>
+ to get the timestamp.
+<div class="node">
+<a name="summary-output-directory"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>,
+Previous: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<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>
+
+<h4 class="subsection">output-directory option</h4>
+
+<p><a name="index-summary_002doutput_002ddirectory-6"></a>
+This is the “output directory” option.
+This option takes a str argument.
+ The output directory <code>summary</code> will write all output files to.
+<div class="node">
+<a name="summary-start-date"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">start-date option</h4>
+
+<p><a name="index-summary_002dstart_002ddate-7"></a>
+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>
+ this option. Defaults to 197000101.
+<div class="node">
<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>,
+Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
+
</div>
-<a name="summary-exit-status-1"></a>
-<h4 class="subsection">1.1.5 summary exit status</h4>
+
+<h4 class="subsection">summary exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
-
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>update-leap User’s Manual</title>
-
-<meta name="description" content="update-leap User’s Manual">
-<meta name="keywords" content="update-leap User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>update-leap User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="update-leap User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">update-leap User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">update-leap User's Manual</h1>
+<div class="node">
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-Description">update-leap Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<h1 class="node-heading">Top</h1>
-<p>This document describes the use of the NTP Project’s <code>update-leap</code> program.
-</p>
-<p>This document applies to version 4.2.8p9-win of <code>update-leap</code>.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
+ <p>This document describes the use of the NTP Project's <code>update-leap</code> program.
-<div class="shortcontents">
-<li><a name="stoc-Invoking-update_002dleap" href="#toc-Invoking-update_002dleap">1 Invoking update-leap</a></li>
+ <p>This document applies to version 4.2.8p9 of <code>update-leap</code>.
+<div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#update_002dleap-Description">update-leap Description</a>: Description
+<li><a accesskey="2" href="#update_002dleap-Invocation">update-leap Invocation</a>: Invoking update-leap
+</ul>
-<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
-</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
-</td></tr>
-</table>
-
-<hr>
+<div class="node">
+<a name="update-leap-Invocation"></a>
<a name="update_002dleap-Invocation"></a>
-<div class="header">
-<p>
-Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<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>
+<h3 class="section">0.1 Invoking update-leap</h3>
+<p><a name="index-update_002dleap-1"></a><a name="index-leap_002dseconds-file-manager_002fupdater-2"></a>
-<p><code>update-leap</code>
+
<p><code>update-leap</code>
will validate the file currently on the local system
and if necessary, updates leap-second definition file.
-</p>
-<p>Ordinarily, the file is found using the "leapfile" directive in
-<code>ntp.conf(5)</code>.
+
+ <p>Ordinarily, the file is found using the "leapfile" directive in
+<code>ntp.conf(5)</code>.
However, an alternate location can be specified on the command line.
-</p>
-<p>If the file does not exist, is not valid, has expired, or is expiring soon,
+
+
<p>If the file does not exist, is not valid, has expired, or is expiring soon,
a new copy will be downloaded. If the new copy validates, it is installed and
NTP is (optionally) restarted.
-</p>
-<p>If the current file is acceptable, no download or restart occurs.
-</p>
-<p>-c can also be used to invoke another script to perform administrative
-functions, e.g. to copy the file to other local systems.
+
+
<p>If the current file is acceptable, no download or restart occurs.
+
+
<p>-c can also be used to invoke another script to perform administrative
+functions, e.g. to copy the file to other local systems.
.PP
This can be run as a cron job. As the file is rarely updated, and leap
seconds are announced at least one month in advance (usually longer), it
-need not be run more frequently than about once every three weeks.
+need not be run more frequently than about once every three weeks.
.PP
-For cron-friendly behavior, define CRONJOB=1 in the crontab.
+For cron-friendly behavior, define CRONJOB=1 in the crontab.
.PP
This script depends on$REQUIREDCMDS
-</p>
-<p>This section was generated by <strong>AutoGen</strong>,
+
+
<p>This section was generated by <strong>AutoGen</strong>,
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>)
-</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)
-</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)
-</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)
-</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)
-</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)
-</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)
-</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
-</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
-</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
-</td></tr>
-</table>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#update_002dleap-usage">update-leap usage</a>: update-leap help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#update_002dleap-source_002durl">update-leap source-url</a>: source-url option (-s)
+<li><a accesskey="3" href="#update_002dleap-ipv4">update-leap ipv4</a>: ipv4 option (-4)
+<li><a accesskey="4" href="#update_002dleap-destination">update-leap destination</a>: destination option (-d)
+<li><a accesskey="5" href="#update_002dleap-expiration">update-leap expiration</a>: expiration option (-e)
+<li><a accesskey="6" href="#update_002dleap-ntp_002dconf_002dfile">update-leap ntp-conf-file</a>: ntp-conf-file option (-f)
+<li><a accesskey="7" href="#update_002dleap-force_002dupdate">update-leap force-update</a>: force-update option (-F)
+<li><a accesskey="8" href="#update_002dleap-exit-status">update-leap exit status</a>: exit status
+<li><a accesskey="9" href="#update_002dleap-Usage">update-leap Usage</a>: Usage
+<li><a href="#update_002dleap-Authors">update-leap Authors</a>: Authors
+</ul>
+
+<div class="node">
+<a name="update-leap-usage"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-source_002durl">update-leap source-url</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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>
-<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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">0.1.1 update-leap help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-update_002dleap-help-3"></a>
+This is the automatically generated usage text for update-leap.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit
with a status code of 0.
-</p>
-<div class="example">
+
<pre class="example"> update-leap
Usage: $0 [options] [leapfile]
Specify the URL of the master copy to download $LEAPSRC -d Specify
the filename on the local system $LEAPFILE -e Specify how long (in
days) before expiration the file is to be refreshed. Note that
- larger values imply more frequent refreshes. "$PREFETCH" -f Specify
+ larger values imply more frequent refreshes. "$PREFETCH" -f Specify
location of ntp.conf (used to make sure leapfile directive is
present and to default leapfile) $NTPCONF -F Force update even if
current file is OK and not close to expiring. -r Specify number of
$0 will validate the file currently on the local system
- Ordinarily, the file is found using the "leapfile" directive in
+ Ordinarily, the file is found using the "leapfile" directive in
$NTPCONF. However, an alternate location can be specified on the
command line.
For cron-friendly behavior, define CRONJOB=1 in the crontab.
Version $VERSION
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
+<a name="update-leap-source-url"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-ipv4">update-leap ipv4</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-usage">update-leap usage</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">0.1.2 source-url option (-s)</h4>
+
+<p><a name="index-update_002dleap_002dsource_002durl-4"></a>
+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>
+<div class="node">
+<a name="update-leap-ipv4"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-destination">update-leap destination</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-source_002durl">update-leap source-url</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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>
-<p>This option has some usage constraints. It:
-<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.
+
+<h4 class="subsection">0.1.3 ipv4 option (-4)</h4>
+
+<p><a name="index-update_002dleap_002dipv4-5"></a>
+This is the “use only ipv4 addresses for dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv6.
+</ul>
+
+
<p>Force DNS resolution of following host names on the command line
+ to the IPv4 namespace.
_EndOfDoc_;
;
-</p>
-<p>flag =
+
name = ipv6;
flags-cant = ipv4, prefer;
value = 6;
- descrip = "Use only IPv6 addresses for DNS name resolution";
+ descrip = "Use only IPv6 addresses for DNS name resolution";
doc = <<- _EndOfDoc_
Force DNS resolution of following host names on the command line
- to the IPv6 namespace.
+ to the IPv6 namespace.
_EndOfDoc_;
;
-</p>
-<p>flag =
+
name = prefer;
flags-cant = ipv4, ipv6;
value = p;
arg-type = keyword;
keyword = 4, 6;
- descrip = ’Prefer IPv4 or IPv6 (as specified) addresses, but use either’;
+ descrip = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either';
doc = <<- _EndOfDoc_
-Prefer IPv4 or IPv6 (as specified) addresses, but use either.
-</p><hr>
+Prefer IPv4 or IPv6 (as specified) addresses, but use either.
+<div class="node">
+<a name="update-leap-destination"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-expiration">update-leap expiration</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-ipv4">update-leap ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">0.1.4 destination option (-d)</h4>
+
+<p><a name="index-update_002dleap_002ddestination-6"></a>
+This is the “filename on the local system” option.
+This option takes a string argument <samp><span class="file">float</span></samp>.
+The name to use to store the leapfile on the local system.
$LEAPFILE
-</p><hr>
+<div class="node">
+<a name="update-leap-expiration"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-ntp_002dconf_002dfile">update-leap ntp-conf-file</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-destination">update-leap destination</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">0.1.5 expiration option (-e)</h4>
+
+<p><a name="index-update_002dleap_002dexpiration-7"></a>
+This is the “refresh the leapfile this long before it expires” option.
+This option takes a string argument.
Specify how long before expiration the file is to be refreshed
-Units are required, e.g. "-e 60 days" Note that larger values
-imply more frequent refreshes.
-"$PREFETCH"
-</p><hr>
+Units are required, e.g. "-e 60 days" Note that larger values
+imply more frequent refreshes.
+"$PREFETCH"
+<div class="node">
+<a name="update-leap-ntp-conf-file"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-force_002dupdate">update-leap force-update</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-expiration">update-leap expiration</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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.
+<h4 class="subsection">0.1.6 ntp-conf-file option (-f)</h4>
+
+<p><a name="index-update_002dleap_002dntp_002dconf_002dfile-8"></a>
+This is the “location of the ntp.conf file” option.
+This option takes a string argument.
Specify location of ntp.conf (used to make sure leapfile directive is
present and to default leapfile)
/etc/ntp.conf
-</p><hr>
+<div class="node">
+<a name="update-leap-force-update"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-exit-status">update-leap exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-ntp_002dconf_002dfile">update-leap ntp-conf-file</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<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>
+<h4 class="subsection">0.1.7 force-update option (-F)</h4>
+
+<p><a name="index-update_002dleap_002dforce_002dupdate-9"></a>
+This is the “force update of the leapfile” option.
+Force update even if current file is OK and not close to expiring.
+<div class="node">
+<a name="update-leap-exit-status"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-Usage">update-leap Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-force_002dupdate">update-leap force-update</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<a name="update_002dleap-exit-status-1"></a>
-<h4 class="subsection">1.8 update-leap exit status</h4>
+
+<h4 class="subsection">0.1.8 update-leap exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
-<dd><p>The operation failed or the command syntax was not valid.
-</p></dd>
+ <dl>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
</dl>
-<hr>
+ <div class="node">
+<a name="update-leap-Usage"></a>
<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#update_002dleap-Authors">update-leap Authors</a>,
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-exit-status">update-leap exit status</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<a name="update_002dleap-Usage-1"></a>
-<h4 class="subsection">1.9 update-leap Usage</h4>
-<hr>
+
+<h4 class="subsection">0.1.9 update-leap Usage</h4>
+
+<div class="node">
+<a name="update-leap-Authors"></a>
<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#update_002dleap-Usage">update-leap Usage</a>,
+Up: <a rel="up" accesskey="u" href="#update_002dleap-Invocation">update-leap Invocation</a>
+
</div>
-<a name="update_002dleap-Authors-1"></a>
-<h4 class="subsection">1.10 update-leap Authors</h4>
-<hr>
+<h4 class="subsection">0.1.10 update-leap Authors</h4>
+</body></html>
-</body>
-</html>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Sntp User’s Manual</title>
-
-<meta name="description" content="Sntp User’s Manual">
-<meta name="keywords" content="Sntp User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Sntp User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Sntp User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Sntp User’s Manual</h1>
-
-
-
-
-
+<body>
+<h1 class="settitle">Sntp User's Manual</h1>
+<div class="node">
<a name="Top"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-Description">sntp Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<a name="Simple-Network-Time-Protocol-User-Manual"></a>
-<h1 class="top">Simple Network Time Protocol User Manual</h1>
-<p>This document describes the use of the NTP Project’s <code>sntp</code> program,
+<h2 class="unnumbered">Simple Network Time Protocol User Manual</h2>
+
+<p>This document describes the use of the NTP Project's <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.8p9-win of <code>sntp</code>.
-</p>
-<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
+
+ <p>This document applies to version 4.2.8p9 of <code>sntp</code>.
+
+
<p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
IETF specification.
-</p>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Simple Network Time Protocol User Manual</a>
</ul>
</div>
+<ul class="menu">
+<li><a accesskey="1" href="#sntp-Description">sntp Description</a>: Description
+<li><a accesskey="2" href="#sntp-Invocation">sntp Invocation</a>: Invoking sntp
+<li><a accesskey="3" href="#Usage">Usage</a>: Usage
+</ul>
-<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>
-
-<hr>
+<div class="node">
<a name="sntp-Description"></a>
-<div class="header">
-<p>
-Next: <a href="#sntp-Invocation" accesskey="n" rel="next">sntp Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
+<p><hr>
+
+
</div>
-<a name="Description"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>By default, <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></div>
-<p>where
+<pre class="example"> 1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+</pre>
+ <p>where
YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
(+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
and
the +4.567 +/- 0.089 secs indicates the time offset and
error bound of the system clock relative to the server clock.
-</p>
-<hr>
+
+<div class="node">
<a name="sntp-Invocation"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Invoking-sntp"></a>
-<h3 class="section">1.1 Invoking sntp</h3>
-<a name="index-sntp"></a>
-<a name="index-standard-Simple-Network-Time-Protocol-client-program"></a>
+<h3 class="section">Invoking sntp</h3>
+<p><a name="index-sntp-1"></a><a name="index-standard-Simple-Network-Time-Protocol-client-program-2"></a>
-<p><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
+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>
job.
-</p>
-<p>NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol)
+
+
<p>NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol)
are defined and described by RFC 5905.
-</p>
-<p>The default is to write the estimated correct local date and time (i.e. not
+
<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>
-<p>where the
+
+
<p><code>'1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 [host] IP sN'</code>
+
<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>
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).
+(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.
+based on the reported precision of the server.
<code>'+/- 0.089'</code>
is the reported
<em>synchronization</em> <em>distance</em>
-(in seconds), which represents the maximum error due to all causes.
+(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>'+/- ?'</code>.
If the
<em>host</em>
is different from the
<em>IP</em>,
-both will be displayed.
-Otherwise, only the
+both will be displayed.
+Otherwise, only the
<em>IP</em>
-is displayed.
+is displayed.
Finally, the
<em>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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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>
-
-<hr>
+
+<ul class="menu">
+<li><a accesskey="1" href="#sntp-usage">sntp usage</a>: sntp help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#sntp-ipv4">sntp ipv4</a>: ipv4 option (-4)
+<li><a accesskey="3" href="#sntp-ipv6">sntp ipv6</a>: ipv6 option (-6)
+<li><a accesskey="4" href="#sntp-authentication">sntp authentication</a>: authentication option (-a)
+<li><a accesskey="5" href="#sntp-broadcast">sntp broadcast</a>: broadcast option (-b)
+<li><a accesskey="6" href="#sntp-concurrent">sntp concurrent</a>: concurrent option (-c)
+<li><a accesskey="7" href="#sntp-gap">sntp gap</a>: gap option (-g)
+<li><a accesskey="8" href="#sntp-kod">sntp kod</a>: kod option (-K)
+<li><a accesskey="9" href="#sntp-keyfile">sntp keyfile</a>: keyfile option (-k)
+<li><a href="#sntp-logfile">sntp logfile</a>: logfile option (-l)
+<li><a href="#sntp-steplimit">sntp steplimit</a>: steplimit option (-M)
+<li><a href="#sntp-ntpversion">sntp ntpversion</a>: ntpversion option (-o)
+<li><a href="#sntp-usereservedport">sntp usereservedport</a>: usereservedport option (-r)
+<li><a href="#sntp-timeout">sntp timeout</a>: timeout option (-t)
+<li><a href="#sntp-wait">sntp wait</a>: wait option
+<li><a href="#sntp-config">sntp config</a>: presetting/configuring sntp
+<li><a href="#sntp-exit-status">sntp exit status</a>: exit status
+<li><a href="#sntp-Usage">sntp Usage</a>: Usage
+<li><a href="#sntp-Authors">sntp Authors</a>: Authors
+</ul>
+
+<div class="node">
<a name="sntp-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-ipv4">sntp ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="sntp-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.1.1 sntp help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">sntp help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-sntp-help-3"></a>
+This is the automatically generated usage text for sntp.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
Usage: sntp [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \
[ hostname-or-IP ...]
- examining environment variables named SNTP_*
Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org>
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
<a name="sntp-ipv4"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-ipv6">sntp ipv6</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-usage">sntp usage</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="ipv4-option-_0028_002d4_0029"></a>
-<h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
-<a name="index-sntp_002dipv4"></a>
-
-<p>This is the “force ipv4 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv4 option (-4)</h4>
+
+<p><a name="index-sntp_002dipv4-4"></a>
+This is the “force ipv4 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv6.
+</ul>
+
+
<p>Force DNS resolution of the following host names on the command line
+to the IPv4 namespace.
+<div class="node">
<a name="sntp-ipv6"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-authentication">sntp authentication</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-ipv4">sntp ipv4</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="ipv6-option-_0028_002d6_0029"></a>
-<h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
-<a name="index-sntp_002dipv6"></a>
-
-<p>This is the “force ipv6 dns name resolution” option.
-</p>
-<p>This option has some usage constraints. It:
-<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>
+
+<h4 class="subsection">ipv6 option (-6)</h4>
+
+<p><a name="index-sntp_002dipv6-5"></a>
+This is the “force ipv6 dns name resolution” option.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must not appear in combination with any of the following options:
+ipv4.
+</ul>
+
+
<p>Force DNS resolution of the following host names on the command line
+to the IPv6 namespace.
+<div class="node">
<a name="sntp-authentication"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-broadcast">sntp broadcast</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-ipv6">sntp ipv6</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="authentication-option-_0028_002da_0029"></a>
-<h4 class="subsection">1.1.4 authentication option (-a)</h4>
-<a name="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>.
-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.
-</p><hr>
+
+<h4 class="subsection">authentication option (-a)</h4>
+
+<p><a name="index-sntp_002dauthentication-6"></a>
+This is the “enable authentication with the key <var>auth-keynumber</var>” option.
+This option takes a number argument <samp><span class="file">auth-keynumber</span></samp>.
+Enable authentication using the key specified in this option's
+argument. The argument of this option is the <samp><span class="option">keyid</span></samp>, a
+number specified in the <samp><span class="option">keyfile</span></samp> as this key's identifier.
+See the <samp><span class="option">keyfile</span></samp> option (<samp><span class="option">-k</span></samp>) for more details.
+<div class="node">
<a name="sntp-broadcast"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-concurrent">sntp concurrent</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-authentication">sntp authentication</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="broadcast-option-_0028_002db_0029"></a>
-<h4 class="subsection">1.1.5 broadcast option (-b)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>If specified <code>sntp</code> will listen to the specified address
+
+<h4 class="subsection">broadcast option (-b)</h4>
+
+<p><a name="index-sntp_002dbroadcast-7"></a>
+This is the “listen to the address specified for broadcast time sync” option.
+This option takes a string argument <samp><span class="file">broadcast-address</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</ul>
+
+
<p>If specified <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>.
-</p><hr>
+can (and probably should) be modified with <samp><span class="option">-t</span></samp>.
+<div class="node">
<a name="sntp-concurrent"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-gap">sntp gap</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-broadcast">sntp broadcast</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="concurrent-option-_0028_002dc_0029"></a>
-<h4 class="subsection">1.1.6 concurrent option (-c)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> may appear an unlimited number of times.
-</li></ul>
-
-<p>Requests from an NTP "client" to a "server" should never be sent
+
+<h4 class="subsection">concurrent option (-c)</h4>
+
+<p><a name="index-sntp_002dconcurrent-8"></a>
+This is the “concurrently query all ips returned for host-name” option.
+This option takes a string argument <samp><span class="file">host-name</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>may appear an unlimited number of times.
+</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
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><span class="option">-c</span></samp> or <samp><span class="option">--concurrent</span></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>
+different machines, so we can send concurrent queries.
+<div class="node">
<a name="sntp-gap"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-kod">sntp kod</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-concurrent">sntp concurrent</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="gap-option-_0028_002dg_0029"></a>
-<h4 class="subsection">1.1.7 gap option (-g)</h4>
-<a name="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>.
-Since we’re only going to use the first valid response we get and
+<h4 class="subsection">gap option (-g)</h4>
+
+<p><a name="index-sntp_002dgap-9"></a>
+This is the “the gap (in milliseconds) between time requests” option.
+This option takes a number argument <samp><span class="file">milliseconds</span></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>
+milliseconds.
+<div class="node">
<a name="sntp-kod"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-keyfile">sntp keyfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-gap">sntp gap</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="kod-option-_0028_002dK_0029"></a>
-<h4 class="subsection">1.1.8 kod option (-K)</h4>
-<a name="index-sntp_002dkod"></a>
-<p>This is the “kod history filename” option.
-This option takes a file argument <samp>file-name</samp>.
+<h4 class="subsection">kod option (-K)</h4>
+
+<p><a name="index-sntp_002dkod-10"></a>
+This is the “kod history filename” option.
+This option takes a file argument <samp><span class="file">file-name</span></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>
+warning message will be displayed. The file will not be created.
+<div class="node">
<a name="sntp-keyfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-logfile">sntp logfile</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-kod">sntp kod</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="keyfile-option-_0028_002dk_0029"></a>
-<h4 class="subsection">1.1.9 keyfile option (-k)</h4>
-<a name="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>.
-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
-information.
-</p><hr>
+
+<h4 class="subsection">keyfile option (-k)</h4>
+
+<p><a name="index-sntp_002dkeyfile-11"></a>
+This is the “look in this file for the key specified with <samp><span class="option">-a</span></samp>” option.
+This option takes a file argument <samp><span class="file">file-name</span></samp>.
+This option specifies the keyfile.
+<code>sntp</code> will search for the key specified with <samp><span class="option">-a</span></samp>
+<samp><span class="file">keyno</span></samp> in this file. See <samp><span class="command">ntp.keys(5)</span></samp> for more
+information.
+<div class="node">
<a name="sntp-logfile"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-steplimit">sntp steplimit</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-keyfile">sntp keyfile</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="logfile-option-_0028_002dl_0029"></a>
-<h4 class="subsection">1.1.10 logfile option (-l)</h4>
-<a name="index-sntp_002dlogfile"></a>
-<p>This is the “log to specified logfile” option.
-This option takes a file argument <samp>file-name</samp>.
+<h4 class="subsection">logfile option (-l)</h4>
+
+<p><a name="index-sntp_002dlogfile-12"></a>
+This is the “log to specified logfile” option.
+This option takes a file argument <samp><span class="file">file-name</span></samp>.
This option causes the client to write log messages to the specified
-<samp>logfile</samp>.
-</p><hr>
+<samp><span class="file">logfile</span></samp>.
+<div class="node">
<a name="sntp-steplimit"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-ntpversion">sntp ntpversion</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-logfile">sntp logfile</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="steplimit-option-_0028_002dM_0029"></a>
-<h4 class="subsection">1.1.11 steplimit option (-M)</h4>
-<a name="index-sntp_002dsteplimit"></a>
-
-<p>This is the “adjustments less than <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,
+
+<h4 class="subsection">steplimit option (-M)</h4>
+
+<p><a name="index-sntp_002dsteplimit-13"></a>
+This is the “adjustments less than <var>steplimit</var> msec will be slewed” option.
+This option takes a number argument.
+If the time adjustment is less than <samp><span class="file">steplimit</span></samp> milliseconds,
+slew the amount using <samp><span class="command">adjtime(2)</span></samp>. Otherwise, step the
+correction using <samp><span class="command">settimeofday(2)</span></samp>. The default value is 0,
which means all adjustments will be stepped. This is a feature, as
-different situations demand different values.
-</p><hr>
+different situations demand different values.
+<div class="node">
<a name="sntp-ntpversion"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-usereservedport">sntp usereservedport</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-steplimit">sntp steplimit</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="ntpversion-option-_0028_002do_0029"></a>
-<h4 class="subsection">1.1.12 ntpversion option (-o)</h4>
-<a name="index-sntp_002dntpversion"></a>
-<p>This is the “send <var>int</var> as our ntp protocol version” option.
-This option takes a number argument.
+<h4 class="subsection">ntpversion option (-o)</h4>
+
+<p><a name="index-sntp_002dntpversion-14"></a>
+This is the “send <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> .
-</p><hr>
+NTP protocol version <samp><span class="file">ntpversion</span></samp> .
+<div class="node">
<a name="sntp-usereservedport"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-timeout">sntp timeout</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-ntpversion">sntp ntpversion</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="usereservedport-option-_0028_002dr_0029"></a>
-<h4 class="subsection">1.1.13 usereservedport option (-r)</h4>
-<a name="index-sntp_002dusereservedport"></a>
-<p>This is the “use the ntp reserved port (port 123)” option.
+<h4 class="subsection">usereservedport option (-r)</h4>
+
+<p><a name="index-sntp_002dusereservedport-15"></a>
+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>
+communications.
+<div class="node">
<a name="sntp-timeout"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-wait">sntp wait</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-usereservedport">sntp usereservedport</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="timeout-option-_0028_002dt_0029"></a>
-<h4 class="subsection">1.1.14 timeout option (-t)</h4>
-<a name="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>.
+<h4 class="subsection">timeout option (-t)</h4>
+
+<p><a name="index-sntp_002dtimeout-16"></a>
+This is the “the number of seconds to wait for responses” option.
+This option takes a number argument <samp><span class="file">seconds</span></samp>.
When waiting for a reply, <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
only waiting for a broadcast response a longer timeout is
-likely needed.
-</p><hr>
+likely needed.
+<div class="node">
<a name="sntp-wait"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-config">sntp config</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-timeout">sntp timeout</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="wait-option"></a>
-<h4 class="subsection">1.1.15 wait option</h4>
-<a name="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.
-</li></ul>
-
-<p>If we are not setting the time, wait for all pending responses.
-</p>
-
-<hr>
+
+<h4 class="subsection">wait option</h4>
+
+<p><a name="index-sntp_002dwait-17"></a>
+This is the “wait for pending replies (if not setting the time)” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>can be disabled with –no-wait.
+<li>It is enabled by default.
+</ul>
+
+ <p>If we are not setting the time, wait for all pending responses.
+
+<div class="node">
<a name="sntp-config"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-exit-status">sntp exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-wait">sntp wait</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="presetting_002fconfiguring-sntp"></a>
-<h4 class="subsection">1.1.16 presetting/configuring sntp</h4>
+
+<h4 class="subsection">presetting/configuring sntp</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
-the options listed above in upper case and segmented with underscores.
+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
+the options listed above in upper case and segmented with underscores.
The <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
-</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>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
+
+<p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
+ <ul>
+<li>$HOME
+<li>$PWD
+</ul>
+ The environment variables <code>HOME</code>, and <code>PWD</code>
+are expanded and replaced when <samp><span class="file">sntp</span></samp> runs.
+For any of these that are plain files, they are simply processed.
+For any that are directories, then a file named <samp><span class="file">.ntprc</span></samp> is searched for
within that directory and processed.
-</p>
-<p>Configuration files may be in a wide variety of formats.
+
+ <p>Configuration files may be in a wide variety of formats.
The basic format is an option name followed by a value (argument) on the
same line. Values may be separated from the option name with a colon,
equal sign or simply white space. Values may be continued across multiple
lines by escaping the newline with a backslash.
-</p>
-<p>Multiple programs may also share the same initialization file.
+
+ <p>Multiple programs may also share the same initialization file.
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></div>
-<p>or by
-</p><div class="example">
-<pre class="example"><?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
+<pre class="example"> [SNTP]
+</pre>
+ <p class="noindent">or by
+<pre class="example"> <?program sntp>
+</pre>
+ <p class="noindent">Do not mix these styles within one configuration file.
+
+ <p>Compound values and carefully constructed string values may also be
specified using XML syntax:
-</p><div class="example">
-<pre class="example"><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><div class="example">
-<pre class="example">"...<...>..."
-</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
+<pre class="example"> <option-name>
+ <sub-opt>...&lt;...&gt;...</sub-opt>
+ </option-name>
+</pre>
+ <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
+<pre class="example"> "...<...>..."
+</pre>
+ <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
the associated name/value pair list (see: optionFindValue).
-</p>
-<p>The command line options relating to configuration and/or usage help are:
-</p>
-<a name="version-_0028_002d_0029"></a>
-<h4 class="subsubheading">version (-)</h4>
+
+ <p>The command line options relating to configuration and/or usage help are:
+
+<h5 class="subsubheading">version (-)</h5>
<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 infomation may be selected with an option argument.
+detail to provide. The default is to print just the version. The licensing infomation 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>
-<dd><p>Only print the version. This is the default.
-</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
-<dd><p>Name the copyright usage licensing terms.
-</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
-<dd><p>Print the full copyright usage licensing terms.
-</p></dd>
+
+ <dl>
+<dt>‘<samp><span class="samp">version</span></samp>’<dd>Only print the version. This is the default.
+<br><dt>‘<samp><span class="samp">copyright</span></samp>’<dd>Name the copyright usage licensing terms.
+<br><dt>‘<samp><span class="samp">verbose</span></samp>’<dd>Print the full copyright usage licensing terms.
</dl>
-<hr>
+<div class="node">
<a name="sntp-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-Usage">sntp Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-config">sntp config</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="sntp-exit-status-1"></a>
-<h4 class="subsection">1.1.17 sntp exit status</h4>
+
+<h4 class="subsection">sntp exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<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>
-<dd><p>A specified configuration file could not be loaded.
-</p></dd>
-<dt>‘<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>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
+<br><dt>‘<samp><span class="samp">66 (EX_NOINPUT)</span></samp>’<dd>A specified configuration file could not be loaded.
+<br><dt>‘<samp><span class="samp">70 (EX_SOFTWARE)</span></samp>’<dd>libopts had an internal operational error. Please report
+it to autogen-users@lists.sourceforge.net. Thank you.
</dl>
-<hr>
+ <div class="node">
<a name="sntp-Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#sntp-Authors">sntp Authors</a>,
+Previous: <a rel="previous" accesskey="p" href="#sntp-exit-status">sntp exit status</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="sntp-Usage-1"></a>
-<h4 class="subsection">1.1.18 sntp Usage</h4>
-<hr>
+
+<h4 class="subsection">sntp Usage</h4>
+
+<div class="node">
<a name="sntp-Authors"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#sntp-Usage">sntp Usage</a>,
+Up: <a rel="up" accesskey="u" href="#sntp-Invocation">sntp Invocation</a>
+
</div>
-<a name="sntp-Authors-1"></a>
-<h4 class="subsection">1.1.19 sntp Authors</h4>
-<hr>
+<h4 class="subsection">sntp Authors</h4>
+
+<div class="node">
<a name="Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Usage-1"></a>
-<h3 class="section">1.2 Usage</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</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.
+check the current time, offset, and error in the local clock.
For example:
-</p>
-<div class="example">
-<pre class="example">sntp ntpserver.somewhere
-</pre></div>
-<p>With suitable privilege, it can be run as a command or in a
+<pre class="example"> sntp ntpserver.somewhere
+</pre>
+ <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.
+the <code>ntpdate</code> and <code>rdate</code> commands.
For example:
-</p>
-<div class="example">
-<pre class="example">sntp -a ntpserver.somewhere
-</pre></div>
-<hr>
-
+<pre class="example"> sntp -a ntpserver.somewhere
+</pre>
+ </body></html>
-</body>
-</html>
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp-keygen.texi)
#
-# It has been AutoGen-ed January 2, 2017 at 12:05:37 PM by AutoGen 5.18.5
+# It has been AutoGen-ed March 19, 2017 at 10:10:41 AM by AutoGen 5.18.5
# From the definitions ntp-keygen-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
This program generates cryptographic data files used by the NTPv4
authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
-In addition, if the OpenSSL software library has been installed,
-it generates keys, certificate and identity files used in public key
-cryptography.
+It can generate message digest keys used in symmetric key cryptography and,
+if the OpenSSL software library has been installed, it can generate host keys,
+signing keys, certificates, and identity keys and parameters used in Autokey
+public key cryptography.
These files are used for cookie encryption,
-digital signature and challenge/response identification algorithms
+digital signature, and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
-All files are in PEM-encoded printable ASCII format,
-so they can be embedded as MIME attachments in mail to other sites
+The message digest symmetric keys file is generated in a format
+compatible with NTPv3.
+All other files are in PEM-encoded printable ASCII format,
+so they can be embedded as MIME attachments in email to other sites
and certificate authorities.
By default, files are not encrypted.
-When used to generate message digest keys, the program produces a file
-containing ten pseudo-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+When used to generate message digest symmetric keys, the program
+produces a file containing ten pseudo-random printable ASCII strings
+suitable for the MD5 message digest algorithm included in the
+distribution.
If the OpenSSL library is installed, it produces an additional ten
-hex-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
-The message digest keys file must be distributed and stored
+hex-encoded random bit strings suitable for SHA1, AES-128-CMAC, and
+other message digest algorithms.
+The message digest symmetric keys file must be distributed and stored
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
Some files used by this program are encrypted using a private password.
The
@code{-p}
-option specifies the password for local encrypted files and the
+option specifies the read password for local encrypted files and the
@code{-q}
-option the password for encrypted files sent to remote sites.
+option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-@code{gethostname()}
-function, normally the DNS name of the host is used.
+@code{hostname(1)}
+command, normally the DNS name of the host, is used as the the default read
+password, for convenience.
+The
+@code{ntp-keygen}
+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
+no write password is specified, the read password is used
+as the write password by default.
The
-@kbd{pw}
+@code{pw}
option of the
-@kbd{crypto}
+@code{crypto}
+@code{ntpd(1ntpdmdoc)}
configuration command specifies the read
password for previously encrypted local files.
-This must match the local password used by this program.
+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 password,
+Thus, if files are generated by this program without an explicit password,
they can be read back by
-@kbd{ntpd}
-without password but only on the same host.
+@code{ntpd(1ntpdmdoc)}
+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.
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
-@kbd{ntp.keys},
+@file{ntp.keys},
is usually installed in
@file{/etc}.
Other files and links are usually installed in
@file{/usr/local/etc},
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
-@kbd{keysdir}
-configuration command in such cases.
-Normally, this is in
-@file{/etc}.
+In these cases, NFS clients can specify the files in another
+directory such as
+@file{/etc}
+using the
+@code{keysdir}
+@code{ntpd(1ntpdmdoc)}
+configuration file command.
This program directs commentary and error messages to the standard
error stream
-@kbd{stderr}
+@file{stderr}
and remote files to the standard output stream
-@kbd{stdout}
+@file{stdout}
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
-@kbd{ntpkey}
+@file{ntpkey*}
and include the file type, generating host and filestamp,
as described in the
-@quotedblleft{}Cryptographic Data Files@quotedblright{}
+@ref{Cryptographic Data Files}
section below.
-@subsubsection Running the Program
-To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually
-@file{/usr/local/etc}
-When run for the first time, or if all files with names beginning with
-@kbd{ntpkey}
-have been removed, use the
-@code{ntp-keygen}
-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
-existing keys and parameters and generates only a new certificate with
-new expiration date one year hence.
-
-Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using
-@code{ntp-keygen}
-with the
-@code{-T}
-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
-ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
-All group hosts should have acyclic certificate trails ending on the TH.
-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}
-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}
-option.
-The rules say cryptographic media should be generated with proventic
-filestamps, which means the host should already be synchronized before
-this program is run.
-This of course creates a chicken-and-egg problem
-when the host is started for the first time.
-Accordingly, the host time
-should be set by some other means, such as eyeball-and-wristwatch, at
-least so that the certificate lifetime is within the current year.
-After that and when the host is synchronized to a proventic source, the
-certificate should be re-generated.
-
-Additional information on trusted groups and identity schemes is on the
-@quotedblleft{}Autokey Public-Key Authentication@quotedblright{}
-page.
-
-
-
-The
-@code{ntpd(1ntpdmdoc)}
-configuration command
-@code{crypto} @code{pw} @kbd{password}
-specifies the read password for previously encrypted files.
-The daemon expires on the spot if the password is missing
-or incorrect.
-For convenience, if a file has been previously encrypted,
-the default read password is the name of the host running
-the program.
-If the previous write password is specified as the host name,
-these files can be read by that host with no explicit password.
-
-
-File names begin with the prefix
-@code{ntpkey_}
-and end with the postfix
-@kbd{_hostname.filestamp},
-where
-@kbd{hostname}
-is the owner name, usually the string returned
-by the Unix gethostname() routine, and
-@kbd{filestamp}
-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{ntpkey*}
-command or all files generated
-at a specific time can be removed by a
-@code{rm}
-@kbd{*filestamp}
-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.
-
-All files are installed by default in the keys directory
-@file{/usr/local/etc},
-which is normally in a shared filesystem
-in NFS-mounted networks.
-The actual location of the keys directory
-and each file can be overridden by configuration commands,
-but this is not recommended.
-Normally, the files for each host are generated by that host
-and used only by that host, although exceptions exist
-as noted later on this page.
-
-Normally, files containing private values,
-including the host key, sign key and identification parameters,
-are permitted root read/write-only;
-while others containing public values are permitted world readable.
-Alternatively, files containing private values can be encrypted
-and these files permitted world readable,
-which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
-dependent clients can all be installed in the same shared directory.
-
-The recommended practice is to keep the file name extensions
-when installing a file and to install a soft link
-from the generic names specified elsewhere on this page
-to the generated files.
-This allows new file generations to be activated simply
-by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
-If a link is not present,
-@code{ntpd(1ntpdmdoc)}
-extracts the filestamp from the file itself.
-This allows clients to verify that the file and generation times
-are always current.
-The
-@code{ntp-keygen}
-program uses the same timestamp extension for all files generated
-at one time, so each generation is distinct and can be readily
-recognized in monitoring data.
-@subsubsection Running the program
+@subsubsection Running the Program
The safest way to run the
@code{ntp-keygen}
program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
+The recommended procedure is change to the
+@kbd{keys}
+directory, usually
@file{/usr/local/etc},
then run the program.
-When run for the first time,
-or if all
-@code{ntpkey}
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
+
+To test and gain experience with Autokey concepts, log in as root and
+change to the
+@kbd{keys}
+directory, usually
+@file{/usr/local/etc}.
+When run for the first time, or if all files with names beginning with
+@file{ntpkey*}
+have been removed, use the
+@code{ntp-keygen}
+command without arguments to generate a default
+@code{RSA}
+host key and matching
+@code{RSA-MD5}
+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
to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+If run again without options, the program uses the
+existing keys and parameters and generates a new certificate file with
+new expiration date one year hence, and soft link.
-The host key is used to encrypt the cookie when required and so must be RSA type.
+The host key is used to encrypt the cookie when required and so must be
+@code{RSA}
+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 RSA or DSA type.
-By default, the message digest type is MD5, but any combination
+either
+@code{RSA}
+or
+@code{DSA}
+type.
+By default, the message digest type is
+@code{MD5},
+but any combination
of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+can be specified, including those using the
+@code{AES128CMAC}, @code{MD2}, @code{MD5}, @code{MDC2}, @code{SHA}, @code{SHA1}
+and
+@code{RIPE160}
+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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Certificates using any digest algorithm are compatible with
+@code{RSA}
+sign keys;
+however, only
+@code{SHA}
+and
+@code{SHA1}
+certificates are compatible with
+@code{DSA}
+sign keys.
Private/public key files and certificates are compatible with
other OpenSSL applications and very likely other libraries as well.
as the other files, are probably not compatible with anything other than Autokey.
Running the program as other than root and using the Unix
-@code{su}
+@code{su(1)}
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-@code{.rnd}
+@file{.rnd}
in the user home directory.
However, there should be only one
-@code{.rnd},
+@file{.rnd},
most conveniently
in the root directory, so it is convenient to define the
-@code{$RANDFILE}
+.Ev RANDFILE
environment variable used by the OpenSSL library as the path to
-@code{/.rnd}.
+@file{.rnd}.
Installing the keys as root might not work in NFS-mounted
shared file systems, as NFS clients may not be able to write
@file{/etc}
using the
@code{keysdir}
-command.
+@code{ntpd(1ntpdmdoc)}
+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
by the Autokey protocol.
The owner name is also used for the host and sign key files,
while the trusted name is used for the identity files.
-
All files are installed by default in the keys directory
@file{/usr/local/etc},
which is normally in a shared filesystem
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
+Since uniqueness is insured by the
+@kbd{hostname}
+and
+@kbd{filestamp}
+file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
The recommended practice is to keep the file name extensions
to the generated files.
This allows new file generations to be activated simply
by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+If a link is present,
+@code{ntpd(1ntpdmdoc)}
+follows it to the file name to extract the
+@kbd{filestamp}.
If a link is not present,
@code{ntpd(1ntpdmdoc)}
-extracts the filestamp from the file itself.
+extracts the
+@kbd{filestamp}
+from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
@code{ntp-keygen}
-program uses the same timestamp extension for all files generated
+program uses the same
+@kbd{filestamp}
+extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-@subsubsection Running the program
-The safest way to run the
+
+Run the command on as many hosts as necessary.
+Designate one of them as the trusted host (TH) using
@code{ntp-keygen}
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-@file{/usr/local/etc},
-then run the program.
-When run for the first time,
-or if all
-@code{ntpkey}
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
-which is all that is necessary in many cases.
-The program also generates soft links from the generic names
-to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+with the
+@code{-T}
+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
+ascendant host towards the TH to sign its certificate, which is then
+provided to the immediately descendant host on request.
+All group hosts should have acyclic certificate trails ending on the TH.
-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.
-When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
-By default, the message digest type is MD5, but any combination
-of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+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}
+option and this can be either
+@code{RSA}
+or
+@code{DSA}
+type.
+By default, the signature
+message digest type is
+@code{MD5},
+but any combination of sign key type and
+message digest type supported by the OpenSSL library can be specified
+using the
+@code{-c}
+option.
-Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
-Certificates or certificate requests derived from them should be compatible
-with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
-However, the identification parameter files, although encoded
-as the other files, are probably not compatible with anything other than Autokey.
+The rules say cryptographic media should be generated with proventic
+filestamps, which means the host should already be synchronized before
+this program is run.
+This of course creates a chicken-and-egg problem
+when the host is started for the first time.
+Accordingly, the host time
+should be set by some other means, such as eyeball-and-wristwatch, at
+least so that the certificate lifetime is within the current year.
+After that and when the host is synchronized to a proventic source, the
+certificate should be re-generated.
-Running the program as other than root and using the Unix
-@code{su}
-command
-to assume root may not work properly, since by default the OpenSSL library
-looks for the random seed file
-@code{.rnd}
-in the user home directory.
-However, there should be only one
-@code{.rnd},
-most conveniently
-in the root directory, so it is convenient to define the
-@code{$RANDFILE}
-environment variable used by the OpenSSL library as the path to
-@code{/.rnd}.
+Additional information on trusted groups and identity schemes is on the
+@quotedblleft{}Autokey Public-Key Authentication@quotedblright{}
+page.
-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
-@file{/etc}
-using the
-@code{keysdir}
+File names begin with the prefix
+@file{ntpkey}_
+and end with the suffix
+@file{_}@kbd{hostname}. @kbd{filestamp},
+where
+@kbd{hostname}
+is the owner name, usually the string returned
+by the Unix
+@code{hostname(1)}
+command, and
+@kbd{filestamp}
+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} @file{ntpkey*}
+command or all files generated
+at a specific time can be removed by a
+@code{rm} @file{*}@kbd{filestamp}
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
-by the Autokey protocol.
-
-Ordinarily, cryptographic files are generated by the host that uses them,
-but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
-The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
-It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
-The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
-seconds.
-seconds.
+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.
-s Trusted Hosts and Groups
+@subsubsection Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
@ref{Authentication Options}
section of
@code{ntp.conf(5)}.
-The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+The default cryptotype uses
+@code{RSA}
+encryption,
+@code{MD5}
+message digest
+and
+@code{TC}
+identification.
First, configure a NTP subnet including one or more low-stratum
trusted hosts from which all other hosts derive synchronization
directly or indirectly.
On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-@code{ntpkey}
+@file{ntpkey}
files.
Then run
@code{ntp-keygen}
@code{RSA}
or
@code{DSA}.
-The most often need to do this is when a DSA-signed certificate is used.
+The most frequent need to do this is when a
+@code{DSA}-signed
+certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
@code{ntp-keygen}
option and selected
@kbd{scheme}
as needed.
-f
+If
@code{ntp-keygen}
is run again without these options, it generates a new certificate
-using the same scheme and sign key.
+using the same scheme and sign key, and soft link.
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}
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys, and soft links.
However, if the host or sign key is changed,
@code{ntpd(1ntpdmdoc)}
should be restarted.
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.
+
@subsubsection Identity Schemes
As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default
+@code{TC}
+identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
-including PC, IFF, GQ and MV described on the
-"Identification Schemes"
-page
-(maybe available at
-@code{http://www.eecis.udel.edu/%7emills/keygen.html}).
+including
+@code{PC}, @code{IFF}, @code{GQ}
+and
+@code{MV}
+schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
@code{-P}
@code{-p} @kbd{password}
to generate the host key file
-@file{ntpkey_RSAkey_}@kbd{alice.filestamp}
+@file{ntpkey}_ @code{RSA} @file{key_alice.} @kbd{filestamp}
and trusted private certificate file
-@file{ntpkey_RSA-MD5_cert_}@kbd{alice.filestamp}.
+@file{ntpkey}_ @code{RSA-MD5} @code{_} @file{cert_alice.} @kbd{filestamp},
+and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
-On each host bob install a soft link from the generic name
+On each host
+@kbd{bob}
+install a soft link from the generic name
@file{ntpkey_host_}@kbd{bob}
to the host key file and soft link
@file{ntpkey_cert_}@kbd{bob}
by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
-to all other hosts in the group.
+to all other hosts in the group, and recreating the soft links.
-For the IFF scheme proceed as in the TC scheme to generate keys
+For the
+@code{IFF}
+scheme proceed as in the
+@code{TC}
+scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the
+@code{IFF}
+parameter file.
On trusted host alice run
@code{ntp-keygen}
@code{-T}
@code{-I}
@code{-p} @kbd{password}
to produce her parameter file
-@file{ntpkey_IFFpar_}@kbd{alice.filestamp},
+@file{ntpkey_IFFpar_alice.}@kbd{filestamp},
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
-@file{ntpkey_iff_}@kbd{alice}
+@file{ntpkey_iff_alice}
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
-As the IFF scheme is independent
+As the
+@code{IFF}
+scheme is independent
of keys and certificates, these files can be refreshed as needed.
If a rogue client has the parameter file, it could masquerade
After generating the parameter file, on alice run
@code{ntp-keygen}
@code{-e}
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+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
-@file{ntpkey_iff_}@kbd{alice}
+@file{ntpkey_iff_alice}
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
-For the GQ scheme proceed as in the TC scheme to generate keys
+For the
+@code{GQ}
+scheme proceed as in the
+@code{TC}
+scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the
+@code{IFF}
+parameter file.
On trusted host alice run
@code{ntp-keygen}
@code{-T}
@code{-G}
@code{-p} @kbd{password}
to produce her parameter file
-@file{ntpkey_GQpar_}@kbd{alice.filestamp},
+@file{ntpkey_GQpar_alice.}@kbd{filestamp},
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-@file{ntpkey_gq_}@kbd{alice}
+@file{ntpkey_gq_alice}
to this file.
-In addition, on each host bob install a soft link
+In addition, on each host
+@kbd{bob}
+install a soft link
from generic
@file{ntpkey_gq_}@kbd{bob}
to this file.
-As the GQ scheme updates the GQ parameters file and certificate
+As the
+@code{GQ}
+scheme updates the
+@code{GQ}
+parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
-For the MV scheme, proceed as in the TC scheme to generate keys
+For the
+@code{MV}
+scheme, proceed as in the
+@code{TC}
+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.
@kbd{n}
is the number of revokable keys (typically 5) to produce
the parameter file
-@file{ntpkeys_MVpar_}@kbd{trish.filestamp}
+@file{ntpkeys_MVpar_trish.}@kbd{filestamp}
and client key files
-@file{ntpkeys_MVkeyd_}@kbd{trish.filestamp}
+@file{ntpkeys_MVkey}@kbd{d} @kbd{_} @file{trish.} @kbd{filestamp}
where
@kbd{d}
is the key number (0 <
@kbd{n}).
Copy the parameter file to alice and install a soft link
from the generic
-@file{ntpkey_mv_}@kbd{alice}
+@file{ntpkey_mv_alice}
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
-It doesn't matter which client key file goes to alice,
+It does not matter which client key file goes to alice,
since they all work the same way.
-Alice copies the client key file to all of her cliens.
+Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-@file{ntpkey_mvkey_}@kbd{bob}
+@file{ntpkey_mvkey_bob}
to the client key file.
-As the MV scheme is independent of keys and certificates,
+As the
+@code{MV}
+scheme is independent of keys and certificates,
these files can be refreshed as needed.
+
@subsubsection Command Line Options
@table @asis
-@item @code{-c} @kbd{scheme}
-Select certificate message digest/signature encryption scheme.
+@item @code{-b} @code{--imbits}= @kbd{modulus}
+Set the number of bits in the identity modulus for generating identity keys to
+@kbd{modulus}
+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.
+@item @code{-c} @code{--certificate}= @kbd{scheme}
+Select certificate signature encryption/message digest scheme.
The
@kbd{scheme}
can be one of the following:
-. Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA ,
+@code{RSA-MD2}, @code{RSA-MD5}, @code{RSA-MDC2}, @code{RSA-SHA}, @code{RSA-SHA1}, @code{RSA-RIPEMD160}, @code{DSA-SHA},
or
@code{DSA-SHA1}.
-Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+Note that
+@code{RSA}
+schemes must be used with an
+@code{RSA}
+sign key and
+@code{DSA}
+schemes must be used with a
+@code{DSA}
+sign key.
The default without this option is
@code{RSA-MD5}.
-@item @code{-d}
-Enable debugging.
+If compatibility with FIPS 140-2 is required, either the
+@code{DSA-SHA}
+or
+@code{DSA-SHA1}
+scheme must be used.
+@item @code{-C} @code{--cipher}= @kbd{cipher}
+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}.
+The
+@code{openssl} @code{-h}
+command provided with OpenSSL displays available ciphers.
+@item @code{-d} @code{--debug-level}
+Increase debugging verbosity level.
This option displays the cryptographic data produced in eye-friendly billboards.
-@item @code{-e}
-Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
-@item @code{-G}
-Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
-@item @code{-g}
-Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
-@item @code{-H}
-Generate new host keys, obsoleting any that may exist.
-@item @code{-I}
-Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
-@item @code{-i} @kbd{name}
-Set the suject name to
-@kbd{name}.
-This is used as the subject field in certificates
-and in the file name for host and sign keys.
-@item @code{-M}
-Generate MD5 keys, obsoleting any that may exist.
-@item @code{-P}
-Generate a private certificate.
+@item @code{-D} @code{--set-debug-level}= @kbd{level}
+Set the debugging verbosity to
+@kbd{level}.
+This option displays the cryptographic data produced in eye-friendly billboards.
+@item @code{-e} @code{--id-key}
+Write the
+@code{IFF}
+or
+@code{GQ}
+public parameters from the
+@kbd{IFFkey} @kbd{or} @kbd{GQkey}
+client keys file previously specified
+as unencrypted data to the standard output stream
+@file{stdout}.
+This is intended for automatic key distribution by email.
+@item @code{-G} @code{--gq-params}
+Generate a new encrypted
+@code{GQ}
+parameters and key file for the Guillou-Quisquater (GQ) identity scheme.
+This option is mutually exclusive with the
+@code{-I}
+and
+@code{-V}
+options.
+@item @code{-H} @code{--host-key}
+Generate a new encrypted
+@code{RSA}
+public/private host key file.
+@item @code{-I} @code{--iffkey}
+Generate a new encrypted
+@code{IFF}
+key file for the Schnorr (IFF) identity scheme.
+This option is mutually exclusive with the
+@code{-G}
+and
+Fl V
+options.
+@item @code{-i} @code{--ident}= @kbd{group}
+Set the optional Autokey group name to
+@kbd{group}.
+This is used in the identity scheme parameter file names of
+@code{IFF}, @code{GQ},
+and
+@code{MV}
+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}
+or
+@code{-s}
+following an
+@quoteleft{}@@@quoteright{}
+character, is also used in certificate subject and issuer names in the form
+@kbd{host} @kbd{@@} @kbd{group}
+and should match the group specified via
+@code{crypto} @code{ident}
+or
+@code{server} @code{ident}
+in the ntpd configuration file.
+@item @code{-l} @code{--lifetime}= @kbd{days}
+Set the lifetime for certificate expiration to
+@kbd{days}.
+The default lifetime is one year (365 days).
+@item @code{-m} @code{--modulus}= @kbd{bits}
+Set the number of bits in the prime modulus for generating files to
+@kbd{bits}.
+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.
+@item @code{-M} @code{--md5key}
+Generate a new symmetric keys file containing 10
+@code{MD5}
+keys, and if OpenSSL is available, 10
+@code{SHA}
+keys.
+An
+@code{MD5}
+key is a string of 20 random printable ASCII characters, while a
+@code{SHA}
+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.
+@item @code{-p} @code{--password}= @kbd{passwd}
+Set the password for reading and writing encrypted files to
+@kbd{passwd}.
+These include the host, sign and identify key files.
+By default, the password is the string returned by the Unix
+@code{hostname}
+command.
+@item @code{-P} @code{--pvt-cert}
+Generate a new private certificate used by the
+@code{PC}
+identity scheme.
By default, the program generates public certificates.
-@item @code{-p} @kbd{password}
-Encrypt generated files containing private data with
-@kbd{password}
-and the DES-CBC algorithm.
-@item @code{-q}
-Set the password for reading files to password.
-@item @code{-S} @code{[@code{RSA} | @code{DSA}]}
-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.
-@item @code{-s} @kbd{name}
-Set the issuer name to
-@kbd{name}.
-This is used for the issuer field in certificates
-and in the file name for identity files.
-@item @code{-T}
+Note: the PC identity scheme is not recommended for new installations.
+@item @code{-q} @code{--export-passwd}= @kbd{passwd}
+Set the password for writing encrypted
+@code{IFF}, @code{GQ} @code{and} @code{MV}
+identity files redirected to
+@file{stdout}
+to
+@kbd{passwd}.
+In effect, these files are decrypted with the
+@code{-p}
+password, then encrypted with the
+@code{-q}
+password.
+By default, the password is the string returned by the Unix
+@code{hostname}
+command.
+@item @code{-s} @code{--subject-key}= @code{[host]} @code{[@@ @kbd{group}]}
+Specify the Autokey host name, where
+@kbd{host}
+is the optional host name and
+@kbd{group}
+is the optional group name.
+The host name, and if provided, group name are used in
+@kbd{host} @kbd{@@} @kbd{group}
+form as certificate subject and issuer.
+Specifying
+@code{-s} @code{-@@} @kbd{group}
+is allowed, and results in leaving the host name unchanged, as with
+@code{-i} @kbd{group}.
+The group name, or if no group is provided, the host name are also used in the
+file names of
+@code{IFF}, @code{GQ},
+and
+@code{MV}
+identity scheme client parameter files.
+If
+@kbd{host}
+is not specified, the default host name is the string returned by the Unix
+@code{hostname}
+command.
+@item @code{-S} @code{--sign-key}= @code{[@code{RSA} | @code{DSA}]}
+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}.
+@item @code{-T} @code{--trusted-cert}
Generate a trusted certificate.
By default, the program generates a non-trusted certificate.
-@item @code{-V} @kbd{nkeys}
-Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme.
+@item @code{-V} @code{--mv-params} @kbd{nkeys}
+Generate
+@kbd{nkeys}
+encrypted server keys and parameters for the Mu-Varadharajan (MV)
+identity scheme.
+This option is mutually exclusive with the
+@code{-I}
+and
+@code{-G}
+options.
+Note: support for this option should be considered a work in progress.
@end table
+
@subsubsection Random Seed File
All cryptographically sound key generation schemes must have means
to randomize the entropy seed used to initialize
The entropy seed used by the OpenSSL library is contained in a file,
usually called
-@code{.rnd},
+@file{.rnd},
which must be available when starting the NTP daemon
or the
@code{ntp-keygen}
.Ev RANDFILE
environment variable is not present,
the library will look for the
-@code{.rnd}
+@file{.rnd}
file in the user home directory.
+Since both the
+@code{ntp-keygen}
+program and
+@code{ntpd(1ntpdmdoc)}
+daemon must run as root, the logical place to put this file is in
+@file{/.rnd}
+or
+@file{/root/.rnd}.
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.
+
@subsubsection Cryptographic Data Files
-All other file formats begin with two lines.
-The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
-Lines beginning with # are considered comments and ignored by the
+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
+@file{ntpkey_}@kbd{key} @kbd{_} @kbd{name}. @kbd{filestamp},
+where
+@kbd{key}
+is the key or parameter type,
+@kbd{name}
+is the host or group name and
+@kbd{filestamp}
+is the filestamp (NTP seconds) when the file was created.
+By convention,
+@kbd{key}
+names in generated file names include both upper and lower case
+characters, while
+@kbd{key}
+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
+@file{date}
+format.
+Lines beginning with
+@quoteleft{}#@quoteright{}
+are considered comments and ignored by the
@code{ntp-keygen}
program and
@code{ntpd(1ntpdmdoc)}
daemon.
-Cryptographic values are encoded first using ASN.1 rules,
-then encrypted if necessary, and finally written PEM-encoded
-printable ASCII format preceded and followed by MIME content identifier lines.
-
-The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
-Since DES-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
-Following hte heard the keys are
-entered one per line in the format
+
+The remainder of the file contains cryptographic data, encoded first using ASN.1
+rules, then encrypted if necessary, and finally written in PEM-encoded
+printable ASCII text, preceded and followed by MIME content identifier lines.
+
+The format of the symmetric keys file, ordinarily named
+@file{ntp.keys},
+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.
+@verbatim
+# ntpkey_MD5key_bk.ntp.org.3595864945
+# Thu Dec 12 19:22:25 2013
+
+1 MD5 L";Nw<\`.I<f4U0)247"i # MD5 key
+2 MD5 &>l0%XXK9O'51VwV<xq~ # MD5 key
+3 MD5 lb4zLW~d^!K:]RsD'qb6 # MD5 key
+4 MD5 Yue:tL[+vR)M\`n~bY,'? # MD5 key
+5 MD5 B;fx'Kgr/&4ZTbL6=RxA # MD5 key
+6 MD5 4eYwa\`o@}3i@@@@V@@..R9!l # MD5 key
+7 MD5 \`A.([h+;wTQ|xfi%Sn_! # MD5 key
+8 MD5 45:V,r4]l6y^JH6"Sh?F # MD5 key
+9 MD5 3-5vcn*6l29DS?Xdsg)* # MD5 key
+10 MD5 2late4Me # MD5 key
+11 SHA1 a27872d3030a9025b8446c751b4551a7629af65c # SHA1 key
+12 SHA1 21bc3b4865dbb9e920902abdccb3e04ff97a5e74 # SHA1 key
+13 SHA1 2b7736fe24fef5ba85ae11594132ab5d6f6daba9 # SHA1 key
+14 SHA a5332809c8878dd3a5b918819108a111509aeceb # SHA key
+15 MD2 2fe16c88c760ff2f16d4267e36c1aa6c926e6964 # MD2 key
+16 MD4 b2691811dc19cfc0e2f9bcacd74213f29812183d # MD4 key
+17 MD5 e4d6735b8bdad58ec5ffcb087300a17f7fef1f7c # MD5 key
+18 MDC2 a8d5e2315c025bf3a79174c87fbd10477de2eabc # MDC2 key
+19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
+20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
+@end verbatim
+@example
+Figure 1. Typical Symmetric Key File
+@end example
+
+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
@example
@kbd{keyno} @kbd{type} @kbd{key}
@end example
where
@kbd{keyno}
-is a positive integer in the range 1-65,535,
+is a positive integer in the range 1-65534;
@kbd{type}
-is the string MD5 defining the key format and
+is the key type for the message digest algorithm, which in the absence of the
+OpenSSL library must be
+@code{MD5}
+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}
+or
+@code{SHA1};
@kbd{key}
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
-Each character is chosen from the 93 printable characters
-in the range 0x21 through 0x7f excluding space and the
+which is a printable ASCII string 20 characters or less in length:
+each character is chosen from the 93 printable characters
+in the range 0x21 through 0x7e (
+@quoteleft{}@quoteright{}!
+through
+@quoteleft{}~@quoteright{}
+) excluding space and the
+@quoteleft{}#@quoteright{}
+character, and terminated by whitespace or a
@quoteleft{}#@quoteright{}
character.
+An OpenSSL key consists of a hex-encoded ASCII string of 40 characters, which
+is truncated as necessary.
Note that the keys used by the
@code{ntpq(1ntpqmdoc)}
The
@code{ntp-keygen}
-program generates a MD5 symmetric keys file
-@file{ntpkey_MD5key_}@kbd{hostname.filestamp}.
+program generates a symmetric keys file
+@file{ntpkey_MD5key_}@kbd{hostname}. @kbd{filestamp}.
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
* ntp-keygen iffkey:: iffkey option (-I)
* ntp-keygen ident:: ident option (-i)
* ntp-keygen lifetime:: lifetime option (-l)
-* ntp-keygen md5key:: md5key option (-M)
* ntp-keygen modulus:: modulus option (-m)
+* ntp-keygen md5key:: md5key option (-M)
* ntp-keygen pvt-cert:: pvt-cert option (-P)
* ntp-keygen password:: password option (-p)
* ntp-keygen export-passwd:: export-passwd option (-q)
-* ntp-keygen sign-key:: sign-key option (-S)
* ntp-keygen subject-name:: subject-name option (-s)
+* ntp-keygen sign-key:: sign-key option (-S)
* ntp-keygen trusted-cert:: trusted-cert option (-T)
* ntp-keygen mv-params:: mv-params option (-V)
* ntp-keygen mv-keys:: mv-keys option (-v)
-I no iffkey generate IFF parameters
-i Str ident set Autokey group name
-l Num lifetime set certificate lifetime
- -M no md5key generate MD5 keys
- -m Num modulus modulus
+ -m Num modulus prime modulus
- it must be in the range:
256 to 2048
+ -M no md5key generate symmetric keys
-P no pvt-cert generate PC private certificate
-p Str password local private password
-q Str export-passwd export IFF or GQ group keys with password
- -S Str sign-key generate sign key (RSA or DSA)
-s Str subject-name set host and optionally group name
+ -S Str sign-key generate sign key (RSA or DSA)
-T no trusted-cert trusted certificate (TC scheme)
-V Num mv-params generate <num> MV parameters
-v Num mv-keys update <num> MV keys
@end itemize
scheme is one of
-RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160,
+RSA-MD2, RSA-MD5, RSA-MDC2, RSA-SHA, RSA-SHA1, RSA-RIPEMD160,
DSA-SHA, or DSA-SHA1.
-Select the certificate message digest/signature encryption scheme.
+Select the certificate signature encryption/message digest scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
this option is RSA-MD5.
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". The openssl tool lists ciphers
+equivalent to "@code{-C des-ede3-cbc}". The openssl tool lists ciphers
available in "@code{openssl -h}" output.
@node ntp-keygen id-key
@subsection id-key option (-e)
must be compiled in by defining @code{AUTOKEY} during the compilation.
@end itemize
-Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
+Write the public parameters from the IFF or GQ client keys to
+the standard output.
+This is intended for automatic key distribution by email.
@node ntp-keygen gq-params
@subsection gq-params option (-G)
@cindex ntp-keygen-gq-params
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} or
-using @code{-s/--subject-name} following an '@code{@}' character,
-is also a part of the self-signed host certificate's subject and
-issuer names in the form @code{host@group} and should match the
-'@code{crypto ident}' or '@code{server ident}' configuration in
-@code{ntpd}'s configuration file.
+using @code{-s/--subject-name} following an '@code{@@}' character,
+is also a part of the self-signed host certificate subject and
+issuer names in the form @code{host@@group} and should match the
+'@code{crypto ident}' or '@code{server ident}' configuration in the
+@code{ntpd} configuration file.
@node ntp-keygen lifetime
@subsection lifetime option (-l)
@cindex ntp-keygen-lifetime
@end itemize
Set the certificate expiration to lifetime days from now.
-@node ntp-keygen md5key
-@subsection md5key option (-M)
-@cindex ntp-keygen-md5key
-
-This is the ``generate md5 keys'' option.
-Generate MD5 keys, obsoleting any that may exist.
@node ntp-keygen modulus
@subsection modulus option (-m)
@cindex ntp-keygen-modulus
-This is the ``modulus'' option.
+This is the ``prime modulus'' option.
This option takes a number argument @file{modulus}.
@noindent
@end itemize
The number of bits in the prime modulus. The default is 512.
+@node ntp-keygen md5key
+@subsection md5key option (-M)
+@cindex ntp-keygen-md5key
+
+This is the ``generate symmetric keys'' option.
+Generate symmetric keys, obsoleting any that may exist.
@node ntp-keygen pvt-cert
@subsection pvt-cert option (-P)
@cindex ntp-keygen-pvt-cert
The same password must be specified to the remote ntpd via the
"crypto pw password" configuration command. See also the option
--id-key (-e) for unencrypted exports.
-@node ntp-keygen sign-key
-@subsection sign-key option (-S)
-@cindex ntp-keygen-sign-key
-
-This is the ``generate sign key (rsa or dsa)'' option.
-This option takes a string argument @file{sign}.
-
-@noindent
-This option has some usage constraints. It:
-@itemize @bullet
-@item
-must be compiled in by defining @code{AUTOKEY} during the compilation.
-@end itemize
-
-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.
@node ntp-keygen subject-name
@subsection subject-name option (-s)
@cindex ntp-keygen-subject-name
@end itemize
Set the Autokey host name, and optionally, group name specified
-following an '@code{@}' character. The host name is used in the file
+following an '@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} form for the host certificate's subject and issuer
-fields. Specifying '@code{-s @group}' is allowed, and results in
-leaving the host name unchanged while appending @code{@group} to the
+in @code{host@@group} form for the host certificate subject and issuer
+fields. Specifying '@code{-s @@group}' is allowed, and results in
+leaving the host name unchanged while appending @code{@@group} to the
subject and issuer fields, as with @code{-i group}. 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.
+@node ntp-keygen sign-key
+@subsection sign-key option (-S)
+@cindex ntp-keygen-sign-key
+
+This is the ``generate sign key (rsa or dsa)'' option.
+This option takes a string argument @file{sign}.
+
+@noindent
+This option has some usage constraints. It:
+@itemize @bullet
+@item
+must be compiled in by defining @code{AUTOKEY} during the compilation.
+@end itemize
+
+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.
@node ntp-keygen trusted-cert
@subsection trusted-cert option (-T)
@cindex ntp-keygen-trusted-cert
/*
* EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.c)
*
- * It has been AutoGen-ed January 2, 2017 at 12:05:31 PM by AutoGen 5.18.5
+ * It has been AutoGen-ed March 19, 2017 at 10:10:36 AM by AutoGen 5.18.5
* From the definitions ntp-keygen-opts.def
* and the template file options
*
/**
* static const strings for ntp-keygen options
*/
-static char const ntp_keygen_opt_strs[2419] =
+static char const ntp_keygen_opt_strs[2439] =
/* 0 */ "ntp-keygen (ntp) 4.2.8p9\n"
"Copyright (C) 1992-2017 The University of Delaware and Network Time Foundation, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
/* 1457 */ "set certificate lifetime\0"
/* 1482 */ "LIFETIME\0"
/* 1491 */ "lifetime\0"
-/* 1500 */ "generate MD5 keys\0"
-/* 1518 */ "MD5KEY\0"
-/* 1525 */ "md5key\0"
-/* 1532 */ "modulus\0"
-/* 1540 */ "MODULUS\0"
-/* 1548 */ "generate PC private certificate\0"
-/* 1580 */ "PVT_CERT\0"
-/* 1589 */ "pvt-cert\0"
-/* 1598 */ "local private password\0"
-/* 1621 */ "PASSWORD\0"
-/* 1630 */ "password\0"
-/* 1639 */ "export IFF or GQ group keys with password\0"
-/* 1681 */ "EXPORT_PASSWD\0"
-/* 1695 */ "export-passwd\0"
-/* 1709 */ "generate sign key (RSA or DSA)\0"
-/* 1740 */ "SIGN_KEY\0"
-/* 1749 */ "sign-key\0"
-/* 1758 */ "set host and optionally group name\0"
-/* 1793 */ "SUBJECT_NAME\0"
-/* 1806 */ "subject-name\0"
-/* 1819 */ "trusted certificate (TC scheme)\0"
-/* 1851 */ "TRUSTED_CERT\0"
-/* 1864 */ "trusted-cert\0"
-/* 1877 */ "generate <num> MV parameters\0"
-/* 1906 */ "MV_PARAMS\0"
-/* 1916 */ "mv-params\0"
-/* 1926 */ "update <num> MV keys\0"
-/* 1947 */ "MV_KEYS\0"
-/* 1955 */ "mv-keys\0"
-/* 1963 */ "display extended usage information and exit\0"
-/* 2007 */ "help\0"
-/* 2012 */ "extended usage information passed thru pager\0"
-/* 2057 */ "more-help\0"
-/* 2067 */ "output version information and exit\0"
-/* 2103 */ "version\0"
-/* 2111 */ "save the option state to a config file\0"
-/* 2150 */ "save-opts\0"
-/* 2160 */ "load options from a config file\0"
-/* 2192 */ "LOAD_OPTS\0"
-/* 2202 */ "no-load-opts\0"
-/* 2215 */ "no\0"
-/* 2218 */ "NTP_KEYGEN\0"
-/* 2229 */ "ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p9\n"
+/* 1500 */ "prime modulus\0"
+/* 1514 */ "MODULUS\0"
+/* 1522 */ "modulus\0"
+/* 1530 */ "generate symmetric keys\0"
+/* 1554 */ "MD5KEY\0"
+/* 1561 */ "md5key\0"
+/* 1568 */ "generate PC private certificate\0"
+/* 1600 */ "PVT_CERT\0"
+/* 1609 */ "pvt-cert\0"
+/* 1618 */ "local private password\0"
+/* 1641 */ "PASSWORD\0"
+/* 1650 */ "password\0"
+/* 1659 */ "export IFF or GQ group keys with password\0"
+/* 1701 */ "EXPORT_PASSWD\0"
+/* 1715 */ "export-passwd\0"
+/* 1729 */ "set host and optionally group name\0"
+/* 1764 */ "SUBJECT_NAME\0"
+/* 1777 */ "subject-name\0"
+/* 1790 */ "generate sign key (RSA or DSA)\0"
+/* 1821 */ "SIGN_KEY\0"
+/* 1830 */ "sign-key\0"
+/* 1839 */ "trusted certificate (TC scheme)\0"
+/* 1871 */ "TRUSTED_CERT\0"
+/* 1884 */ "trusted-cert\0"
+/* 1897 */ "generate <num> MV parameters\0"
+/* 1926 */ "MV_PARAMS\0"
+/* 1936 */ "mv-params\0"
+/* 1946 */ "update <num> MV keys\0"
+/* 1967 */ "MV_KEYS\0"
+/* 1975 */ "mv-keys\0"
+/* 1983 */ "display extended usage information and exit\0"
+/* 2027 */ "help\0"
+/* 2032 */ "extended usage information passed thru pager\0"
+/* 2077 */ "more-help\0"
+/* 2087 */ "output version information and exit\0"
+/* 2123 */ "version\0"
+/* 2131 */ "save the option state to a config file\0"
+/* 2170 */ "save-opts\0"
+/* 2180 */ "load options from a config file\0"
+/* 2212 */ "LOAD_OPTS\0"
+/* 2222 */ "no-load-opts\0"
+/* 2235 */ "no\0"
+/* 2238 */ "NTP_KEYGEN\0"
+/* 2249 */ "ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p9\n"
"Usage: %s [ -<flag> [<val>] | --<name>[{=| }<val>] ]...\n\0"
-/* 2343 */ "$HOME\0"
-/* 2349 */ ".\0"
-/* 2351 */ ".ntprc\0"
-/* 2358 */ "http://bugs.ntp.org, bugs@ntp.org\0"
-/* 2392 */ "\n\0"
-/* 2394 */ "ntp-keygen (ntp) 4.2.8p9";
+/* 2363 */ "$HOME\0"
+/* 2369 */ ".\0"
+/* 2371 */ ".ntprc\0"
+/* 2378 */ "http://bugs.ntp.org, bugs@ntp.org\0"
+/* 2412 */ "\n\0"
+/* 2414 */ "ntp-keygen (ntp) 4.2.8p9";
/**
* imbits option description:
#define LIFETIME_name NULL
#endif /* AUTOKEY */
-/**
- * md5key option description:
- */
-/** Descriptive text for the md5key option */
-#define MD5KEY_DESC (ntp_keygen_opt_strs+1500)
-/** Upper-cased name for the md5key option */
-#define MD5KEY_NAME (ntp_keygen_opt_strs+1518)
-/** Name string for the md5key option */
-#define MD5KEY_name (ntp_keygen_opt_strs+1525)
-/** Compiled in flag settings for the md5key option */
-#define MD5KEY_FLAGS (OPTST_DISABLED)
-
/**
* modulus option description:
*/
#ifdef AUTOKEY
/** Descriptive text for the modulus option */
-#define MODULUS_DESC (ntp_keygen_opt_strs+1532)
+#define MODULUS_DESC (ntp_keygen_opt_strs+1500)
/** Upper-cased name for the modulus option */
-#define MODULUS_NAME (ntp_keygen_opt_strs+1540)
+#define MODULUS_NAME (ntp_keygen_opt_strs+1514)
/** Name string for the modulus option */
-#define MODULUS_name (ntp_keygen_opt_strs+1532)
+#define MODULUS_name (ntp_keygen_opt_strs+1522)
/** Compiled in flag settings for the modulus option */
#define MODULUS_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_NUMERIC))
#define MODULUS_name NULL
#endif /* AUTOKEY */
+/**
+ * md5key option description:
+ */
+/** Descriptive text for the md5key option */
+#define MD5KEY_DESC (ntp_keygen_opt_strs+1530)
+/** Upper-cased name for the md5key option */
+#define MD5KEY_NAME (ntp_keygen_opt_strs+1554)
+/** Name string for the md5key option */
+#define MD5KEY_name (ntp_keygen_opt_strs+1561)
+/** Compiled in flag settings for the md5key option */
+#define MD5KEY_FLAGS (OPTST_DISABLED)
+
/**
* pvt-cert option description:
*/
#ifdef AUTOKEY
/** Descriptive text for the pvt-cert option */
-#define PVT_CERT_DESC (ntp_keygen_opt_strs+1548)
+#define PVT_CERT_DESC (ntp_keygen_opt_strs+1568)
/** Upper-cased name for the pvt-cert option */
-#define PVT_CERT_NAME (ntp_keygen_opt_strs+1580)
+#define PVT_CERT_NAME (ntp_keygen_opt_strs+1600)
/** Name string for the pvt-cert option */
-#define PVT_CERT_name (ntp_keygen_opt_strs+1589)
+#define PVT_CERT_name (ntp_keygen_opt_strs+1609)
/** Compiled in flag settings for the pvt-cert option */
#define PVT_CERT_FLAGS (OPTST_DISABLED)
*/
#ifdef AUTOKEY
/** Descriptive text for the password option */
-#define PASSWORD_DESC (ntp_keygen_opt_strs+1598)
+#define PASSWORD_DESC (ntp_keygen_opt_strs+1618)
/** Upper-cased name for the password option */
-#define PASSWORD_NAME (ntp_keygen_opt_strs+1621)
+#define PASSWORD_NAME (ntp_keygen_opt_strs+1641)
/** Name string for the password option */
-#define PASSWORD_name (ntp_keygen_opt_strs+1630)
+#define PASSWORD_name (ntp_keygen_opt_strs+1650)
/** Compiled in flag settings for the password option */
#define PASSWORD_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
*/
#ifdef AUTOKEY
/** Descriptive text for the export-passwd option */
-#define EXPORT_PASSWD_DESC (ntp_keygen_opt_strs+1639)
+#define EXPORT_PASSWD_DESC (ntp_keygen_opt_strs+1659)
/** Upper-cased name for the export-passwd option */
-#define EXPORT_PASSWD_NAME (ntp_keygen_opt_strs+1681)
+#define EXPORT_PASSWD_NAME (ntp_keygen_opt_strs+1701)
/** Name string for the export-passwd option */
-#define EXPORT_PASSWD_name (ntp_keygen_opt_strs+1695)
+#define EXPORT_PASSWD_name (ntp_keygen_opt_strs+1715)
/** Compiled in flag settings for the export-passwd option */
#define EXPORT_PASSWD_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
#define EXPORT_PASSWD_name NULL
#endif /* AUTOKEY */
-/**
- * sign-key option description:
- */
-#ifdef AUTOKEY
-/** Descriptive text for the sign-key option */
-#define SIGN_KEY_DESC (ntp_keygen_opt_strs+1709)
-/** Upper-cased name for the sign-key option */
-#define SIGN_KEY_NAME (ntp_keygen_opt_strs+1740)
-/** Name string for the sign-key option */
-#define SIGN_KEY_name (ntp_keygen_opt_strs+1749)
-/** Compiled in flag settings for the sign-key option */
-#define SIGN_KEY_FLAGS (OPTST_DISABLED \
- | OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
-
-#else /* disable sign-key */
-#define SIGN_KEY_FLAGS (OPTST_OMITTED | OPTST_NO_INIT)
-#define SIGN_KEY_NAME NULL
-#define SIGN_KEY_DESC NULL
-#define SIGN_KEY_name NULL
-#endif /* AUTOKEY */
-
/**
* subject-name option description:
*/
#ifdef AUTOKEY
/** Descriptive text for the subject-name option */
-#define SUBJECT_NAME_DESC (ntp_keygen_opt_strs+1758)
+#define SUBJECT_NAME_DESC (ntp_keygen_opt_strs+1729)
/** Upper-cased name for the subject-name option */
-#define SUBJECT_NAME_NAME (ntp_keygen_opt_strs+1793)
+#define SUBJECT_NAME_NAME (ntp_keygen_opt_strs+1764)
/** Name string for the subject-name option */
-#define SUBJECT_NAME_name (ntp_keygen_opt_strs+1806)
+#define SUBJECT_NAME_name (ntp_keygen_opt_strs+1777)
/** Compiled in flag settings for the subject-name option */
#define SUBJECT_NAME_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
#define SUBJECT_NAME_name NULL
#endif /* AUTOKEY */
+/**
+ * sign-key option description:
+ */
+#ifdef AUTOKEY
+/** Descriptive text for the sign-key option */
+#define SIGN_KEY_DESC (ntp_keygen_opt_strs+1790)
+/** Upper-cased name for the sign-key option */
+#define SIGN_KEY_NAME (ntp_keygen_opt_strs+1821)
+/** Name string for the sign-key option */
+#define SIGN_KEY_name (ntp_keygen_opt_strs+1830)
+/** Compiled in flag settings for the sign-key option */
+#define SIGN_KEY_FLAGS (OPTST_DISABLED \
+ | OPTST_SET_ARGTYPE(OPARG_TYPE_STRING))
+
+#else /* disable sign-key */
+#define SIGN_KEY_FLAGS (OPTST_OMITTED | OPTST_NO_INIT)
+#define SIGN_KEY_NAME NULL
+#define SIGN_KEY_DESC NULL
+#define SIGN_KEY_name NULL
+#endif /* AUTOKEY */
+
/**
* trusted-cert option description:
*/
#ifdef AUTOKEY
/** Descriptive text for the trusted-cert option */
-#define TRUSTED_CERT_DESC (ntp_keygen_opt_strs+1819)
+#define TRUSTED_CERT_DESC (ntp_keygen_opt_strs+1839)
/** Upper-cased name for the trusted-cert option */
-#define TRUSTED_CERT_NAME (ntp_keygen_opt_strs+1851)
+#define TRUSTED_CERT_NAME (ntp_keygen_opt_strs+1871)
/** Name string for the trusted-cert option */
-#define TRUSTED_CERT_name (ntp_keygen_opt_strs+1864)
+#define TRUSTED_CERT_name (ntp_keygen_opt_strs+1884)
/** Compiled in flag settings for the trusted-cert option */
#define TRUSTED_CERT_FLAGS (OPTST_DISABLED)
*/
#ifdef AUTOKEY
/** Descriptive text for the mv-params option */
-#define MV_PARAMS_DESC (ntp_keygen_opt_strs+1877)
+#define MV_PARAMS_DESC (ntp_keygen_opt_strs+1897)
/** Upper-cased name for the mv-params option */
-#define MV_PARAMS_NAME (ntp_keygen_opt_strs+1906)
+#define MV_PARAMS_NAME (ntp_keygen_opt_strs+1926)
/** Name string for the mv-params option */
-#define MV_PARAMS_name (ntp_keygen_opt_strs+1916)
+#define MV_PARAMS_name (ntp_keygen_opt_strs+1936)
/** Compiled in flag settings for the mv-params option */
#define MV_PARAMS_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_NUMERIC))
*/
#ifdef AUTOKEY
/** Descriptive text for the mv-keys option */
-#define MV_KEYS_DESC (ntp_keygen_opt_strs+1926)
+#define MV_KEYS_DESC (ntp_keygen_opt_strs+1946)
/** Upper-cased name for the mv-keys option */
-#define MV_KEYS_NAME (ntp_keygen_opt_strs+1947)
+#define MV_KEYS_NAME (ntp_keygen_opt_strs+1967)
/** Name string for the mv-keys option */
-#define MV_KEYS_name (ntp_keygen_opt_strs+1955)
+#define MV_KEYS_name (ntp_keygen_opt_strs+1975)
/** Compiled in flag settings for the mv-keys option */
#define MV_KEYS_FLAGS (OPTST_DISABLED \
| OPTST_SET_ARGTYPE(OPARG_TYPE_NUMERIC))
/*
* Help/More_Help/Version option descriptions:
*/
-#define HELP_DESC (ntp_keygen_opt_strs+1963)
-#define HELP_name (ntp_keygen_opt_strs+2007)
+#define HELP_DESC (ntp_keygen_opt_strs+1983)
+#define HELP_name (ntp_keygen_opt_strs+2027)
#ifdef HAVE_WORKING_FORK
-#define MORE_HELP_DESC (ntp_keygen_opt_strs+2012)
-#define MORE_HELP_name (ntp_keygen_opt_strs+2057)
+#define MORE_HELP_DESC (ntp_keygen_opt_strs+2032)
+#define MORE_HELP_name (ntp_keygen_opt_strs+2077)
#define MORE_HELP_FLAGS (OPTST_IMM | OPTST_NO_INIT)
#else
#define MORE_HELP_DESC HELP_DESC
# define VER_FLAGS (OPTST_SET_ARGTYPE(OPARG_TYPE_STRING) | \
OPTST_ARG_OPTIONAL | OPTST_IMM | OPTST_NO_INIT)
#endif
-#define VER_DESC (ntp_keygen_opt_strs+2067)
-#define VER_name (ntp_keygen_opt_strs+2103)
-#define SAVE_OPTS_DESC (ntp_keygen_opt_strs+2111)
-#define SAVE_OPTS_name (ntp_keygen_opt_strs+2150)
-#define LOAD_OPTS_DESC (ntp_keygen_opt_strs+2160)
-#define LOAD_OPTS_NAME (ntp_keygen_opt_strs+2192)
-#define NO_LOAD_OPTS_name (ntp_keygen_opt_strs+2202)
-#define LOAD_OPTS_pfx (ntp_keygen_opt_strs+2215)
+#define VER_DESC (ntp_keygen_opt_strs+2087)
+#define VER_name (ntp_keygen_opt_strs+2123)
+#define SAVE_OPTS_DESC (ntp_keygen_opt_strs+2131)
+#define SAVE_OPTS_name (ntp_keygen_opt_strs+2170)
+#define LOAD_OPTS_DESC (ntp_keygen_opt_strs+2180)
+#define LOAD_OPTS_NAME (ntp_keygen_opt_strs+2212)
+#define NO_LOAD_OPTS_name (ntp_keygen_opt_strs+2222)
+#define LOAD_OPTS_pfx (ntp_keygen_opt_strs+2235)
#define LOAD_OPTS_name (NO_LOAD_OPTS_name + 3)
/**
* Declare option callback procedures
/* desc, NAME, name */ LIFETIME_DESC, LIFETIME_NAME, LIFETIME_name,
/* disablement strs */ NULL, NULL },
- { /* entry idx, value */ 11, VALUE_OPT_MD5KEY,
- /* equiv idx, value */ 11, VALUE_OPT_MD5KEY,
+ { /* entry idx, value */ 11, VALUE_OPT_MODULUS,
+ /* equiv idx, value */ 11, VALUE_OPT_MODULUS,
/* equivalenced to */ NO_EQUIVALENT,
/* min, max, act ct */ 0, 1, 0,
- /* opt state flags */ MD5KEY_FLAGS, 0,
- /* last opt argumnt */ { NULL }, /* --md5key */
+ /* opt state flags */ MODULUS_FLAGS, 0,
+ /* last opt argumnt */ { NULL }, /* --modulus */
/* arg list/cookie */ NULL,
/* must/cannot opts */ NULL, NULL,
- /* option proc */ NULL,
- /* desc, NAME, name */ MD5KEY_DESC, MD5KEY_NAME, MD5KEY_name,
+ /* option proc */ doOptModulus,
+ /* desc, NAME, name */ MODULUS_DESC, MODULUS_NAME, MODULUS_name,
/* disablement strs */ NULL, NULL },
- { /* entry idx, value */ 12, VALUE_OPT_MODULUS,
- /* equiv idx, value */ 12, VALUE_OPT_MODULUS,
+ { /* entry idx, value */ 12, VALUE_OPT_MD5KEY,
+ /* equiv idx, value */ 12, VALUE_OPT_MD5KEY,
/* equivalenced to */ NO_EQUIVALENT,
/* min, max, act ct */ 0, 1, 0,
- /* opt state flags */ MODULUS_FLAGS, 0,
- /* last opt argumnt */ { NULL }, /* --modulus */
+ /* opt state flags */ MD5KEY_FLAGS, 0,
+ /* last opt argumnt */ { NULL }, /* --md5key */
/* arg list/cookie */ NULL,
/* must/cannot opts */ NULL, NULL,
- /* option proc */ doOptModulus,
- /* desc, NAME, name */ MODULUS_DESC, MODULUS_NAME, MODULUS_name,
+ /* option proc */ NULL,
+ /* desc, NAME, name */ MD5KEY_DESC, MD5KEY_NAME, MD5KEY_name,
/* disablement strs */ NULL, NULL },
{ /* entry idx, value */ 13, VALUE_OPT_PVT_CERT,
/* desc, NAME, name */ EXPORT_PASSWD_DESC, EXPORT_PASSWD_NAME, EXPORT_PASSWD_name,
/* disablement strs */ NULL, NULL },
- { /* entry idx, value */ 16, VALUE_OPT_SIGN_KEY,
- /* equiv idx, value */ 16, VALUE_OPT_SIGN_KEY,
+ { /* entry idx, value */ 16, VALUE_OPT_SUBJECT_NAME,
+ /* equiv idx, value */ 16, VALUE_OPT_SUBJECT_NAME,
/* equivalenced to */ NO_EQUIVALENT,
/* min, max, act ct */ 0, 1, 0,
- /* opt state flags */ SIGN_KEY_FLAGS, 0,
- /* last opt argumnt */ { NULL }, /* --sign-key */
+ /* opt state flags */ SUBJECT_NAME_FLAGS, 0,
+ /* last opt argumnt */ { NULL }, /* --subject-name */
/* arg list/cookie */ NULL,
/* must/cannot opts */ NULL, NULL,
/* option proc */ NULL,
- /* desc, NAME, name */ SIGN_KEY_DESC, SIGN_KEY_NAME, SIGN_KEY_name,
+ /* desc, NAME, name */ SUBJECT_NAME_DESC, SUBJECT_NAME_NAME, SUBJECT_NAME_name,
/* disablement strs */ NULL, NULL },
- { /* entry idx, value */ 17, VALUE_OPT_SUBJECT_NAME,
- /* equiv idx, value */ 17, VALUE_OPT_SUBJECT_NAME,
+ { /* entry idx, value */ 17, VALUE_OPT_SIGN_KEY,
+ /* equiv idx, value */ 17, VALUE_OPT_SIGN_KEY,
/* equivalenced to */ NO_EQUIVALENT,
/* min, max, act ct */ 0, 1, 0,
- /* opt state flags */ SUBJECT_NAME_FLAGS, 0,
- /* last opt argumnt */ { NULL }, /* --subject-name */
+ /* opt state flags */ SIGN_KEY_FLAGS, 0,
+ /* last opt argumnt */ { NULL }, /* --sign-key */
/* arg list/cookie */ NULL,
/* must/cannot opts */ NULL, NULL,
/* option proc */ NULL,
- /* desc, NAME, name */ SUBJECT_NAME_DESC, SUBJECT_NAME_NAME, SUBJECT_NAME_name,
+ /* desc, NAME, name */ SIGN_KEY_DESC, SIGN_KEY_NAME, SIGN_KEY_name,
/* disablement strs */ NULL, NULL },
{ /* entry idx, value */ 18, VALUE_OPT_TRUSTED_CERT,
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/** Reference to the upper cased version of ntp-keygen. */
-#define zPROGNAME (ntp_keygen_opt_strs+2218)
+#define zPROGNAME (ntp_keygen_opt_strs+2238)
/** Reference to the title line for ntp-keygen usage. */
-#define zUsageTitle (ntp_keygen_opt_strs+2229)
+#define zUsageTitle (ntp_keygen_opt_strs+2249)
/** ntp-keygen configuration file name. */
-#define zRcName (ntp_keygen_opt_strs+2351)
+#define zRcName (ntp_keygen_opt_strs+2371)
/** Directories to search for ntp-keygen config files. */
static char const * const apzHomeList[3] = {
- ntp_keygen_opt_strs+2343,
- ntp_keygen_opt_strs+2349,
+ ntp_keygen_opt_strs+2363,
+ ntp_keygen_opt_strs+2369,
NULL };
/** The ntp-keygen program bug email address. */
-#define zBugsAddr (ntp_keygen_opt_strs+2358)
+#define zBugsAddr (ntp_keygen_opt_strs+2378)
/** Clarification/explanation of what ntp-keygen does. */
-#define zExplain (ntp_keygen_opt_strs+2392)
+#define zExplain (ntp_keygen_opt_strs+2412)
/** Extra detail explaining what ntp-keygen does. */
#define zDetail (NULL)
/** The full version string for ntp-keygen. */
-#define zFullVersion (ntp_keygen_opt_strs+2394)
+#define zFullVersion (ntp_keygen_opt_strs+2414)
/* extracted from optcode.tlib near line 364 */
#if defined(ENABLE_NLS)
puts(_("set certificate lifetime"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
- puts(_("generate MD5 keys"));
+ puts(_("prime modulus"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
- puts(_("modulus"));
+ puts(_("generate symmetric keys"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
puts(_("generate PC private certificate"));
puts(_("export IFF or GQ group keys with password"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
- puts(_("generate sign key (RSA or DSA)"));
+ puts(_("set host and optionally group name"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
- puts(_("set host and optionally group name"));
+ puts(_("generate sign key (RSA or DSA)"));
/* referenced via ntp_keygenOptions.pOptDesc->pzText */
puts(_("trusted certificate (TC scheme)"));
/*
* EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.h)
*
- * It has been AutoGen-ed January 2, 2017 at 12:05:31 PM by AutoGen 5.18.5
+ * It has been AutoGen-ed March 19, 2017 at 10:10:36 AM by AutoGen 5.18.5
* From the definitions ntp-keygen-opts.def
* and the template file options
*
INDEX_OPT_IFFKEY = 8,
INDEX_OPT_IDENT = 9,
INDEX_OPT_LIFETIME = 10,
- INDEX_OPT_MD5KEY = 11,
- INDEX_OPT_MODULUS = 12,
+ INDEX_OPT_MODULUS = 11,
+ INDEX_OPT_MD5KEY = 12,
INDEX_OPT_PVT_CERT = 13,
INDEX_OPT_PASSWORD = 14,
INDEX_OPT_EXPORT_PASSWD = 15,
- INDEX_OPT_SIGN_KEY = 16,
- INDEX_OPT_SUBJECT_NAME = 17,
+ INDEX_OPT_SUBJECT_NAME = 16,
+ INDEX_OPT_SIGN_KEY = 17,
INDEX_OPT_TRUSTED_CERT = 18,
INDEX_OPT_MV_PARAMS = 19,
INDEX_OPT_MV_KEYS = 20,
# warning undefining LIFETIME due to option name conflict
# undef LIFETIME
# endif
-# ifdef MD5KEY
-# warning undefining MD5KEY due to option name conflict
-# undef MD5KEY
-# endif
# ifdef MODULUS
# warning undefining MODULUS due to option name conflict
# undef MODULUS
# endif
+# ifdef MD5KEY
+# warning undefining MD5KEY due to option name conflict
+# undef MD5KEY
+# endif
# ifdef PVT_CERT
# warning undefining PVT_CERT due to option name conflict
# undef PVT_CERT
# warning undefining EXPORT_PASSWD due to option name conflict
# undef EXPORT_PASSWD
# endif
-# ifdef SIGN_KEY
-# warning undefining SIGN_KEY due to option name conflict
-# undef SIGN_KEY
-# endif
# ifdef SUBJECT_NAME
# warning undefining SUBJECT_NAME due to option name conflict
# undef SUBJECT_NAME
# endif
+# ifdef SIGN_KEY
+# warning undefining SIGN_KEY due to option name conflict
+# undef SIGN_KEY
+# endif
# ifdef TRUSTED_CERT
# warning undefining TRUSTED_CERT due to option name conflict
# undef TRUSTED_CERT
# undef IFFKEY
# undef IDENT
# undef LIFETIME
-# undef MD5KEY
# undef MODULUS
+# undef MD5KEY
# undef PVT_CERT
# undef PASSWORD
# undef EXPORT_PASSWD
-# undef SIGN_KEY
# undef SUBJECT_NAME
+# undef SIGN_KEY
# undef TRUSTED_CERT
# undef MV_PARAMS
# undef MV_KEYS
#ifdef AUTOKEY
#define OPT_VALUE_LIFETIME (DESC(LIFETIME).optArg.argInt)
#endif /* AUTOKEY */
-#define VALUE_OPT_MD5KEY 'M'
#define VALUE_OPT_MODULUS 'm'
#ifdef AUTOKEY
#define OPT_VALUE_MODULUS (DESC(MODULUS).optArg.argInt)
#endif /* AUTOKEY */
+#define VALUE_OPT_MD5KEY 'M'
#define VALUE_OPT_PVT_CERT 'P'
#define VALUE_OPT_PASSWORD 'p'
#define VALUE_OPT_EXPORT_PASSWD 'q'
-#define VALUE_OPT_SIGN_KEY 'S'
#define VALUE_OPT_SUBJECT_NAME 's'
+#define VALUE_OPT_SIGN_KEY 'S'
#define VALUE_OPT_TRUSTED_CERT 'T'
#define VALUE_OPT_MV_PARAMS 'V'
#ifdef AUTOKEY
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-keygen 1ntp-keygenman "02 Jan 2017" "ntp (4.2.8p9)" "User Commands"
+.TH ntp-keygen 1ntp-keygenman "19 Mar 2017" "ntp (4.2.8p9)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:38 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:42 AM by AutoGen 5.18.5
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH DESCRIPTION
This program generates cryptographic data files used by the NTPv4
authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
-In addition, if the OpenSSL software library has been installed,
-it generates keys, certificate and identity files used in public key
-cryptography.
+It can generate message digest keys used in symmetric key cryptography and,
+if the OpenSSL software library has been installed, it can generate host keys,
+signing keys, certificates, and identity keys and parameters used in Autokey
+public key cryptography.
These files are used for cookie encryption,
-digital signature and challenge/response identification algorithms
+digital signature, and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
.sp \n(Ppu
.ne 2
-All files are in PEM-encoded printable ASCII format,
-so they can be embedded as MIME attachments in mail to other sites
+The message digest symmetric keys file is generated in a format
+compatible with NTPv3.
+All other files are in PEM-encoded printable ASCII format,
+so they can be embedded as MIME attachments in email to other sites
and certificate authorities.
By default, files are not encrypted.
.sp \n(Ppu
.ne 2
-When used to generate message digest keys, the program produces a file
-containing ten pseudo-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+When used to generate message digest symmetric keys, the program
+produces a file containing ten pseudo-random printable ASCII strings
+suitable for the MD5 message digest algorithm included in the
+distribution.
If the OpenSSL library is installed, it produces an additional ten
-hex-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
-The message digest keys file must be distributed and stored
+hex-encoded random bit strings suitable for SHA1, AES-128-CMAC, and
+other message digest algorithms.
+The message digest symmetric keys file must be distributed and stored
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
Some files used by this program are encrypted using a private password.
The
\f\*[B-Font]\-p\f[]
-option specifies the password for local encrypted files and the
+option specifies the read password for local encrypted files and the
\f\*[B-Font]\-q\f[]
-option the password for encrypted files sent to remote sites.
+option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-\fBgethostname\f[]\fR()\f[]
-function, normally the DNS name of the host is used.
+\fChostname\f[]\fR(1)\f[]
+command, normally the DNS name of the host, is used as the the default read
+password, for convenience.
+The
+\f\*[B-Font]ntp-keygen\fP
+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
+no write password is specified, the read password is used
+as the write password by default.
.sp \n(Ppu
.ne 2
The
-\f\*[I-Font]pw\f[]
+\f\*[B-Font]pw\f[]
option of the
-\f\*[I-Font]crypto\f[]
+\f\*[B-Font]crypto\f[]
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
configuration command specifies the read
password for previously encrypted local files.
-This must match the local password used by this program.
+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 password,
+Thus, if files are generated by this program without an explicit password,
they can be read back by
-\f\*[I-Font]ntpd\f[]
-without password but only on the same host.
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
+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.
.sp \n(Ppu
.ne 2
used only by that host, although exceptions exist as noted later on
this page.
The symmetric keys file, normally called
-\f\*[I-Font]ntp.keys\f[],
+\fIntp.keys\f[],
is usually installed in
\fI/etc\f[].
Other files and links are usually installed in
\fI/usr/local/etc\f[],
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
-\f\*[I-Font]keysdir\f[]
-configuration command in such cases.
-Normally, this is in
-\fI/etc\f[].
+In these cases, NFS clients can specify the files in another
+directory such as
+\fI/etc\f[]
+using the
+\f\*[B-Font]keysdir\f[]
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
+configuration file command.
.sp \n(Ppu
.ne 2
This program directs commentary and error messages to the standard
error stream
-\f\*[I-Font]stderr\f[]
+\fIstderr\f[]
and remote files to the standard output stream
-\f\*[I-Font]stdout\f[]
+\fIstdout\f[]
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
-\f\*[I-Font]ntpkey\f[]
+\fIntpkey\&*\f[]
and include the file type, generating host and filestamp,
as described in the
-\*[Lq]Cryptographic Data Files\*[Rq]
+\fICryptographic Data Files\f[]
section below.
.SS Running the Program
-To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually
-\fI/usr/local/etc\f[]
-When run for the first time, or if all files with names beginning with
-\f\*[I-Font]ntpkey\f[]
-have been removed, use the
-\f\*[B-Font]ntp-keygen\fP
-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
-existing keys and parameters and generates only a new certificate with
-new expiration date one year hence.
-.sp \n(Ppu
-.ne 2
-
-Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using
+The safest way to run the
\f\*[B-Font]ntp-keygen\fP
-with the
-\f\*[B-Font]\-T\f[]
-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
-ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
-All group hosts should have acyclic certificate trails ending on the TH.
-.sp \n(Ppu
-.ne 2
-
-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
-\f\*[B-Font]\-S\f[]
-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
-\f\*[B-Font]\-c\f[]
-option.
-The rules say cryptographic media should be generated with proventic
-filestamps, which means the host should already be synchronized before
-this program is run.
-This of course creates a chicken-and-egg problem
-when the host is started for the first time.
-Accordingly, the host time
-should be set by some other means, such as eyeball-and-wristwatch, at
-least so that the certificate lifetime is within the current year.
-After that and when the host is synchronized to a proventic source, the
-certificate should be re-generated.
-.sp \n(Ppu
-.ne 2
-
-Additional information on trusted groups and identity schemes is on the
-\*[Lq]Autokey Public-Key Authentication\*[Rq]
-page.
-.sp \n(Ppu
-.ne 2
-
-The
-\fCntpd\f[]\fR(1ntpdmdoc)\f[]
-configuration command
-\f\*[B-Font]crypto\f[] \f\*[B-Font]pw\f[] \f\*[I-Font]password\f[]
-specifies the read password for previously encrypted files.
-The daemon expires on the spot if the password is missing
-or incorrect.
-For convenience, if a file has been previously encrypted,
-the default read password is the name of the host running
-the program.
-If the previous write password is specified as the host name,
-these files can be read by that host with no explicit password.
-.sp \n(Ppu
-.ne 2
-
-File names begin with the prefix
-\f\*[B-Font]ntpkey_\f[]
-and end with the postfix
-\f\*[I-Font]_hostname.filestamp\f[],
-where
-\f\*[I-Font]hostname\f[]
-is the owner name, usually the string returned
-by the Unix gethostname() routine, and
-\f\*[I-Font]filestamp\f[]
-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
-\f\*[B-Font]rm\f[] \f\*[B-Font]ntpkey\&*\f[]
-command or all files generated
-at a specific time can be removed by a
-\f\*[B-Font]rm\f[]
-\f\*[I-Font]\&*filestamp\f[]
-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.
-.sp \n(Ppu
-.ne 2
-
-All files are installed by default in the keys directory
+program is logged in directly as root.
+The recommended procedure is change to the
+\f\*[I-Font]keys\f[]
+directory, usually
\fI/usr/local/etc\f[],
-which is normally in a shared filesystem
-in NFS-mounted networks.
-The actual location of the keys directory
-and each file can be overridden by configuration commands,
-but this is not recommended.
-Normally, the files for each host are generated by that host
-and used only by that host, although exceptions exist
-as noted later on this page.
-.sp \n(Ppu
-.ne 2
-
-Normally, files containing private values,
-including the host key, sign key and identification parameters,
-are permitted root read/write-only;
-while others containing public values are permitted world readable.
-Alternatively, files containing private values can be encrypted
-and these files permitted world readable,
-which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
-dependent clients can all be installed in the same shared directory.
+then run the program.
.sp \n(Ppu
.ne 2
-The recommended practice is to keep the file name extensions
-when installing a file and to install a soft link
-from the generic names specified elsewhere on this page
-to the generated files.
-This allows new file generations to be activated simply
-by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
-If a link is not present,
-\fCntpd\f[]\fR(1ntpdmdoc)\f[]
-extracts the filestamp from the file itself.
-This allows clients to verify that the file and generation times
-are always current.
-The
-\f\*[B-Font]ntp-keygen\fP
-program uses the same timestamp extension for all files generated
-at one time, so each generation is distinct and can be readily
-recognized in monitoring data.
-.SS Running the program
-The safest way to run the
+To test and gain experience with Autokey concepts, log in as root and
+change to the
+\f\*[I-Font]keys\f[]
+directory, usually
+\fI/usr/local/etc\f[].
+When run for the first time, or if all files with names beginning with
+\fIntpkey\&*\f[]
+have been removed, use the
\f\*[B-Font]ntp-keygen\fP
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-\fI/usr/local/etc\f[],
-then run the program.
-When run for the first time,
-or if all
-\f\*[B-Font]ntpkey\f[]
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
+command without arguments to generate a default
+\f\*[B-Font]RSA\f[]
+host key and matching
+\f\*[B-Font]RSA-MD5\f[]
+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
to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+If run again without options, the program uses the
+existing keys and parameters and generates a new certificate file with
+new expiration date one year hence, and soft link.
.sp \n(Ppu
.ne 2
-The host key is used to encrypt the cookie when required and so must be RSA type.
+The host key is used to encrypt the cookie when required and so must be
+\f\*[B-Font]RSA\f[]
+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 RSA or DSA type.
-By default, the message digest type is MD5, but any combination
+either
+\f\*[B-Font]RSA\f[]
+or
+\f\*[B-Font]DSA\f[]
+type.
+By default, the message digest type is
+\f\*[B-Font]MD5\f[],
+but any combination
of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+can be specified, including those using the
+\f\*[B-Font]AES128CMAC\f[], \f\*[B-Font]MD2\f[], \f\*[B-Font]MD5\f[], \f\*[B-Font]MDC2\f[], \f\*[B-Font]SHA\f[], \f\*[B-Font]SHA1\f[]
+and
+\f\*[B-Font]RIPE160\f[]
+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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Certificates using any digest algorithm are compatible with
+\f\*[B-Font]RSA\f[]
+sign keys;
+however, only
+\f\*[B-Font]SHA\f[]
+and
+\f\*[B-Font]SHA1\f[]
+certificates are compatible with
+\f\*[B-Font]DSA\f[]
+sign keys.
.sp \n(Ppu
.ne 2
.ne 2
Running the program as other than root and using the Unix
-\f\*[B-Font]su\f[]
+\fCsu\f[]\fR(1)\f[]
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-\f\*[B-Font].rnd\f[]
+\fI.rnd\f[]
in the user home directory.
However, there should be only one
-\f\*[B-Font].rnd\f[],
+\fI.rnd\f[],
most conveniently
in the root directory, so it is convenient to define the
-\f\*[B-Font]$RANDFILE\f[]
+RANDFILE
environment variable used by the OpenSSL library as the path to
-\f\*[B-Font]/.rnd\f[].
+\fI.rnd\f[].
.sp \n(Ppu
.ne 2
\fI/etc\f[]
using the
\f\*[B-Font]keysdir\f[]
-command.
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
+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
by the Autokey protocol.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
+Since uniqueness is insured by the
+\f\*[I-Font]hostname\f[]
+and
+\f\*[I-Font]filestamp\f[]
+file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
.sp \n(Ppu
.ne 2
to the generated files.
This allows new file generations to be activated simply
by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+If a link is present,
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
+follows it to the file name to extract the
+\f\*[I-Font]filestamp\f[].
If a link is not present,
\fCntpd\f[]\fR(1ntpdmdoc)\f[]
-extracts the filestamp from the file itself.
+extracts the
+\f\*[I-Font]filestamp\f[]
+from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
\f\*[B-Font]ntp-keygen\fP
-program uses the same timestamp extension for all files generated
+program uses the same
+\f\*[I-Font]filestamp\f[]
+extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-.SS Running the program
-The safest way to run the
-\f\*[B-Font]ntp-keygen\fP
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-\fI/usr/local/etc\f[],
-then run the program.
-When run for the first time,
-or if all
-\f\*[B-Font]ntpkey\f[]
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
-which is all that is necessary in many cases.
-The program also generates soft links from the generic names
-to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
.sp \n(Ppu
.ne 2
-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.
-When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
-By default, the message digest type is MD5, but any combination
-of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Run the command on as many hosts as necessary.
+Designate one of them as the trusted host (TH) using
+\f\*[B-Font]ntp-keygen\fP
+with the
+\f\*[B-Font]\-T\f[]
+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
+ascendant host towards the TH to sign its certificate, which is then
+provided to the immediately descendant host on request.
+All group hosts should have acyclic certificate trails ending on the TH.
.sp \n(Ppu
.ne 2
-Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
-Certificates or certificate requests derived from them should be compatible
-with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
-However, the identification parameter files, although encoded
-as the other files, are probably not compatible with anything other than Autokey.
+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
+\f\*[B-Font]\-S\f[]
+option and this can be either
+\f\*[B-Font]RSA\f[]
+or
+\f\*[B-Font]DSA\f[]
+type.
+By default, the signature
+message digest type is
+\f\*[B-Font]MD5\f[],
+but any combination of sign key type and
+message digest type supported by the OpenSSL library can be specified
+using the
+\f\*[B-Font]\-c\f[]
+option.
.sp \n(Ppu
.ne 2
-Running the program as other than root and using the Unix
-\f\*[B-Font]su\f[]
-command
-to assume root may not work properly, since by default the OpenSSL library
-looks for the random seed file
-\f\*[B-Font].rnd\f[]
-in the user home directory.
-However, there should be only one
-\f\*[B-Font].rnd\f[],
-most conveniently
-in the root directory, so it is convenient to define the
-\f\*[B-Font]$RANDFILE\f[]
-environment variable used by the OpenSSL library as the path to
-\f\*[B-Font]/.rnd\f[].
+The rules say cryptographic media should be generated with proventic
+filestamps, which means the host should already be synchronized before
+this program is run.
+This of course creates a chicken-and-egg problem
+when the host is started for the first time.
+Accordingly, the host time
+should be set by some other means, such as eyeball-and-wristwatch, at
+least so that the certificate lifetime is within the current year.
+After that and when the host is synchronized to a proventic source, the
+certificate should be re-generated.
.sp \n(Ppu
.ne 2
-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
-\fI/etc\f[]
-using the
-\f\*[B-Font]keysdir\f[]
-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
-by the Autokey protocol.
+Additional information on trusted groups and identity schemes is on the
+\*[Lq]Autokey Public-Key Authentication\*[Rq]
+page.
.sp \n(Ppu
.ne 2
-Ordinarily, cryptographic files are generated by the host that uses them,
-but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
-The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
-It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
-The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
-seconds.
-seconds.
-s Trusted Hosts and Groups
+File names begin with the prefix
+\fIntpkey\f[]_
+and end with the suffix
+\fI_\f[]\f\*[I-Font]hostname\f[]. \f\*[I-Font]filestamp\f[],
+where
+\f\*[I-Font]hostname\f[]
+is the owner name, usually the string returned
+by the Unix
+\fChostname\f[]\fR(1)\f[]
+command, and
+\f\*[I-Font]filestamp\f[]
+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
+\f\*[B-Font]rm\f[] \fIntpkey\&*\f[]
+command or all files generated
+at a specific time can be removed by a
+\f\*[B-Font]rm\f[] \fI\&*\f[]\f\*[I-Font]filestamp\f[]
+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.
+.SS Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
\fIAuthentication\f[] \fIOptions\f[]
section of
\fCntp.conf\f[]\fR(5)\f[].
-The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+The default cryptotype uses
+\f\*[B-Font]RSA\f[]
+encryption,
+\f\*[B-Font]MD5\f[]
+message digest
+and
+\f\*[B-Font]TC\f[]
+identification.
First, configure a NTP subnet including one or more low-stratum
trusted hosts from which all other hosts derive synchronization
directly or indirectly.
On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-\f\*[B-Font]ntpkey\f[]
+\fIntpkey\f[]
files.
Then run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]RSA\f[]
or
\f\*[B-Font]DSA\f[].
-The most often need to do this is when a DSA-signed certificate is used.
+The most frequent need to do this is when a
+\f\*[B-Font]DSA\f[]\-signed
+certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
\f\*[B-Font]ntp-keygen\fP
option and selected
\f\*[I-Font]scheme\f[]
as needed.
-f
+If
\f\*[B-Font]ntp-keygen\fP
is run again without these options, it generates a new certificate
-using the same scheme and sign key.
+using the same scheme and sign key, and soft link.
.sp \n(Ppu
.ne 2
Simply run
\f\*[B-Font]ntp-keygen\fP
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys, and soft links.
However, if the host or sign key is changed,
\fCntpd\f[]\fR(1ntpdmdoc)\f[]
should be restarted.
at which time the protocol is restarted.
.SS Identity Schemes
As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default
+\f\*[B-Font]TC\f[]
+identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
-including PC, IFF, GQ and MV described on the
-"Identification Schemes"
-page
-(maybe available at
-\f[C]http://www.eecis.udel.edu/%7emills/keygen.html\f[]).
+including
+\f\*[B-Font]PC\f[], \f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[]
+and
+\f\*[B-Font]MV\f[]
+schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
\f\*[B-Font]\-P\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to generate the host key file
-\fIntpkey_RSAkey_\f[]\f\*[I-Font]alice.filestamp\f[]
+\fIntpkey\f[]_ \f\*[B-Font]RSA\f[] \fIkey_alice.\f[] \f\*[I-Font]filestamp\f[]
and trusted private certificate file
-\fIntpkey_RSA-MD5_cert_\f[]\f\*[I-Font]alice.filestamp\f[].
+\fIntpkey\f[]_ \f\*[B-Font]RSA-MD5\f[] \f\*[B-Font]_\f[] \fIcert_alice.\f[] \f\*[I-Font]filestamp\f[],
+and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
-On each host bob install a soft link from the generic name
+On each host
+\f\*[I-Font]bob\f[]
+install a soft link from the generic name
\fIntpkey_host_\f[]\f\*[I-Font]bob\f[]
to the host key file and soft link
\fIntpkey_cert_\f[]\f\*[I-Font]bob\f[]
by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
-to all other hosts in the group.
+to all other hosts in the group, and recreating the soft links.
.sp \n(Ppu
.ne 2
-For the IFF scheme proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]IFF\f[]
+scheme proceed as in the
+\f\*[B-Font]TC\f[]
+scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the
+\f\*[B-Font]IFF\f[]
+parameter file.
On trusted host alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-T\f[]
\f\*[B-Font]\-I\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to produce her parameter file
-\fIntpkey_IFFpar_\f[]\f\*[I-Font]alice.filestamp\f[],
+\fIntpkey_IFFpar_alice.\f[]\f\*[I-Font]filestamp\f[],
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
-\fIntpkey_iff_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_iff_alice\f[]
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
-As the IFF scheme is independent
+As the
+\f\*[B-Font]IFF\f[]
+scheme is independent
of keys and certificates, these files can be refreshed as needed.
.sp \n(Ppu
.ne 2
After generating the parameter file, on alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-e\f[]
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+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
-\fIntpkey_iff_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_iff_alice\f[]
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
.sp \n(Ppu
.ne 2
-For the GQ scheme proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]GQ\f[]
+scheme proceed as in the
+\f\*[B-Font]TC\f[]
+scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the
+\f\*[B-Font]IFF\f[]
+parameter file.
On trusted host alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-T\f[]
\f\*[B-Font]\-G\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to produce her parameter file
-\fIntpkey_GQpar_\f[]\f\*[I-Font]alice.filestamp\f[],
+\fIntpkey_GQpar_alice.\f[]\f\*[I-Font]filestamp\f[],
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-\fIntpkey_gq_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_gq_alice\f[]
to this file.
-In addition, on each host bob install a soft link
+In addition, on each host
+\f\*[I-Font]bob\f[]
+install a soft link
from generic
\fIntpkey_gq_\f[]\f\*[I-Font]bob\f[]
to this file.
-As the GQ scheme updates the GQ parameters file and certificate
+As the
+\f\*[B-Font]GQ\f[]
+scheme updates the
+\f\*[B-Font]GQ\f[]
+parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
.sp \n(Ppu
.ne 2
-For the MV scheme, proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]MV\f[]
+scheme, proceed as in the
+\f\*[B-Font]TC\f[]
+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.
\f\*[I-Font]n\f[]
is the number of revokable keys (typically 5) to produce
the parameter file
-\fIntpkeys_MVpar_\f[]\f\*[I-Font]trish.filestamp\f[]
+\fIntpkeys_MVpar_trish.\f[]\f\*[I-Font]filestamp\f[]
and client key files
-\fIntpkeys_MVkeyd_\f[]\f\*[I-Font]trish.filestamp\f[]
+\fIntpkeys_MVkey\f[]\f\*[I-Font]d\f[] \f\*[I-Font]_\f[] \fItrish.\f[] \f\*[I-Font]filestamp\f[]
where
\f\*[I-Font]d\f[]
is the key number (0 \&<
\f\*[I-Font]n\f[]).
Copy the parameter file to alice and install a soft link
from the generic
-\fIntpkey_mv_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_mv_alice\f[]
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
-It doesn't matter which client key file goes to alice,
+It does not matter which client key file goes to alice,
since they all work the same way.
-Alice copies the client key file to all of her cliens.
+Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-\fIntpkey_mvkey_\f[]\f\*[I-Font]bob\f[]
+\fIntpkey_mvkey_bob\f[]
to the client key file.
-As the MV scheme is independent of keys and certificates,
+As the
+\f\*[B-Font]MV\f[]
+scheme is independent of keys and certificates,
these files can be refreshed as needed.
.SS Command Line Options
.TP 7
-.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]scheme\f[]
-Select certificate message digest/signature encryption scheme.
+.NOP \f\*[B-Font]\-b\f[] \f\*[B-Font]\-\-imbits\f[]= \f\*[I-Font]modulus\f[]
+Set the number of bits in the identity modulus for generating identity keys to
+\f\*[I-Font]modulus\f[]
+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.
+.TP 7
+.NOP \f\*[B-Font]\-c\f[] \f\*[B-Font]\-\-certificate\f[]= \f\*[I-Font]scheme\f[]
+Select certificate signature encryption/message digest scheme.
The
\f\*[I-Font]scheme\f[]
can be one of the following:
-. Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA ,
+\f\*[B-Font]RSA-MD2\f[], \f\*[B-Font]RSA-MD5\f[], \f\*[B-Font]RSA-MDC2\f[], \f\*[B-Font]RSA-SHA\f[], \f\*[B-Font]RSA-SHA1\f[], \f\*[B-Font]RSA-RIPEMD160\f[], \f\*[B-Font]DSA-SHA\f[],
or
\f\*[B-Font]DSA-SHA1\f[].
-Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+Note that
+\f\*[B-Font]RSA\f[]
+schemes must be used with an
+\f\*[B-Font]RSA\f[]
+sign key and
+\f\*[B-Font]DSA\f[]
+schemes must be used with a
+\f\*[B-Font]DSA\f[]
+sign key.
The default without this option is
\f\*[B-Font]RSA-MD5\f[].
+If compatibility with FIPS 140-2 is required, either the
+\f\*[B-Font]DSA-SHA\f[]
+or
+\f\*[B-Font]DSA-SHA1\f[]
+scheme must be used.
.TP 7
-.NOP \f\*[B-Font]\-d\f[]
-Enable debugging.
+.NOP \f\*[B-Font]\-C\f[] \f\*[B-Font]\-\-cipher\f[]= \f\*[I-Font]cipher\f[]
+Select the OpenSSL cipher to encrypt the files containing private keys.
+The default without this option is three-key triple DES in CBC mode,
+\f\*[B-Font]des-ede3-cbc\f[].
+The
+\f\*[B-Font]openssl\f[] \f\*[B-Font]\-h\f[]
+command provided with OpenSSL displays available ciphers.
+.TP 7
+.NOP \f\*[B-Font]\-d\f[] \f\*[B-Font]\-\-debug-level\f[]
+Increase debugging verbosity level.
This option displays the cryptographic data produced in eye-friendly billboards.
.TP 7
-.NOP \f\*[B-Font]\-e\f[]
-Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
+.NOP \f\*[B-Font]\-D\f[] \f\*[B-Font]\-\-set-debug-level\f[]= \f\*[I-Font]level\f[]
+Set the debugging verbosity to
+\f\*[I-Font]level\f[].
+This option displays the cryptographic data produced in eye-friendly billboards.
.TP 7
-.NOP \f\*[B-Font]\-G\f[]
-Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
+.NOP \f\*[B-Font]\-e\f[] \f\*[B-Font]\-\-id-key\f[]
+Write the
+\f\*[B-Font]IFF\f[]
+or
+\f\*[B-Font]GQ\f[]
+public parameters from the
+\f\*[I-Font]IFFkey\f[] \f\*[I-Font]or\f[] \f\*[I-Font]GQkey\f[]
+client keys file previously specified
+as unencrypted data to the standard output stream
+\fIstdout\f[].
+This is intended for automatic key distribution by email.
.TP 7
-.NOP \f\*[B-Font]\-g\f[]
-Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
+.NOP \f\*[B-Font]\-G\f[] \f\*[B-Font]\-\-gq-params\f[]
+Generate a new encrypted
+\f\*[B-Font]GQ\f[]
+parameters and key file for the Guillou-Quisquater (GQ) identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-I\f[]
+and
+\f\*[B-Font]\-V\f[]
+options.
.TP 7
-.NOP \f\*[B-Font]\-H\f[]
-Generate new host keys, obsoleting any that may exist.
+.NOP \f\*[B-Font]\-H\f[] \f\*[B-Font]\-\-host-key\f[]
+Generate a new encrypted
+\f\*[B-Font]RSA\f[]
+public/private host key file.
.TP 7
-.NOP \f\*[B-Font]\-I\f[]
-Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
+.NOP \f\*[B-Font]\-I\f[] \f\*[B-Font]\-\-iffkey\f[]
+Generate a new encrypted
+\f\*[B-Font]IFF\f[]
+key file for the Schnorr (IFF) identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-G\f[]
+and
+Fl V
+options.
.TP 7
-.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]name\f[]
-Set the suject name to
-\f\*[I-Font]name\f[].
-This is used as the subject field in certificates
-and in the file name for host and sign keys.
+.NOP \f\*[B-Font]\-i\f[] \f\*[B-Font]\-\-ident\f[]= \f\*[I-Font]group\f[]
+Set the optional Autokey group name to
+\f\*[I-Font]group\f[].
+This is used in the identity scheme parameter file names of
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[],
+and
+\f\*[B-Font]MV\f[]
+client parameters files.
+In that role, the default is the host name if no group is provided.
+The group name, if specified using
+\f\*[B-Font]\-i\f[]
+or
+\f\*[B-Font]\-s\f[]
+following an
+\[oq]@@\[cq]
+character, is also used in certificate subject and issuer names in the form
+\f\*[I-Font]host\f[] \f\*[I-Font]@@\f[] \f\*[I-Font]group\f[]
+and should match the group specified via
+\f\*[B-Font]crypto\f[] \f\*[B-Font]ident\f[]
+or
+\f\*[B-Font]server\f[] \f\*[B-Font]ident\f[]
+in the ntpd configuration file.
.TP 7
-.NOP \f\*[B-Font]\-M\f[]
-Generate MD5 keys, obsoleting any that may exist.
+.NOP \f\*[B-Font]\-l\f[] \f\*[B-Font]\-\-lifetime\f[]= \f\*[I-Font]days\f[]
+Set the lifetime for certificate expiration to
+\f\*[I-Font]days\f[].
+The default lifetime is one year (365 days).
.TP 7
-.NOP \f\*[B-Font]\-P\f[]
-Generate a private certificate.
-By default, the program generates public certificates.
+.NOP \f\*[B-Font]\-m\f[] \f\*[B-Font]\-\-modulus\f[]= \f\*[I-Font]bits\f[]
+Set the number of bits in the prime modulus for generating files to
+\f\*[I-Font]bits\f[].
+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.
.TP 7
-.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
-Encrypt generated files containing private data with
-\f\*[I-Font]password\f[]
-and the DES-CBC algorithm.
+.NOP \f\*[B-Font]\-M\f[] \f\*[B-Font]\-\-md5key\f[]
+Generate a new symmetric keys file containing 10
+\f\*[B-Font]MD5\f[]
+keys, and if OpenSSL is available, 10
+\f\*[B-Font]SHA\f[]
+keys.
+An
+\f\*[B-Font]MD5\f[]
+key is a string of 20 random printable ASCII characters, while a
+\f\*[B-Font]SHA\f[]
+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.
.TP 7
-.NOP \f\*[B-Font]\-q\f[]
-Set the password for reading files to password.
+.NOP \f\*[B-Font]\-p\f[] \f\*[B-Font]\-\-password\f[]= \f\*[I-Font]passwd\f[]
+Set the password for reading and writing encrypted files to
+\f\*[I-Font]passwd\f[].
+These include the host, sign and identify key files.
+By default, the password is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
.TP 7
-.NOP \f\*[B-Font]\-S\f[] [\f\*[B-Font]RSA\f[] | \f\*[B-Font]DSA\f[]]
-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.
+.NOP \f\*[B-Font]\-P\f[] \f\*[B-Font]\-\-pvt-cert\f[]
+Generate a new private certificate used by the
+\f\*[B-Font]PC\f[]
+identity scheme.
+By default, the program generates public certificates.
+Note: the PC identity scheme is not recommended for new installations.
.TP 7
-.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]name\f[]
-Set the issuer name to
-\f\*[I-Font]name\f[].
-This is used for the issuer field in certificates
-and in the file name for identity files.
+.NOP \f\*[B-Font]\-q\f[] \f\*[B-Font]\-\-export-passwd\f[]= \f\*[I-Font]passwd\f[]
+Set the password for writing encrypted
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[] \f\*[B-Font]and\f[] \f\*[B-Font]MV\f[]
+identity files redirected to
+\fIstdout\f[]
+to
+\f\*[I-Font]passwd\f[].
+In effect, these files are decrypted with the
+\f\*[B-Font]\-p\f[]
+password, then encrypted with the
+\f\*[B-Font]\-q\f[]
+password.
+By default, the password is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
.TP 7
-.NOP \f\*[B-Font]\-T\f[]
+.NOP \f\*[B-Font]\-s\f[] \f\*[B-Font]\-\-subject-key\f[]= [host] [@@ \f\*[I-Font]group\f[]]
+Specify the Autokey host name, where
+\f\*[I-Font]host\f[]
+is the optional host name and
+\f\*[I-Font]group\f[]
+is the optional group name.
+The host name, and if provided, group name are used in
+\f\*[I-Font]host\f[] \f\*[I-Font]@@\f[] \f\*[I-Font]group\f[]
+form as certificate subject and issuer.
+Specifying
+\f\*[B-Font]\-s\f[] \f\*[B-Font]\-@@\f[] \f\*[I-Font]group\f[]
+is allowed, and results in leaving the host name unchanged, as with
+\f\*[B-Font]\-i\f[] \f\*[I-Font]group\f[].
+The group name, or if no group is provided, the host name are also used in the
+file names of
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[],
+and
+\f\*[B-Font]MV\f[]
+identity scheme client parameter files.
+If
+\f\*[I-Font]host\f[]
+is not specified, the default host name is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
+.TP 7
+.NOP \f\*[B-Font]\-S\f[] \f\*[B-Font]\-\-sign-key\f[]= [\f\*[B-Font]RSA\f[] | \f\*[B-Font]DSA\f[]]
+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
+\f\*[B-Font]DSA\f[].
+.TP 7
+.NOP \f\*[B-Font]\-T\f[] \f\*[B-Font]\-\-trusted-cert\f[]
Generate a trusted certificate.
By default, the program generates a non-trusted certificate.
.TP 7
-.NOP \f\*[B-Font]\-V\f[] \f\*[I-Font]nkeys\f[]
-Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme.
+.NOP \f\*[B-Font]\-V\f[] \f\*[B-Font]\-\-mv-params\f[] \f\*[I-Font]nkeys\f[]
+Generate
+\f\*[I-Font]nkeys\f[]
+encrypted server keys and parameters for the Mu-Varadharajan (MV)
+identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-I\f[]
+and
+\f\*[B-Font]\-G\f[]
+options.
+Note: support for this option should be considered a work in progress.
.PP
.SS Random Seed File
All cryptographically sound key generation schemes must have means
The entropy seed used by the OpenSSL library is contained in a file,
usually called
-\f\*[B-Font].rnd\f[],
+\fI.rnd\f[],
which must be available when starting the NTP daemon
or the
\f\*[B-Font]ntp-keygen\fP
RANDFILE
environment variable is not present,
the library will look for the
-\f\*[B-Font].rnd\f[]
+\fI.rnd\f[]
file in the user home directory.
+Since both the
+\f\*[B-Font]ntp-keygen\fP
+program and
+\fCntpd\f[]\fR(1ntpdmdoc)\f[]
+daemon must run as root, the logical place to put this file is in
+\fI/.rnd\f[]
+or
+\fI/root/.rnd\f[].
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.
.SS Cryptographic Data Files
-All other file formats begin with two lines.
-The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
-Lines beginning with # are considered comments and ignored by the
+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
+\fIntpkey_\f[]\f\*[I-Font]key\f[] \f\*[I-Font]_\f[] \f\*[I-Font]name\f[]. \f\*[I-Font]filestamp\f[],
+where
+\f\*[I-Font]key\f[]
+is the key or parameter type,
+\f\*[I-Font]name\f[]
+is the host or group name and
+\f\*[I-Font]filestamp\f[]
+is the filestamp (NTP seconds) when the file was created.
+By convention,
+\f\*[I-Font]key\f[]
+names in generated file names include both upper and lower case
+characters, while
+\f\*[I-Font]key\f[]
+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
+\fIdate\f[]
+format.
+Lines beginning with
+\[oq]#\[cq]
+are considered comments and ignored by the
\f\*[B-Font]ntp-keygen\fP
program and
\fCntpd\f[]\fR(1ntpdmdoc)\f[]
daemon.
-Cryptographic values are encoded first using ASN.1 rules,
-then encrypted if necessary, and finally written PEM-encoded
-printable ASCII format preceded and followed by MIME content identifier lines.
.sp \n(Ppu
.ne 2
-The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
-Since DES-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
-Following hte heard the keys are
-entered one per line in the format
+The remainder of the file contains cryptographic data, encoded first using ASN.1
+rules, then encrypted if necessary, and finally written in PEM-encoded
+printable ASCII text, preceded and followed by MIME content identifier lines.
+.sp \n(Ppu
+.ne 2
+
+The format of the symmetric keys file, ordinarily named
+\fIntp.keys\f[],
+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.
+.br
+.in +4
+.nf
+# ntpkey_MD5key_bk.ntp.org.3595864945
+# Thu Dec 12 19:22:25 2013
+1 MD5 L";Nw<\`.I<f4U0)247"i # MD5 key
+2 MD5 &>l0%XXK9O'51VwV<xq~ # MD5 key
+3 MD5 lb4zLW~d^!K:]RsD'qb6 # MD5 key
+4 MD5 Yue:tL[+vR)M\`n~bY,'? # MD5 key
+5 MD5 B;fx'Kgr/&4ZTbL6=RxA # MD5 key
+6 MD5 4eYwa\`o}3i@@@@V@@..R9!l # MD5 key
+7 MD5 \`A.([h+;wTQ|xfi%Sn_! # MD5 key
+8 MD5 45:V,r4]l6y^JH6"Sh?F # MD5 key
+9 MD5 3-5vcn*6l29DS?Xdsg)* # MD5 key
+10 MD5 2late4Me # MD5 key
+11 SHA1 a27872d3030a9025b8446c751b4551a7629af65c # SHA1 key
+12 SHA1 21bc3b4865dbb9e920902abdccb3e04ff97a5e74 # SHA1 key
+13 SHA1 2b7736fe24fef5ba85ae11594132ab5d6f6daba9 # SHA1 key
+14 SHA a5332809c8878dd3a5b918819108a111509aeceb # SHA key
+15 MD2 2fe16c88c760ff2f16d4267e36c1aa6c926e6964 # MD2 key
+16 MD4 b2691811dc19cfc0e2f9bcacd74213f29812183d # MD4 key
+17 MD5 e4d6735b8bdad58ec5ffcb087300a17f7fef1f7c # MD5 key
+18 MDC2 a8d5e2315c025bf3a79174c87fbd10477de2eabc # MDC2 key
+19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
+20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
+.in -4
+.fi
+.in +4
+Figure 1. Typical Symmetric Key File
+.in -4
+.sp \n(Ppu
+.ne 2
+
+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
.in +4
\f\*[I-Font]keyno\f[] \f\*[I-Font]type\f[] \f\*[I-Font]key\f[]
.in -4
where
\f\*[I-Font]keyno\f[]
-is a positive integer in the range 1-65,535,
+is a positive integer in the range 1-65534;
\f\*[I-Font]type\f[]
-is the string MD5 defining the key format and
+is the key type for the message digest algorithm, which in the absence of the
+OpenSSL library must be
+\f\*[B-Font]MD5\f[]
+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
+\f\*[B-Font]SHA\f[]
+or
+\f\*[B-Font]SHA1\f[];
\f\*[I-Font]key\f[]
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
-Each character is chosen from the 93 printable characters
-in the range 0x21 through 0x7f excluding space and the
+which is a printable ASCII string 20 characters or less in length:
+each character is chosen from the 93 printable characters
+in the range 0x21 through 0x7e (
+\[oq]\[cq]!
+through
+\[oq]~\[cq]
+\&) excluding space and the
+\[oq]#\[cq]
+character, and terminated by whitespace or a
\[oq]#\[cq]
character.
+An OpenSSL key consists of a hex-encoded ASCII string of 40 characters, which
+is truncated as necessary.
.sp \n(Ppu
.ne 2
The
\f\*[B-Font]ntp-keygen\fP
-program generates a MD5 symmetric keys file
-\fIntpkey_MD5key_\f[]\f\*[I-Font]hostname.filestamp\f[].
+program generates a symmetric keys file
+\fIntpkey_MD5key_\f[]\f\*[I-Font]hostname\f[]. \f\*[I-Font]filestamp\f[].
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
certificate scheme.
.sp
scheme is one of
-RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160,
+RSA-MD2, RSA-MD5, RSA-MDC2, RSA-SHA, RSA-SHA1, RSA-RIPEMD160,
DSA-SHA, or DSA-SHA1.
.sp
-Select the certificate message digest/signature encryption scheme.
+Select the certificate signature encryption/message digest scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
this option is RSA-MD5.
.sp
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". The openssl tool lists ciphers
+equivalent to "\fB-C des-ede3-cbc\fP". The openssl tool lists ciphers
available in "\fBopenssl \-h\fP" output.
.TP
.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[]
.NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-id\-key\f[]
Write IFF or GQ identity keys.
.sp
-Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
+Write the public parameters from the IFF or GQ client keys to
+the standard output.
+This is intended for automatic key distribution by email.
.TP
.NOP \f\*[B-Font]\-G\f[], \f\*[B-Font]\-\-gq\-params\f[]
Generate GQ parameters and keys.
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 \fB-i/--ident\fP or
-using \fB-s/--subject-name\fP following an '\fB@\fP' character,
-is also a part of the self-signed host certificate's subject and
-issuer names in the form \fBhost@group\fP and should match the
-'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in
-\fBntpd\fP's configuration file.
+using \fB-s/--subject-name\fP following an '\fB@@\fP' character,
+is also a part of the self-signed host certificate subject and
+issuer names in the form \fBhost@@group\fP and should match the
+'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in the
+\fBntpd\fP configuration file.
.TP
.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]lifetime\f[], \f\*[B-Font]\-\-lifetime\f[]=\f\*[I-Font]lifetime\f[]
set certificate lifetime.
.sp
Set the certificate expiration to lifetime days from now.
.TP
-.NOP \f\*[B-Font]\-M\f[], \f\*[B-Font]\-\-md5key\f[]
-generate MD5 keys.
-.sp
-Generate MD5 keys, obsoleting any that may exist.
-.TP
.NOP \f\*[B-Font]\-m\f[] \f\*[I-Font]modulus\f[], \f\*[B-Font]\-\-modulus\f[]=\f\*[I-Font]modulus\f[]
-modulus.
+prime modulus.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]modulus\f[]
.sp
The number of bits in the prime modulus. The default is 512.
.TP
+.NOP \f\*[B-Font]\-M\f[], \f\*[B-Font]\-\-md5key\f[]
+generate symmetric keys.
+.sp
+Generate symmetric keys, obsoleting any that may exist.
+.TP
.NOP \f\*[B-Font]\-P\f[], \f\*[B-Font]\-\-pvt\-cert\f[]
generate PC private certificate.
.sp
"crypto pw password" configuration command. See also the option
--id-key (-e) for unencrypted exports.
.TP
-.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]sign\f[], \f\*[B-Font]\-\-sign\-key\f[]=\f\*[I-Font]sign\f[]
-generate sign key (RSA or DSA).
-.sp
-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.
-.TP
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]host@group\f[], \f\*[B-Font]\-\-subject\-name\f[]=\f\*[I-Font]host@group\f[]
set host and optionally group name.
.sp
Set the Autokey host name, and optionally, group name specified
-following an '\fB@\fP' character. The host name is used in the file
+following an '\fB@@\fP' 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 \fBhost@group\fP form for the host certificate's subject and issuer
-fields. Specifying '\fB-s @group\fP' is allowed, and results in
-leaving the host name unchanged while appending \fB@group\fP to the
+in \fBhost@@group\fP form for the host certificate subject and issuer
+fields. Specifying '\fB-s @@group\fP' is allowed, and results in
+leaving the host name unchanged while appending \fB@@group\fP to the
subject and issuer fields, as with \fB-i group\fP. 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.
.TP
+.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]sign\f[], \f\*[B-Font]\-\-sign\-key\f[]=\f\*[I-Font]sign\f[]
+generate sign key (RSA or DSA).
+.sp
+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.
+.TP
.NOP \f\*[B-Font]\-T\f[], \f\*[B-Font]\-\-trusted\-cert\f[]
trusted certificate (TC scheme).
.sp
If any of these are directories, then the file \fI.ntprc\fP
is searched for within those directories.
.SH USAGE
-The
-\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
-option specifies the write password and
-\f\*[B-Font]\-q\f[] \f\*[I-Font]password\f[]
-option the read password for previously encrypted files.
-The
-\f\*[B-Font]ntp-keygen\fP
-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
-no write password is specified, the read password is used
-as the write password by default.
.SH "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.SH "FILES"
Copyright (C) 1992-2017 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,
-from one to several minutes with modern architectures
-such as UltraSPARC and up to tens of minutes to an hour
-with older architectures such as SPARC IPC.
+It can take quite a while to generate some cryptographic values.
.sp \n(Ppu
.ne 2
-.Dd January 2 2017
+.Dd March 19 2017
.Dt NTP_KEYGEN 1ntp-keygenmdoc User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.mdoc)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:35 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:39 AM by AutoGen 5.18.5
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh DESCRIPTION
This program generates cryptographic data files used by the NTPv4
authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
-In addition, if the OpenSSL software library has been installed,
-it generates keys, certificate and identity files used in public key
-cryptography.
+It can generate message digest keys used in symmetric key cryptography and,
+if the OpenSSL software library has been installed, it can generate host keys,
+signing keys, certificates, and identity keys and parameters used in Autokey
+public key cryptography.
These files are used for cookie encryption,
-digital signature and challenge/response identification algorithms
+digital signature, and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
.Pp
-All files are in PEM\-encoded printable ASCII format,
-so they can be embedded as MIME attachments in mail to other sites
+The message digest symmetric keys file is generated in a format
+compatible with NTPv3.
+All other files are in PEM\-encoded printable ASCII format,
+so they can be embedded as MIME attachments in email to other sites
and certificate authorities.
By default, files are not encrypted.
.Pp
-When used to generate message digest keys, the program produces a file
-containing ten pseudo\-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+When used to generate message digest symmetric keys, the program
+produces a file containing ten pseudo\-random printable ASCII strings
+suitable for the MD5 message digest algorithm included in the
+distribution.
If the OpenSSL library is installed, it produces an additional ten
-hex\-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
-The message digest keys file must be distributed and stored
+hex\-encoded random bit strings suitable for SHA1, AES\-128\-CMAC, and
+other message digest algorithms.
+The message digest symmetric keys file must be distributed and stored
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
Some files used by this program are encrypted using a private password.
The
.Fl p
-option specifies the password for local encrypted files and the
+option specifies the read password for local encrypted files and the
.Fl q
-option the password for encrypted files sent to remote sites.
+option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-.Fn gethostname
-function, normally the DNS name of the host is used.
+.Xr hostname 1
+command, normally the DNS name of the host, is used as the the default read
+password, for convenience.
+The
+.Nm
+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
+no write password is specified, the read password is used
+as the write password by default.
.Pp
The
-.Ar pw
+.Cm pw
option of the
-.Ar crypto
+.Ic crypto
+.Xr ntpd 1ntpdmdoc
configuration command specifies the read
password for previously encrypted local files.
-This must match the local password used by this program.
+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 password,
+Thus, if files are generated by this program without an explicit password,
they can be read back by
-.Ar ntpd
-without password but only on the same host.
+.Xr ntpd 1ntpdmdoc
+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.
.Pp
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
-.Ar ntp.keys ,
+.Pa ntp.keys ,
is usually installed in
.Pa /etc .
Other files and links are usually installed in
.Pa /usr/local/etc ,
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
-.Ar keysdir
-configuration command in such cases.
-Normally, this is in
-.Pa /etc .
+In these cases, NFS clients can specify the files in another
+directory such as
+.Pa /etc
+using the
+.Ic keysdir
+.Xr ntpd 1ntpdmdoc
+configuration file command.
.Pp
This program directs commentary and error messages to the standard
error stream
-.Ar stderr
+.Pa stderr
and remote files to the standard output stream
-.Ar stdout
+.Pa stdout
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
-.Ar ntpkey
+.Pa ntpkey\&*
and include the file type, generating host and filestamp,
as described in the
-.Dq Cryptographic Data Files
+.Sx "Cryptographic Data Files"
section below.
.Ss Running the Program
-To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually
-.Pa /usr/local/etc
-When run for the first time, or if all files with names beginning with
-.Ar ntpkey
-have been removed, use the
-.Nm
-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
-existing keys and parameters and generates only a new certificate with
-new expiration date one year hence.
-.Pp
-Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using
-.Nm
-with the
-.Fl T
-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
-ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
-All group hosts should have acyclic certificate trails ending on the TH.
-.Pp
-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
-.Fl S
-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
-.Fl c
-option.
-The rules say cryptographic media should be generated with proventic
-filestamps, which means the host should already be synchronized before
-this program is run.
-This of course creates a chicken\-and\-egg problem
-when the host is started for the first time.
-Accordingly, the host time
-should be set by some other means, such as eyeball\-and\-wristwatch, at
-least so that the certificate lifetime is within the current year.
-After that and when the host is synchronized to a proventic source, the
-certificate should be re\-generated.
-.Pp
-Additional information on trusted groups and identity schemes is on the
-.Dq Autokey Public\-Key Authentication
-page.
-.Pp
-The
-.Xr ntpd 1ntpdmdoc
-configuration command
-.Ic crypto pw Ar password
-specifies the read password for previously encrypted files.
-The daemon expires on the spot if the password is missing
-or incorrect.
-For convenience, if a file has been previously encrypted,
-the default read password is the name of the host running
-the program.
-If the previous write password is specified as the host name,
-these files can be read by that host with no explicit password.
-.Pp
-File names begin with the prefix
-.Cm ntpkey_
-and end with the postfix
-.Ar _hostname.filestamp ,
-where
-.Ar hostname
-is the owner name, usually the string returned
-by the Unix gethostname() routine, and
-.Ar filestamp
-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
-.Ic rm ntpkey\&*
-command or all files generated
-at a specific time can be removed by a
-.Ic rm
-.Ar \&*filestamp
-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.
-.Pp
-All files are installed by default in the keys directory
-.Pa /usr/local/etc ,
-which is normally in a shared filesystem
-in NFS\-mounted networks.
-The actual location of the keys directory
-and each file can be overridden by configuration commands,
-but this is not recommended.
-Normally, the files for each host are generated by that host
-and used only by that host, although exceptions exist
-as noted later on this page.
-.Pp
-Normally, files containing private values,
-including the host key, sign key and identification parameters,
-are permitted root read/write\-only;
-while others containing public values are permitted world readable.
-Alternatively, files containing private values can be encrypted
-and these files permitted world readable,
-which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
-dependent clients can all be installed in the same shared directory.
-.Pp
-The recommended practice is to keep the file name extensions
-when installing a file and to install a soft link
-from the generic names specified elsewhere on this page
-to the generated files.
-This allows new file generations to be activated simply
-by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
-If a link is not present,
-.Xr ntpd 1ntpdmdoc
-extracts the filestamp from the file itself.
-This allows clients to verify that the file and generation times
-are always current.
-The
-.Nm
-program uses the same timestamp extension for all files generated
-at one time, so each generation is distinct and can be readily
-recognized in monitoring data.
-.Ss Running the program
The safest way to run the
.Nm
program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
+The recommended procedure is change to the
+.Ar keys
+directory, usually
.Pa /usr/local/etc ,
then run the program.
-When run for the first time,
-or if all
-.Cm ntpkey
-files have been removed,
-the program generates a RSA host key file and matching RSA\-MD5 certificate file,
+.Pp
+To test and gain experience with Autokey concepts, log in as root and
+change to the
+.Ar keys
+directory, usually
+.Pa /usr/local/etc .
+When run for the first time, or if all files with names beginning with
+.Pa ntpkey\&*
+have been removed, use the
+.Nm
+command without arguments to generate a default
+.Cm RSA
+host key and matching
+.Cm RSA\-MD5
+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
to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+If run again without options, the program uses the
+existing keys and parameters and generates a new certificate file with
+new expiration date one year hence, and soft link.
.Pp
-The host key is used to encrypt the cookie when required and so must be RSA type.
+The host key is used to encrypt the cookie when required and so must be
+.Cm RSA
+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 RSA or DSA type.
-By default, the message digest type is MD5, but any combination
+either
+.Cm RSA
+or
+.Cm DSA
+type.
+By default, the message digest type is
+.Cm MD5 ,
+but any combination
of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+can be specified, including those using the
+.Cm AES128CMAC , MD2 , MD5 , MDC2 , SHA , SHA1
+and
+.Cm RIPE160
+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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Certificates using any digest algorithm are compatible with
+.Cm RSA
+sign keys;
+however, only
+.Cm SHA
+and
+.Cm SHA1
+certificates are compatible with
+.Cm DSA
+sign keys.
.Pp
Private/public key files and certificates are compatible with
other OpenSSL applications and very likely other libraries as well.
as the other files, are probably not compatible with anything other than Autokey.
.Pp
Running the program as other than root and using the Unix
-.Ic su
+.Xr su 1
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-.Cm .rnd
+.Pa .rnd
in the user home directory.
However, there should be only one
-.Cm .rnd ,
+.Pa .rnd ,
most conveniently
in the root directory, so it is convenient to define the
-.Cm $RANDFILE
+.Ev RANDFILE
environment variable used by the OpenSSL library as the path to
-.Cm /.rnd .
+.Pa .rnd .
.Pp
Installing the keys as root might not work in NFS\-mounted
shared file systems, as NFS clients may not be able to write
.Pa /etc
using the
.Ic keysdir
-command.
+.Xr ntpd 1ntpdmdoc
+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
by the Autokey protocol.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
+Since uniqueness is insured by the
+.Ar hostname
+and
+.Ar filestamp
+file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
.Pp
The recommended practice is to keep the file name extensions
to the generated files.
This allows new file generations to be activated simply
by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+If a link is present,
+.Xr ntpd 1ntpdmdoc
+follows it to the file name to extract the
+.Ar filestamp .
If a link is not present,
.Xr ntpd 1ntpdmdoc
-extracts the filestamp from the file itself.
+extracts the
+.Ar filestamp
+from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
.Nm
-program uses the same timestamp extension for all files generated
+program uses the same
+.Ar filestamp
+extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-.Ss Running the program
-The safest way to run the
+.Pp
+Run the command on as many hosts as necessary.
+Designate one of them as the trusted host (TH) using
.Nm
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-.Pa /usr/local/etc ,
-then run the program.
-When run for the first time,
-or if all
-.Cm ntpkey
-files have been removed,
-the program generates a RSA host key file and matching RSA\-MD5 certificate file,
-which is all that is necessary in many cases.
-The program also generates soft links from the generic names
-to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+with the
+.Fl T
+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
+ascendant host towards the TH to sign its certificate, which is then
+provided to the immediately descendant host on request.
+All group hosts should have acyclic certificate trails ending on the TH.
.Pp
-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.
-When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
-By default, the message digest type is MD5, but any combination
-of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+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
+.Fl S
+option and this can be either
+.Cm RSA
+or
+.Cm DSA
+type.
+By default, the signature
+message digest type is
+.Cm MD5 ,
+but any combination of sign key type and
+message digest type supported by the OpenSSL library can be specified
+using the
+.Fl c
+option.
.Pp
-Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
-Certificates or certificate requests derived from them should be compatible
-with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
-However, the identification parameter files, although encoded
-as the other files, are probably not compatible with anything other than Autokey.
+The rules say cryptographic media should be generated with proventic
+filestamps, which means the host should already be synchronized before
+this program is run.
+This of course creates a chicken\-and\-egg problem
+when the host is started for the first time.
+Accordingly, the host time
+should be set by some other means, such as eyeball\-and\-wristwatch, at
+least so that the certificate lifetime is within the current year.
+After that and when the host is synchronized to a proventic source, the
+certificate should be re\-generated.
.Pp
-Running the program as other than root and using the Unix
-.Ic su
-command
-to assume root may not work properly, since by default the OpenSSL library
-looks for the random seed file
-.Cm .rnd
-in the user home directory.
-However, there should be only one
-.Cm .rnd ,
-most conveniently
-in the root directory, so it is convenient to define the
-.Cm $RANDFILE
-environment variable used by the OpenSSL library as the path to
-.Cm /.rnd .
+Additional information on trusted groups and identity schemes is on the
+.Dq Autokey Public\-Key Authentication
+page.
.Pp
-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
-.Pa /etc
-using the
-.Ic keysdir
+File names begin with the prefix
+.Pa ntpkey Ns _
+and end with the suffix
+.Pa _ Ns Ar hostname . Ar filestamp ,
+where
+.Ar hostname
+is the owner name, usually the string returned
+by the Unix
+.Xr hostname 1
+command, and
+.Ar filestamp
+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
+.Ic rm Pa ntpkey\&*
+command or all files generated
+at a specific time can be removed by a
+.Ic rm Pa \&* Ns Ar filestamp
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
-by the Autokey protocol.
-.Pp
-Ordinarily, cryptographic files are generated by the host that uses them,
-but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
-The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
-It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
-The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
-seconds.
-seconds.
-s Trusted Hosts and Groups
+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.
+.Ss Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
.Sx Authentication Options
section of
.Xr ntp.conf 5 .
-The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+The default cryptotype uses
+.Cm RSA
+encryption,
+.Cm MD5
+message digest
+and
+.Cm TC
+identification.
First, configure a NTP subnet including one or more low\-stratum
trusted hosts from which all other hosts derive synchronization
directly or indirectly.
.Pp
On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-.Cm ntpkey
+.Pa ntpkey
files.
Then run
.Nm
.Cm RSA
or
.Cm DSA .
-The most often need to do this is when a DSA\-signed certificate is used.
+The most frequent need to do this is when a
+.Cm DSA Ns \-signed
+certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
.Nm
option and selected
.Ar scheme
as needed.
-f
+If
.Nm
is run again without these options, it generates a new certificate
-using the same scheme and sign key.
+using the same scheme and sign key, and soft link.
.Pp
After setting up the environment it is advisable to update certificates
from time to time, if only to extend the validity interval.
Simply run
.Nm
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys, and soft links.
However, if the host or sign key is changed,
.Xr ntpd 1ntpdmdoc
should be restarted.
at which time the protocol is restarted.
.Ss Identity Schemes
As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default
+.Cm TC
+identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
-including PC, IFF, GQ and MV described on the
-.Qq Identification Schemes
-page
-(maybe available at
-.Li http://www.eecis.udel.edu/%7emills/keygen.html ) .
+including
+.Cm PC , IFF , GQ
+and
+.Cm MV
+schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
.Fl P
.Fl p Ar password
to generate the host key file
-.Pa ntpkey_RSAkey_ Ns Ar alice.filestamp
+.Pa ntpkey Ns _ Cm RSA Pa key_alice. Ar filestamp
and trusted private certificate file
-.Pa ntpkey_RSA\-MD5_cert_ Ns Ar alice.filestamp .
+.Pa ntpkey Ns _ Cm RSA\-MD5 _ Pa cert_alice. Ar filestamp ,
+and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
-On each host bob install a soft link from the generic name
+On each host
+.Ar bob
+install a soft link from the generic name
.Pa ntpkey_host_ Ns Ar bob
to the host key file and soft link
.Pa ntpkey_cert_ Ns Ar bob
by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
-to all other hosts in the group.
+to all other hosts in the group, and recreating the soft links.
.Pp
-For the IFF scheme proceed as in the TC scheme to generate keys
+For the
+.Cm IFF
+scheme proceed as in the
+.Cm TC
+scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the
+.Cm IFF
+parameter file.
On trusted host alice run
.Nm
.Fl T
.Fl I
.Fl p Ar password
to produce her parameter file
-.Pa ntpkey_IFFpar_ Ns Ar alice.filestamp ,
+.Pa ntpkey_IFFpar_alice. Ns Ar filestamp ,
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
-.Pa ntpkey_iff_ Ns Ar alice
+.Pa ntpkey_iff_alice
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
-As the IFF scheme is independent
+As the
+.Cm IFF
+scheme is independent
of keys and certificates, these files can be refreshed as needed.
.Pp
If a rogue client has the parameter file, it could masquerade
After generating the parameter file, on alice run
.Nm
.Fl e
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+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
-.Pa ntpkey_iff_ Ns Ar alice
+.Pa ntpkey_iff_alice
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
.Pp
-For the GQ scheme proceed as in the TC scheme to generate keys
+For the
+.Cm GQ
+scheme proceed as in the
+.Cm TC
+scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the
+.Cm IFF
+parameter file.
On trusted host alice run
.Nm
.Fl T
.Fl G
.Fl p Ar password
to produce her parameter file
-.Pa ntpkey_GQpar_ Ns Ar alice.filestamp ,
+.Pa ntpkey_GQpar_alice. Ns Ar filestamp ,
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-.Pa ntpkey_gq_ Ns Ar alice
+.Pa ntpkey_gq_alice
to this file.
-In addition, on each host bob install a soft link
+In addition, on each host
+.Ar bob
+install a soft link
from generic
.Pa ntpkey_gq_ Ns Ar bob
to this file.
-As the GQ scheme updates the GQ parameters file and certificate
+As the
+.Cm GQ
+scheme updates the
+.Cm GQ
+parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
.Pp
-For the MV scheme, proceed as in the TC scheme to generate keys
+For the
+.Cm MV
+scheme, proceed as in the
+.Cm TC
+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.
.Ar n
is the number of revokable keys (typically 5) to produce
the parameter file
-.Pa ntpkeys_MVpar_ Ns Ar trish.filestamp
+.Pa ntpkeys_MVpar_trish. Ns Ar filestamp
and client key files
-.Pa ntpkeys_MVkeyd_ Ns Ar trish.filestamp
+.Pa ntpkeys_MVkey Ns Ar d _ Pa trish. Ar filestamp
where
.Ar d
is the key number (0 \&<
.Ar n ) .
Copy the parameter file to alice and install a soft link
from the generic
-.Pa ntpkey_mv_ Ns Ar alice
+.Pa ntpkey_mv_alice
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
-It doesn't matter which client key file goes to alice,
+It does not matter which client key file goes to alice,
since they all work the same way.
-Alice copies the client key file to all of her cliens.
+Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-.Pa ntpkey_mvkey_ Ns Ar bob
+.Pa ntpkey_mvkey_bob
to the client key file.
-As the MV scheme is independent of keys and certificates,
+As the
+.Cm MV
+scheme is independent of keys and certificates,
these files can be refreshed as needed.
.Ss Command Line Options
.Bl -tag -width indent
-.It Fl c Ar scheme
-Select certificate message digest/signature encryption scheme.
+.It Fl b Fl \-imbits Ns = Ar modulus
+Set the number of bits in the identity modulus for generating identity keys to
+.Ar modulus
+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.
+.It Fl c Fl \-certificate Ns = Ar scheme
+Select certificate signature encryption/message digest scheme.
The
.Ar scheme
can be one of the following:
-. Cm RSA\-MD2 , RSA\-MD5 , RSA\-SHA , RSA\-SHA1 , RSA\-MDC2 , RSA\-RIPEMD160 , DSA\-SHA ,
+.Cm RSA\-MD2 , RSA\-MD5 , RSA\-MDC2 , RSA\-SHA , RSA\-SHA1 , RSA\-RIPEMD160 , DSA\-SHA ,
or
.Cm DSA\-SHA1 .
-Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+Note that
+.Cm RSA
+schemes must be used with an
+.Cm RSA
+sign key and
+.Cm DSA
+schemes must be used with a
+.Cm DSA
+sign key.
The default without this option is
.Cm RSA\-MD5 .
-.It Fl d
-Enable debugging.
+If compatibility with FIPS 140\-2 is required, either the
+.Cm DSA\-SHA
+or
+.Cm DSA\-SHA1
+scheme must be used.
+.It Fl C Fl \-cipher Ns = Ar cipher
+Select the OpenSSL cipher to encrypt the files containing private keys.
+The default without this option is three\-key triple DES in CBC mode,
+.Cm des\-ede3\-cbc .
+The
+.Ic openssl Fl h
+command provided with OpenSSL displays available ciphers.
+.It Fl d Fl \-debug\-level
+Increase debugging verbosity level.
This option displays the cryptographic data produced in eye\-friendly billboards.
-.It Fl e
-Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
-.It Fl G
-Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
-.It Fl g
-Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
-.It Fl H
-Generate new host keys, obsoleting any that may exist.
-.It Fl I
-Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
-.It Fl i Ar name
-Set the suject name to
-.Ar name .
-This is used as the subject field in certificates
-and in the file name for host and sign keys.
-.It Fl M
-Generate MD5 keys, obsoleting any that may exist.
-.It Fl P
-Generate a private certificate.
+.It Fl D Fl \-set\-debug\-level Ns = Ar level
+Set the debugging verbosity to
+.Ar level .
+This option displays the cryptographic data produced in eye\-friendly billboards.
+.It Fl e Fl \-id\-key
+Write the
+.Cm IFF
+or
+.Cm GQ
+public parameters from the
+.Ar IFFkey or GQkey
+client keys file previously specified
+as unencrypted data to the standard output stream
+.Pa stdout .
+This is intended for automatic key distribution by email.
+.It Fl G Fl \-gq\-params
+Generate a new encrypted
+.Cm GQ
+parameters and key file for the Guillou\-Quisquater (GQ) identity scheme.
+This option is mutually exclusive with the
+.Fl I
+and
+.Fl V
+options.
+.It Fl H Fl \-host\-key
+Generate a new encrypted
+.Cm RSA
+public/private host key file.
+.It Fl I Fl \-iffkey
+Generate a new encrypted
+.Cm IFF
+key file for the Schnorr (IFF) identity scheme.
+This option is mutually exclusive with the
+.Fl G
+and
+Fl V
+options.
+.It Fl i Fl \-ident Ns = Ar group
+Set the optional Autokey group name to
+.Ar group .
+This is used in the identity scheme parameter file names of
+.Cm IFF , GQ ,
+and
+.Cm MV
+client parameters files.
+In that role, the default is the host name if no group is provided.
+The group name, if specified using
+.Fl i
+or
+.Fl s
+following an
+.Ql @
+character, is also used in certificate subject and issuer names in the form
+.Ar host @ group
+and should match the group specified via
+.Ic crypto Cm ident
+or
+.Ic server Cm ident
+in the ntpd configuration file.
+.It Fl l Fl \-lifetime Ns = Ar days
+Set the lifetime for certificate expiration to
+.Ar days .
+The default lifetime is one year (365 days).
+.It Fl m Fl \-modulus Ns = Ar bits
+Set the number of bits in the prime modulus for generating files to
+.Ar bits .
+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.
+.It Fl M Fl \-md5key
+Generate a new symmetric keys file containing 10
+.Cm MD5
+keys, and if OpenSSL is available, 10
+.Cm SHA
+keys.
+An
+.Cm MD5
+key is a string of 20 random printable ASCII characters, while a
+.Cm SHA
+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.
+.It Fl p Fl \-password Ns = Ar passwd
+Set the password for reading and writing encrypted files to
+.Ar passwd .
+These include the host, sign and identify key files.
+By default, the password is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl P Fl \-pvt\-cert
+Generate a new private certificate used by the
+.Cm PC
+identity scheme.
By default, the program generates public certificates.
-.It Fl p Ar password
-Encrypt generated files containing private data with
-.Ar password
-and the DES\-CBC algorithm.
-.It Fl q
-Set the password for reading files to password.
-.It Fl S Oo Cm RSA | DSA Oc
-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.
-.It Fl s Ar name
-Set the issuer name to
-.Ar name .
-This is used for the issuer field in certificates
-and in the file name for identity files.
-.It Fl T
+Note: the PC identity scheme is not recommended for new installations.
+.It Fl q Fl \-export\-passwd Ns = Ar passwd
+Set the password for writing encrypted
+.Cm IFF , GQ and MV
+identity files redirected to
+.Pa stdout
+to
+.Ar passwd .
+In effect, these files are decrypted with the
+.Fl p
+password, then encrypted with the
+.Fl q
+password.
+By default, the password is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl s Fl \-subject\-key Ns = Ar Oo host Oc Op @ Ar group
+Specify the Autokey host name, where
+.Ar host
+is the optional host name and
+.Ar group
+is the optional group name.
+The host name, and if provided, group name are used in
+.Ar host @ group
+form as certificate subject and issuer.
+Specifying
+.Fl s @ Ar group
+is allowed, and results in leaving the host name unchanged, as with
+.Fl i Ar group .
+The group name, or if no group is provided, the host name are also used in the
+file names of
+.Cm IFF , GQ ,
+and
+.Cm MV
+identity scheme client parameter files.
+If
+.Ar host
+is not specified, the default host name is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl S Fl \-sign\-key Ns = Op Cm RSA | DSA
+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
+.Cm DSA .
+.It Fl T Fl \-trusted\-cert
Generate a trusted certificate.
By default, the program generates a non\-trusted certificate.
-.It Fl V Ar nkeys
-Generate parameters and keys for the Mu\-Varadharajan (MV) identification scheme.
+.It Fl V Fl \-mv\-params Ar nkeys
+Generate
+.Ar nkeys
+encrypted server keys and parameters for the Mu\-Varadharajan (MV)
+identity scheme.
+This option is mutually exclusive with the
+.Fl I
+and
+.Fl G
+options.
+Note: support for this option should be considered a work in progress.
.El
.Ss Random Seed File
All cryptographically sound key generation schemes must have means
.Pp
The entropy seed used by the OpenSSL library is contained in a file,
usually called
-.Cm .rnd ,
+.Pa .rnd ,
which must be available when starting the NTP daemon
or the
.Nm
program.
The NTP daemon will first look for the file
using the path specified by the
-.Ic randfile
+.Cm randfile
subcommand of the
.Ic crypto
configuration command.
.Ev RANDFILE
environment variable is not present,
the library will look for the
-.Cm .rnd
+.Pa .rnd
file in the user home directory.
+Since both the
+.Nm
+program and
+.Xr ntpd 1ntpdmdoc
+daemon must run as root, the logical place to put this file is in
+.Pa /.rnd
+or
+.Pa /root/.rnd .
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.
.Ss Cryptographic Data Files
-All other file formats begin with two lines.
-The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
-Lines beginning with # are considered comments and ignored by the
+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
+.Pa ntpkey_ Ns Ar key _ Ar name . Ar filestamp ,
+where
+.Ar key
+is the key or parameter type,
+.Ar name
+is the host or group name and
+.Ar filestamp
+is the filestamp (NTP seconds) when the file was created.
+By convention,
+.Ar key
+names in generated file names include both upper and lower case
+characters, while
+.Ar key
+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
+.Pa date
+format.
+Lines beginning with
+.Ql #
+are considered comments and ignored by the
.Nm
program and
.Xr ntpd 1ntpdmdoc
daemon.
-Cryptographic values are encoded first using ASN.1 rules,
-then encrypted if necessary, and finally written PEM\-encoded
-printable ASCII format preceded and followed by MIME content identifier lines.
.Pp
-The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
-Since DES\-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
-Following hte heard the keys are
-entered one per line in the format
-.D1 Ar keyno type key
+The remainder of the file contains cryptographic data, encoded first using ASN.1
+rules, then encrypted if necessary, and finally written in PEM\-encoded
+printable ASCII text, preceded and followed by MIME content identifier lines.
+.Pp
+The format of the symmetric keys file, ordinarily named
+.Pa ntp.keys ,
+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.
+.Bd -literal -unfilled -offset center
+# ntpkey_MD5key_bk.ntp.org.3595864945
+# Thu Dec 12 19:22:25 2013
+1 MD5 L";Nw<\`.I<f4U0)247"i # MD5 key
+2 MD5 &>l0%XXK9O'51VwV<xq~ # MD5 key
+3 MD5 lb4zLW~d^!K:]RsD'qb6 # MD5 key
+4 MD5 Yue:tL[+vR)M\`n~bY,'? # MD5 key
+5 MD5 B;fx'Kgr/&4ZTbL6=RxA # MD5 key
+6 MD5 4eYwa\`o}3i@@V@..R9!l # MD5 key
+7 MD5 \`A.([h+;wTQ|xfi%Sn_! # MD5 key
+8 MD5 45:V,r4]l6y^JH6"Sh?F # MD5 key
+9 MD5 3\-5vcn*6l29DS?Xdsg)* # MD5 key
+10 MD5 2late4Me # MD5 key
+11 SHA1 a27872d3030a9025b8446c751b4551a7629af65c # SHA1 key
+12 SHA1 21bc3b4865dbb9e920902abdccb3e04ff97a5e74 # SHA1 key
+13 SHA1 2b7736fe24fef5ba85ae11594132ab5d6f6daba9 # SHA1 key
+14 SHA a5332809c8878dd3a5b918819108a111509aeceb # SHA key
+15 MD2 2fe16c88c760ff2f16d4267e36c1aa6c926e6964 # MD2 key
+16 MD4 b2691811dc19cfc0e2f9bcacd74213f29812183d # MD4 key
+17 MD5 e4d6735b8bdad58ec5ffcb087300a17f7fef1f7c # MD5 key
+18 MDC2 a8d5e2315c025bf3a79174c87fbd10477de2eabc # MDC2 key
+19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
+20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
+.Ed
+.D1 Figure 1. Typical Symmetric Key File
+.Pp
+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
+.D1 Ar keyno Ar type Ar key
where
.Ar keyno
-is a positive integer in the range 1\-65,535,
+is a positive integer in the range 1\-65534;
.Ar type
-is the string MD5 defining the key format and
+is the key type for the message digest algorithm, which in the absence of the
+OpenSSL library must be
+.Cm MD5
+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
+.Cm SHA
+or
+.Cm SHA1 ;
.Ar key
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
-Each character is chosen from the 93 printable characters
-in the range 0x21 through 0x7f excluding space and the
+which is a printable ASCII string 20 characters or less in length:
+each character is chosen from the 93 printable characters
+in the range 0x21 through 0x7e (
+.Ql !
+through
+.Ql ~
+\&) excluding space and the
+.Ql #
+character, and terminated by whitespace or a
.Ql #
character.
+An OpenSSL key consists of a hex\-encoded ASCII string of 40 characters, which
+is truncated as necessary.
.Pp
Note that the keys used by the
.Xr ntpq 1ntpqmdoc
.Pp
The
.Nm
-program generates a MD5 symmetric keys file
-.Pa ntpkey_MD5key_ Ns Ar hostname.filestamp .
+program generates a symmetric keys file
+.Pa ntpkey_MD5key_ Ns Ar hostname Ns . Ns Ar filestamp .
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
certificate scheme.
.sp
scheme is one of
-RSA\-MD2, RSA\-MD5, RSA\-SHA, RSA\-SHA1, RSA\-MDC2, RSA\-RIPEMD160,
+RSA\-MD2, RSA\-MD5, RSA\-MDC2, RSA\-SHA, RSA\-SHA1, RSA\-RIPEMD160,
DSA\-SHA, or DSA\-SHA1.
.sp
-Select the certificate message digest/signature encryption scheme.
+Select the certificate signature encryption/message digest scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
this option is RSA\-MD5.
.sp
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". The openssl tool lists ciphers
+equivalent to "\fB\-C des\-ede3\-cbc\fP". The openssl tool lists ciphers
available in "\fBopenssl \-h\fP" output.
.It Fl d , Fl \-debug\-level
Increase debug verbosity level.
.It Fl e , Fl \-id\-key
Write IFF or GQ identity keys.
.sp
-Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
+Write the public parameters from the IFF or GQ client keys to
+the standard output.
+This is intended for automatic key distribution by email.
.It Fl G , Fl \-gq\-params
Generate GQ parameters and keys.
.sp
that role, the default is the host name if this option is not
provided. The group name, if specified using \fB\-i/\-\-ident\fP or
using \fB\-s/\-\-subject\-name\fP following an '\fB@\fP' character,
-is also a part of the self\-signed host certificate's subject and
+is also a part of the self\-signed host certificate subject and
issuer names in the form \fBhost@group\fP and should match the
-\'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in
-\fBntpd\fP's configuration file.
+\'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in the
+\fBntpd\fP configuration file.
.It Fl l Ar lifetime , Fl \-lifetime Ns = Ns Ar lifetime
set certificate lifetime.
This option takes an integer number as its argument.
.sp
Set the certificate expiration to lifetime days from now.
-.It Fl M , Fl \-md5key
-generate MD5 keys.
-.sp
-Generate MD5 keys, obsoleting any that may exist.
.It Fl m Ar modulus , Fl \-modulus Ns = Ns Ar modulus
-modulus.
+prime modulus.
This option takes an integer number as its argument.
The value of
.Ar modulus
.in -4
.sp
The number of bits in the prime modulus. The default is 512.
+.It Fl M , Fl \-md5key
+generate symmetric keys.
+.sp
+Generate symmetric keys, obsoleting any that may exist.
.It Fl P , Fl \-pvt\-cert
generate PC private certificate.
.sp
The same password must be specified to the remote ntpd via the
"crypto pw password" configuration command. See also the option
-\-id\-key (\-e) for unencrypted exports.
-.It Fl S Ar sign , Fl \-sign\-key Ns = Ns Ar sign
-generate sign key (RSA or DSA).
-.sp
-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.
.It Fl s Ar host@group , Fl \-subject\-name Ns = Ns Ar host@group
set host and optionally group name.
.sp
following an '\fB@\fP' 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 \fBhost@group\fP form for the host certificate's subject and issuer
+in \fBhost@group\fP form for the host certificate subject and issuer
fields. Specifying '\fB\-s @group\fP' is allowed, and results in
leaving the host name unchanged while appending \fB@group\fP to the
subject and issuer fields, as with \fB\-i group\fP. 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.
+.It Fl S Ar sign , Fl \-sign\-key Ns = Ns Ar sign
+generate sign key (RSA or DSA).
+.sp
+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.
.It Fl T , Fl \-trusted\-cert
trusted certificate (TC scheme).
.sp
If any of these are directories, then the file \fI.ntprc\fP
is searched for within those directories.
.Sh USAGE
-The
-.Fl p Ar password
-option specifies the write password and
-.Fl q Ar password
-option the read password for previously encrypted files.
-The
-.Nm
-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
-no write password is specified, the read password is used
-as the write password by default.
.Sh "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.Sh "FILES"
Copyright (C) 1992\-2017 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,
-from one to several minutes with modern architectures
-such as UltraSPARC and up to tens of minutes to an hour
-with older architectures such as SPARC IPC.
+It can take quite a while to generate some cryptographic values.
.Pp
Please report bugs to http://bugs.ntp.org .
.Pp
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<html lang="en">
<head>
-<title>Ntp-keygen User’s Manual</title>
-
-<meta name="description" content="Ntp-keygen User’s Manual">
-<meta name="keywords" content="Ntp-keygen User’s Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<link href="#Top" rel="start" title="Top">
-<link href="dir.html#Top" rel="up" title="(dir)">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
-div.example {margin-left: 3.2em}
-div.indentedblock {margin-left: 3.2em}
-div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
-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.nocodebreak {white-space:nowrap}
-span.nolinebreak {white-space:nowrap}
-span.roman {font-family:serif; font-weight:normal}
-span.sansserif {font-family:sans-serif; font-weight:normal}
-ul.no-bullet {list-style: none}
--->
-</style>
-
-
+<title>Ntp-keygen User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Ntp-keygen User's Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
-<h1 class="settitle" align="center">Ntp-keygen User’s Manual</h1>
-
-
+<body>
+<h1 class="settitle">Ntp-keygen User's Manual</h1>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Top</a>
+<a href="#Top">NTP Key Generation Program User Manual</a>
+</ul>
+</div>
-<a name="SEC_Overview"></a>
-<h2 class="shortcontents-heading">Short Table of Contents</h2>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<div class="shortcontents">
-<ul class="no-bullet">
-<li><a name="stoc-Description-1" href="#toc-Description-1">1 Description</a></li>
-</ul>
</div>
+<h2 class="unnumbered">Top</h2>
-<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>
+<ul class="menu">
+<li><a accesskey="1" href="#Description">Description</a>
+<li><a accesskey="2" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>: Invoking ntp-keygen
+<li><a accesskey="3" href="#Running-the-Program">Running the Program</a>
+<li><a accesskey="4" href="#Random-Seed-File">Random Seed File</a>
+<li><a accesskey="5" href="#Cryptographic-Data-Files">Cryptographic Data Files</a>
+</ul>
+<div class="node">
<a name="Top"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Description">Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
</div>
-<a name="NTP-Key-Generation-Program-User-Manual"></a>
-<h1 class="top">NTP Key Generation Program User Manual</h1>
-<p>This document describes the use of the NTP Project’s <code>ntp-keygen</code>
+<h2 class="unnumbered">NTP Key Generation Program User Manual</h2>
+
+<p>This document describes the use of the NTP Project's <code>ntp-keygen</code>
program, that generates cryptographic data files used by the NTPv4
-authentication and identity schemes.
+authentication and identity schemes.
It can generate message digest keys used in symmetric key cryptography and,
if the OpenSSL software
library has been installed, it can generate host keys, sign keys,
certificates, and identity keys and parameters used by the Autokey
-public key cryptography.
+public key cryptography.
The message digest keys file is generated in a
-format compatible with NTPv3.
+format compatible with NTPv3.
All other files are in PEM-encoded
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.8p9-win of <code>ntp-keygen</code>.
-</p>
-<hr>
+
+ <p>This document applies to version 4.2.8p9 of <code>ntp-keygen</code>.
+
+<div class="node">
<a name="Description"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Running-the-Program">Running the Program</a>,
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Description-1"></a>
-<h2 class="chapter">1 Description</h2>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
<p>This program generates cryptographic data files used by the NTPv4
authentication and identity schemes. It can generate message digest
format compatible with NTPv3. All other files are in PEM-encoded
printable ASCII format so they can be embedded as MIME attachments in
mail to other sites.
-</p>
-<p>When used to generate message digest keys, the program produces a file
+
+
<p>When used to generate message digest keys, the program produces a file
containing ten pseudo-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+MD5 message digest algorithm included in the distribution.
If the
OpenSSL library is installed, it produces an additional ten hex-encoded
random bit strings suitable for the SHA1 and other message digest
-algorithms.
+algorithms.
The message digest keys file must be distributed and stored
-using secure means beyond the scope of NTP itself.
+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 ntpq and ntpdc utility programs.
-</p>
-<p>The remaining generated files are compatible with other OpenSSL
-applications and other Public Key Infrastructure (PKI) resources.
+
+
<p>The remaining generated files are compatible with other OpenSSL
+applications and other Public Key Infrastructure (PKI) resources.
Certificates generated by this program are compatible with extant
industry practice, although some users might find the interpretation of
-X509v3 extension fields somewhat liberal.
+X509v3 extension fields somewhat liberal.
However, the identity keys
are probably not compatible with anything other than Autokey.
-</p>
-<p>Some files used by this program are encrypted using a private password.
+
+ <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.
+<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.
-</p>
-<p>The <kbd>pw</kbd> option of the <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>The <kbd>pw</kbd> option of the <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.
Thus, if files are generated by this program without password,
they can be read back by ntpd without password, but only on the same
host.
-</p>
-<p>Normally, encrypted files for each host are generated by that host and
+
+
<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.
+this page.
The symmetric keys file, normally called <code>ntp.keys</code>, is
-usually installed in <code>/etc</code>.
+usually installed in <code>/etc</code>.
Other files and links are usually installed
in <code>/usr/local/etc</code>, which is normally in a shared filesystem in
-NFS-mounted networks and cannot be changed by shared clients.
+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.
+configuration command in such cases.
Normally, this is in <code>/etc</code>.
-</p>
-<p>This program directs commentary and error messages to the standard
+
+
<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
-files.
+files.
The names used for generated files and links all begin with the
string <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>
-<hr>
+
+<div class="node">
<a name="Running-the-Program"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Random-Seed-File">Random Seed File</a>,
+Previous: <a rel="previous" accesskey="p" href="#Description">Description</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Running-the-Program-1"></a>
-<h3 class="section">1.1 Running the Program</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Running the Program</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>/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
default RSA host key and matching RSA-MD5 certificate with expiration
-date one year hence.
+date one year hence.
If run again without options, the program uses the
existing keys and parameters and generates only a new certificate with
new expiration date one year hence.
-</p>
-<p>Run the command on as many hosts as necessary.
+
+ <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
-it to synchronize from reliable Internet servers.
-Then configure the other hosts to synchronize to the TH directly or indirectly.
+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
ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
+provided to the immediately descendant host on request.
All group hosts should have acyclic certificate trails ending on the TH.
-</p>
-<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.
+
+
<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
-and this can be either RSA or DSA type.
+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.
-</p>
-<p>The rules say cryptographic media should be generated with proventic
+
+
<p>The rules say cryptographic media should be generated with proventic
filestamps, which means the host should already be synchronized before
-this program is run.
+this program is run.
This of course creates a chicken-and-egg problem
-when the host is started for the first time.
+when the host is started for the first time.
Accordingly, the host time
should be set by some other means, such as eyeball-and-wristwatch, at
-least so that the certificate lifetime is within the current year.
+least so that the certificate lifetime is within the current year.
After that and when the host is synchronized to a proventic source, the
certificate should be re-generated.
-</p>
-<p>Additional information on trusted groups and identity schemes is on the
+
+
<p>Additional information on trusted groups and identity schemes is on the
Autokey Public-Key Authentication page.
-</p>
-<hr>
+
+<div class="node">
+<a name="ntp-keygen-Invocation"></a>
<a name="ntp_002dkeygen-Invocation"></a>
-<div class="header">
-<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>
+<p><hr>
+
+
</div>
-<a name="Invoking-ntp_002dkeygen"></a>
-<h3 class="section">1.2 Invoking ntp-keygen</h3>
-<a name="index-ntp_002dkeygen"></a>
-<a name="index-Create-a-NTP-host-key"></a>
+<h3 class="section">Invoking ntp-keygen</h3>
+<p><a name="index-ntp_002dkeygen-1"></a><a name="index-Create-a-NTP-host-key-2"></a>
-<p>This program generates cryptographic data files used by the NTPv4
-authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
+
<p>This program generates cryptographic data files used by the NTPv4
+authentication and identification schemes.
+It generates MD5 key files used in symmetric key cryptography.
In addition, if the OpenSSL software library has been installed,
it generates keys, certificate and identity files used in public key
-cryptography.
+cryptography.
These files are used for cookie encryption,
digital signature and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
-</p>
-<p>All files are in PEM-encoded printable ASCII format,
+
+
<p>All files are in PEM-encoded printable ASCII format,
so they can be embedded as MIME attachments in mail to other sites
-and certificate authorities.
+and certificate authorities.
By default, files are not encrypted.
-</p>
-<p>When used to generate message digest keys, the program produces a file
+
+
<p>When used to generate message digest keys, the program produces a file
containing ten pseudo-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+MD5 message digest algorithm included in the distribution.
If the OpenSSL library is installed, it produces an additional ten
hex-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
+digest algorithms.
The message digest keys file must be distributed and stored
-using secure means beyond the scope of NTP itself.
+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>
and
<code>ntpdc(1ntpdcmdoc)</code>
utility programs.
-</p>
-<p>The remaining generated files are compatible with other OpenSSL
-applications and other Public Key Infrastructure (PKI) resources.
+
+
<p>The remaining generated files are compatible with other OpenSSL
+applications and other Public Key Infrastructure (PKI) resources.
Certificates generated by this program are compatible with extant
industry practice, although some users might find the interpretation of
-X509v3 extension fields somewhat liberal.
+X509v3 extension fields somewhat liberal.
However, the identity keys are probably not compatible with anything
other than Autokey.
-</p>
-<p>Some files used by this program are encrypted using a private password.
+
+ <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.
+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.
-</p>
-<p>The
+
<kbd>pw</kbd>
option of the
<kbd>crypto</kbd>
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.
+password for previously encrypted local files.
+This must match the local password used by this program.
+If not specified, the host name is used.
Thus, if files are generated by this program without password,
they can be read back by
<kbd>ntpd</kbd>
without password but only on the same host.
-</p>
-<p>Normally, encrypted files for each host are generated by that host and
+
+
<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.
+this page.
The symmetric keys file, normally called
<kbd>ntp.keys</kbd>,
is usually installed in
-<samp>/etc</samp>.
+<samp><span class="file">/etc</span></samp>.
Other files and links are usually installed in
-<samp>/usr/local/etc</samp>,
+<samp><span class="file">/usr/local/etc</span></samp>,
which is normally in a shared filesystem in
-NFS-mounted networks and cannot be changed by shared clients.
+NFS-mounted networks and cannot be changed by shared clients.
The location of the keys directory can be changed by the
<kbd>keysdir</kbd>
-configuration command in such cases.
+configuration command in such cases.
Normally, this is in
-<samp>/etc</samp>.
-</p>
-<p>This program directs commentary and error messages to the standard
+<samp><span class="file">/etc</span></samp>.
+
+
<p>This program directs commentary and error messages to the standard
error stream
<kbd>stderr</kbd>
and remote files to the standard output stream
<kbd>stdout</kbd>
-where they can be piped to other applications or redirected to files.
+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
<kbd>ntpkey</kbd>
as described in the
“Cryptographic Data Files”
section below.
-</p><a name="Running-the-Program-2"></a>
-<h4 class="subsection">1.2.1 Running the Program</h4>
+
+<h5 class="subsubsection">Running the Program</h5>
+
<p>To test and gain experience with Autokey concepts, log in as root and
change to the keys directory, usually
-<samp>/usr/local/etc</samp>
+<samp><span class="file">/usr/local/etc</span></samp>
When run for the first time, or if all files with names beginning with
<kbd>ntpkey</kbd>
have been removed, use the
<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.
+date one year hence.
If run again without options, the program uses the
existing keys and parameters and generates only a new certificate with
new expiration date one year hence.
-</p>
-<p>Run the command on as many hosts as necessary.
+
+ <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 it to synchronize from reliable Internet servers.
+option and configure it to synchronize from reliable Internet servers.
Then configure the other hosts to synchronize to the TH directly or
-indirectly.
+indirectly.
A certificate trail is created when Autokey asks the immediately
ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
+provided to the immediately descendant host on request.
All group hosts should have acyclic certificate trails ending on the TH.
-</p>
-<p>The host key is used to encrypt the cookie when required and so must be
-RSA type.
+
+
<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.
+signatures.
A different sign key can be assigned using the
<code>-S</code>
-option and this can be either RSA or DSA type.
+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.
+option.
The rules say cryptographic media should be generated with proventic
filestamps, which means the host should already be synchronized before
-this program is run.
+this program is run.
This of course creates a chicken-and-egg problem
-when the host is started for the first time.
+when the host is started for the first time.
Accordingly, the host time
should be set by some other means, such as eyeball-and-wristwatch, at
-least so that the certificate lifetime is within the current year.
+least so that the certificate lifetime is within the current year.
After that and when the host is synchronized to a proventic source, the
certificate should be re-generated.
-</p>
-<p>Additional information on trusted groups and identity schemes is on the
+
+
<p>Additional information on trusted groups and identity schemes is on the
“Autokey Public-Key Authentication”
page.
-</p>
-
-<p>The
+ <p>The
<code>ntpd(1ntpdmdoc)</code>
configuration command
<code>crypto</code> <code>pw</code> <kbd>password</kbd>
-specifies the read password for previously encrypted files.
+specifies the read password for previously encrypted files.
The daemon expires on the spot if the password is missing
-or incorrect.
+or incorrect.
For convenience, if a file has been previously encrypted,
the default read password is the name of the host running
-the program.
+the program.
If the previous write password is specified as the host name,
these files can be read by that host with no explicit password.
-</p>
-<p>File names begin with the prefix
+
<p>File names begin with the prefix
<code>ntpkey_</code>
and end with the postfix
<kbd>_hostname.filestamp</kbd>,
is the owner name, usually the string returned
by the Unix gethostname() routine, and
<kbd>filestamp</kbd>
-is the NTP seconds when the file was generated, in decimal digits.
+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
at a specific time can be removed by a
<code>rm</code>
<kbd>*filestamp</kbd>
-command.
+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>
-<p>All files are installed by default in the keys directory
-<samp>/usr/local/etc</samp>,
+
+
<p>All files are installed by default in the keys directory
+<samp><span class="file">/usr/local/etc</span></samp>,
which is normally in a shared filesystem
-in NFS-mounted networks.
+in NFS-mounted networks.
The actual location of the keys directory
and each file can be overridden by configuration commands,
-but this is not recommended.
+but this is not recommended.
Normally, the files for each host are generated by that host
and used only by that host, although exceptions exist
as noted later on this page.
-</p>
-<p>Normally, files containing private values,
+
+
<p>Normally, files containing private values,
including the host key, sign key and identification parameters,
are permitted root read/write-only;
-while others containing public values are permitted world readable.
+while others containing public values are permitted world readable.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
-which simplifies maintenance in shared file systems.
+which simplifies maintenance in shared file systems.
Since uniqueness is insured by the hostname and
file name extensions, the files for a NFS server and
dependent clients can all be installed in the same shared directory.
-</p>
-<p>The recommended practice is to keep the file name extensions
+
+
<p>The recommended practice is to keep the file name extensions
when installing a file and to install a soft link
from the generic names specified elsewhere on this page
-to the generated files.
+to the generated files.
This allows new file generations to be activated simply
-by changing the link.
+by changing the link.
If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+to extract the filestamp.
If a link is not present,
<code>ntpd(1ntpdmdoc)</code>
-extracts the filestamp from the file itself.
+extracts the filestamp from the file itself.
This allows clients to verify that the file and generation times
-are always current.
+are always current.
The
<code>ntp-keygen</code>
program uses the same timestamp extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-</p><a name="Running-the-program"></a>
-<h4 class="subsubsection">1.2.1.1 Running the program</h4>
+
+<h5 class="subsubsection">Running the program</h5>
+
<p>The safest way to run the
<code>ntp-keygen</code>
-program is logged in directly as root.
+program is logged in directly as root.
The recommended procedure is change to the keys directory,
usually
-<samp>/usr/local/etc</samp>,
-then run the program.
+<samp><span class="file">/usr/local/etc</span></samp>,
+then run the program.
When run for the first time,
or if all
<code>ntpkey</code>
files have been removed,
the program generates a RSA host key file and matching RSA-MD5 certificate file,
-which is all that is necessary in many cases.
+which is all that is necessary in many cases.
The program also generates soft links from the generic names
-to the respective files.
+to the respective files.
If run again, the program uses the same host key file,
but generates a new certificate file and link.
-</p>
-<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.
+
+ <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.
When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
+either RSA or DSA type.
By default, the message digest type is MD5, but any combination
of sign key type and message digest type supported by the OpenSSL library
can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+and RIPE160 message digest algorithms.
However, the scheme specified in the certificate must be compatible
-with the sign key.
+with the sign key.
Certificates using any digest algorithm are compatible with RSA sign keys;
however, only SHA and SHA1 certificates are compatible with DSA sign keys.
-</p>
-<p>Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
+
+
<p>Private/public key files and certificates are compatible with
+other OpenSSL applications and very likely other libraries as well.
Certificates or certificate requests derived from them should be compatible
with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
+the interpretation of X509v3 extension fields somewhat liberal.
However, the identification parameter files, although encoded
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
+
+
<p>Running the program as other than root and using the Unix
<code>su</code>
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
<code>.rnd</code>
-in the user home directory.
+in the user home directory.
However, there should be only one
<code>.rnd</code>,
most conveniently
<code>$RANDFILE</code>
environment variable used by the OpenSSL library as the path to
<code>/.rnd</code>.
-</p>
-<p>Installing the keys as root might not work in NFS-mounted
+
+
<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.
+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><span class="file">/etc</span></samp>
using the
<code>keysdir</code>
-command.
+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
by the Autokey protocol.
-</p>
-<p>Ordinarily, cryptographic files are generated by the host that uses them,
+
+
<p>Ordinarily, cryptographic files are generated by the host that uses them,
but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
+for other hosts; however, in such cases files should always be encrypted.
The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
+of the host generating the files, but can be changed by command line options.
It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
+as the subject and issuer fields, respectively, of the certificate.
The owner name is also used for the host and sign key files,
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>,
+
<p>All files are installed by default in the keys directory
+<samp><span class="file">/usr/local/etc</span></samp>,
which is normally in a shared filesystem
-in NFS-mounted networks.
+in NFS-mounted networks.
The actual location of the keys directory
and each file can be overridden by configuration commands,
-but this is not recommended.
+but this is not recommended.
Normally, the files for each host are generated by that host
and used only by that host, although exceptions exist
as noted later on this page.
-</p>
-<p>Normally, files containing private values,
+
+
<p>Normally, files containing private values,
including the host key, sign key and identification parameters,
are permitted root read/write-only;
-while others containing public values are permitted world readable.
+while others containing public values are permitted world readable.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
-which simplifies maintenance in shared file systems.
+which simplifies maintenance in shared file systems.
Since uniqueness is insured by the hostname and
file name extensions, the files for a NFS server and
dependent clients can all be installed in the same shared directory.
-</p>
-<p>The recommended practice is to keep the file name extensions
+
+
<p>The recommended practice is to keep the file name extensions
when installing a file and to install a soft link
from the generic names specified elsewhere on this page
-to the generated files.
+to the generated files.
This allows new file generations to be activated simply
-by changing the link.
+by changing the link.
If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+to extract the filestamp.
If a link is not present,
<code>ntpd(1ntpdmdoc)</code>
-extracts the filestamp from the file itself.
+extracts the filestamp from the file itself.
This allows clients to verify that the file and generation times
-are always current.
+are always current.
The
<code>ntp-keygen</code>
program uses the same timestamp extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-</p><a name="Running-the-program-1"></a>
-<h4 class="subsubsection">1.2.1.2 Running the program</h4>
+
+<h5 class="subsubsection">Running the program</h5>
+
<p>The safest way to run the
<code>ntp-keygen</code>
-program is logged in directly as root.
+program is logged in directly as root.
The recommended procedure is change to the keys directory,
usually
-<samp>/usr/local/etc</samp>,
-then run the program.
+<samp><span class="file">/usr/local/etc</span></samp>,
+then run the program.
When run for the first time,
or if all
<code>ntpkey</code>
files have been removed,
the program generates a RSA host key file and matching RSA-MD5 certificate file,
-which is all that is necessary in many cases.
+which is all that is necessary in many cases.
The program also generates soft links from the generic names
-to the respective files.
+to the respective files.
If run again, the program uses the same host key file,
but generates a new certificate file and link.
-</p>
-<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.
+
+ <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.
When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
+either RSA or DSA type.
By default, the message digest type is MD5, but any combination
of sign key type and message digest type supported by the OpenSSL library
can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+and RIPE160 message digest algorithms.
However, the scheme specified in the certificate must be compatible
-with the sign key.
+with the sign key.
Certificates using any digest algorithm are compatible with RSA sign keys;
however, only SHA and SHA1 certificates are compatible with DSA sign keys.
-</p>
-<p>Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
+
+
<p>Private/public key files and certificates are compatible with
+other OpenSSL applications and very likely other libraries as well.
Certificates or certificate requests derived from them should be compatible
with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
+the interpretation of X509v3 extension fields somewhat liberal.
However, the identification parameter files, although encoded
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
+
+
<p>Running the program as other than root and using the Unix
<code>su</code>
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
<code>.rnd</code>
-in the user home directory.
+in the user home directory.
However, there should be only one
<code>.rnd</code>,
most conveniently
<code>$RANDFILE</code>
environment variable used by the OpenSSL library as the path to
<code>/.rnd</code>.
-</p>
-<p>Installing the keys as root might not work in NFS-mounted
+
+
<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.
+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><span class="file">/etc</span></samp>
using the
<code>keysdir</code>
-command.
+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
by the Autokey protocol.
-</p>
-<p>Ordinarily, cryptographic files are generated by the host that uses them,
+
+
<p>Ordinarily, cryptographic files are generated by the host that uses them,
but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
+for other hosts; however, in such cases files should always be encrypted.
The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
+of the host generating the files, but can be changed by command line options.
It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
+as the subject and issuer fields, respectively, of the certificate.
The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
+while the trusted name is used for the identity files.
+seconds.
seconds.
-seconds.
-</p>
-<p>s Trusted Hosts and Groups
+
+ <p>s Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
-‘Authentication Options’
+<a href="#Authentication-Options">Authentication Options</a>
section of
-<code>ntp.conf(5)</code>.
+<code>ntp.conf(5)</code>.
The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+and TC identification.
First, configure a NTP subnet including one or more low-stratum
trusted hosts from which all other hosts derive synchronization
-directly or indirectly.
+directly or indirectly.
Trusted hosts have trusted certificates;
-all other hosts have nontrusted certificates.
+all other hosts have nontrusted certificates.
These hosts will automatically and dynamically build authoritative
-certificate trails to one or more trusted hosts.
+certificate trails to one or more trusted hosts.
A trusted group is the set of all hosts that have, directly or indirectly,
-a certificate trail ending at a trusted host.
+a certificate trail ending at a trusted host.
The trail is defined by static configuration file entries
or dynamic means described on the
-‘Automatic NTP Configuration Options’
+<a href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a>
section of
<code>ntp.conf(5)</code>.
-</p>
-<p>On each trusted host as root, change to the keys directory.
+
+ <p>On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
<code>ntpkey</code>
-files.
+files.
Then run
<code>ntp-keygen</code>
<code>-T</code>
-to generate keys and a trusted certificate.
+to generate keys and a trusted certificate.
On all other hosts do the same, but leave off the
<code>-T</code>
-flag to generate keys and nontrusted certificates.
+flag to generate keys and nontrusted certificates.
When complete, start the NTP daemons beginning at the lowest stratum
-and working up the tree.
+and working up the tree.
It may take some time for Autokey to instantiate the certificate trails
throughout the subnet, but setting up the environment is completely automatic.
-</p>
-<p>If it is necessary to use a different sign key or different digest/signature
+
+
<p>If it is necessary to use a different sign key or different digest/signature
scheme than the default, run
<code>ntp-keygen</code>
with the
is either
<code>RSA</code>
or
-<code>DSA</code>.
-The most often need to do this is when a DSA-signed certificate is used.
+<code>DSA</code>.
+The most often need to do this is when a DSA-signed certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
<code>ntp-keygen</code>
<code>-c</code> <kbd>scheme</kbd>
option and selected
<kbd>scheme</kbd>
-as needed.
+as needed.
f
<code>ntp-keygen</code>
is run again without these options, it generates a new certificate
using the same scheme and sign key.
-</p>
-<p>After setting up the environment it is advisable to update certificates
-from time to time, if only to extend the validity interval.
+
+
<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>
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys.
However, if the host or sign key is changed,
<code>ntpd(1ntpdmdoc)</code>
-should be restarted.
+should be restarted.
When
<code>ntpd(1ntpdmdoc)</code>
-is restarted, it loads any new files and restarts the protocol.
+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><a name="Identity-Schemes"></a>
-<h4 class="subsubsection">1.2.1.3 Identity Schemes</h4>
+
+<h5 class="subsubsection">Identity Schemes</h5>
+
<p>As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default TC identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
including PC, IFF, GQ and MV described on the
-"Identification Schemes"
+"Identification Schemes"
page
(maybe available at
-<code>http://www.eecis.udel.edu/%7emills/keygen.html</code>).
+<code>http://www.eecis.udel.edu/%7emills/keygen.html</code>).
These schemes are based on a TA, one or more trusted hosts
-and some number of nontrusted hosts.
+and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
while the remaining hosts prove identity using values provided
-by a trusted host and certificate trails that end on that host.
+by a trusted host and certificate trails that end on that host.
The name of a trusted host is also the name of its sugroup
-and also the subject and issuer name on its trusted certificate.
+and also the subject and issuer name on its trusted certificate.
The TA is not necessarily a trusted host in this sense, but often is.
-</p>
-<p>In some schemes there are separate keys for servers and clients.
+
+ <p>In some schemes there are separate keys for servers and clients.
A server can also be a client of another server,
-but a client can never be a server for another client.
+but a client can never be a server for another client.
In general, trusted hosts and nontrusted hosts that operate
as both server and client have parameter files that contain
-both server and client keys.
+both server and client keys.
Hosts that operate
only as clients have key files that contain only client keys.
-</p>
-<p>The PC scheme supports only one trusted host in the group.
+
+ <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>
to generate the host key file
-<samp>ntpkey_RSAkey_</samp><kbd>alice.filestamp</kbd>
+<samp><span class="file">ntpkey_RSAkey_</span></samp><kbd>alice.filestamp</kbd>
and trusted private certificate file
-<samp>ntpkey_RSA-MD5_cert_</samp><kbd>alice.filestamp</kbd>.
+<samp><span class="file">ntpkey_RSA-MD5_cert_</span></samp><kbd>alice.filestamp</kbd>.
Copy both files to all group hosts;
-they replace the files which would be generated in other schemes.
+they replace the files which would be generated in other schemes.
On each host bob install a soft link from the generic name
-<samp>ntpkey_host_</samp><kbd>bob</kbd>
+<samp><span class="file">ntpkey_host_</span></samp><kbd>bob</kbd>
to the host key file and soft link
-<samp>ntpkey_cert_</samp><kbd>bob</kbd>
-to the private certificate file.
+<samp><span class="file">ntpkey_cert_</span></samp><kbd>bob</kbd>
+to the private certificate file.
Note the generic links are on bob, but point to files generated
-by trusted host alice.
+by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
to all other hosts in the group.
-</p>
-<p>For the IFF scheme proceed as in the TC scheme to generate keys
+
+
<p>For the IFF scheme proceed as in the TC scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the IFF parameter file.
On trusted host alice run
<code>ntp-keygen</code>
<code>-T</code>
<code>-I</code>
<code>-p</code> <kbd>password</kbd>
to produce her parameter file
-<samp>ntpkey_IFFpar_</samp><kbd>alice.filestamp</kbd>,
-which includes both server and client keys.
+<samp><span class="file">ntpkey_IFFpar_</span></samp><kbd>alice.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_</samp><kbd>alice</kbd>
-to this file.
+<samp><span class="file">ntpkey_iff_</span></samp><kbd>alice</kbd>
+to this file.
If there are no hosts restricted to operate only as clients,
-there is nothing further to do.
+there is nothing further to do.
As the IFF scheme is independent
of keys and certificates, these files can be refreshed as needed.
-</p>
-<p>If a rogue client has the parameter file, it could masquerade
-as a legitimate server and present a middleman threat.
+
+
<p>If a rogue client has the parameter file, it could masquerade
+as a legitimate server and present a middleman threat.
To eliminate this threat, the client keys can be extracted
-from the parameter file and distributed to all restricted clients.
+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>
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+and pipe the output to a file or mail program.
+Copy or mail this file to all restricted clients.
On these clients install a soft link from the generic
-<samp>ntpkey_iff_</samp><kbd>alice</kbd>
-to this file.
+<samp><span class="file">ntpkey_iff_</span></samp><kbd>alice</kbd>
+to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
-</p>
-<p>For the GQ scheme proceed as in the TC scheme to generate keys
+
+
<p>For the GQ scheme proceed as in the TC scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the IFF parameter file.
On trusted host alice run
<code>ntp-keygen</code>
<code>-T</code>
<code>-G</code>
<code>-p</code> <kbd>password</kbd>
to produce her parameter file
-<samp>ntpkey_GQpar_</samp><kbd>alice.filestamp</kbd>,
-which includes both server and client keys.
+<samp><span class="file">ntpkey_GQpar_</span></samp><kbd>alice.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_</samp><kbd>alice</kbd>
-to this file.
+<samp><span class="file">ntpkey_gq_</span></samp><kbd>alice</kbd>
+to this file.
In addition, on each host bob install a soft link
from generic
-<samp>ntpkey_gq_</samp><kbd>bob</kbd>
-to this file.
+<samp><span class="file">ntpkey_gq_</span></samp><kbd>bob</kbd>
+to this file.
As the GQ scheme updates the GQ parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
-</p>
-<p>For the MV scheme, proceed as in the TC scheme to generate keys
-and certificates for all group hosts.
+
+
<p>For the MV scheme, proceed as in the TC 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.
+and bob one of her clients.
On TA trish run
<code>ntp-keygen</code>
<code>-V</code> <kbd>n</kbd>
<kbd>n</kbd>
is the number of revokable keys (typically 5) to produce
the parameter file
-<samp>ntpkeys_MVpar_</samp><kbd>trish.filestamp</kbd>
+<samp><span class="file">ntpkeys_MVpar_</span></samp><kbd>trish.filestamp</kbd>
and client key files
-<samp>ntpkeys_MVkeyd_</samp><kbd>trish.filestamp</kbd>
+<samp><span class="file">ntpkeys_MVkeyd_</span></samp><kbd>trish.filestamp</kbd>
where
<kbd>d</kbd>
is the key number (0 <
<kbd>d</kbd>
<
-<kbd>n</kbd>).
+<kbd>n</kbd>).
Copy the parameter file to alice and install a soft link
from the generic
-<samp>ntpkey_mv_</samp><kbd>alice</kbd>
-to this file.
+<samp><span class="file">ntpkey_mv_</span></samp><kbd>alice</kbd>
+to this file.
Copy one of the client key files to alice for later distribution
-to her clients.
-It doesn’t matter which client key file goes to alice,
-since they all work the same way.
-Alice copies the client key file to all of her cliens.
+to her clients.
+It doesn't matter which client key file goes to alice,
+since they all work the same way.
+Alice copies the client key file to all of her cliens.
On client bob install a soft link from generic
-<samp>ntpkey_mvkey_</samp><kbd>bob</kbd>
-to the client key file.
+<samp><span class="file">ntpkey_mvkey_</span></samp><kbd>bob</kbd>
+to the client key file.
As the MV scheme is independent of keys and certificates,
these files can be refreshed as needed.
-</p><a name="Command-Line-Options"></a>
-<h4 class="subsubsection">1.2.1.4 Command Line Options</h4>
-<dl compact="compact">
-<dt><code>-c</code> <kbd>scheme</kbd></dt>
-<dd><p>Select certificate message digest/signature encryption scheme.
+
+<h5 class="subsubsection">Command Line Options</h5>
+
+ <dl>
+<dt><code>-c</code> <kbd>scheme</kbd><dd>Select certificate message digest/signature encryption scheme.
The
<kbd>scheme</kbd>
can be one of the following:
. Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA ,
or
-<code>DSA-SHA1</code>.
+<code>DSA-SHA1</code>.
Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+schemes must be used with a DSA sign key.
The default without this option is
-<code>RSA-MD5</code>.
-</p></dd>
-<dt><code>-d</code></dt>
-<dd><p>Enable debugging.
-This option displays the cryptographic data produced in eye-friendly billboards.
-</p></dd>
-<dt><code>-e</code></dt>
-<dd><p>Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
-</p></dd>
-<dt><code>-G</code></dt>
-<dd><p>Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
-</p></dd>
-<dt><code>-g</code></dt>
-<dd><p>Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
-</p></dd>
-<dt><code>-H</code></dt>
-<dd><p>Generate new host keys, obsoleting any that may exist.
-</p></dd>
-<dt><code>-I</code></dt>
-<dd><p>Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
-</p></dd>
-<dt><code>-i</code> <kbd>name</kbd></dt>
-<dd><p>Set the suject name to
-<kbd>name</kbd>.
+<code>RSA-MD5</code>.
+<br><dt><code>-d</code><dd>Enable debugging.
+This option displays the cryptographic data produced in eye-friendly billboards.
+<br><dt><code>-e</code><dd>Write the IFF client keys to the standard output.
+This is intended for automatic key distribution by mail.
+<br><dt><code>-G</code><dd>Generate parameters and keys for the GQ identification scheme,
+obsoleting any that may exist.
+<br><dt><code>-g</code><dd>Generate keys for the GQ identification scheme
+using the existing GQ parameters.
+If the GQ parameters do not yet exist, create them first.
+<br><dt><code>-H</code><dd>Generate new host keys, obsoleting any that may exist.
+<br><dt><code>-I</code><dd>Generate parameters for the IFF identification scheme,
+obsoleting any that may exist.
+<br><dt><code>-i</code> <kbd>name</kbd><dd>Set the suject name to
+<kbd>name</kbd>.
This is used as the subject field in certificates
-and in the file name for host and sign keys.
-</p></dd>
-<dt><code>-M</code></dt>
-<dd><p>Generate MD5 keys, obsoleting any that may exist.
-</p></dd>
-<dt><code>-P</code></dt>
-<dd><p>Generate a private certificate.
-By default, the program generates public certificates.
-</p></dd>
-<dt><code>-p</code> <kbd>password</kbd></dt>
-<dd><p>Encrypt generated files containing private data with
+and in the file name for host and sign keys.
+<br><dt><code>-M</code><dd>Generate MD5 keys, obsoleting any that may exist.
+<br><dt><code>-P</code><dd>Generate a private certificate.
+By default, the program generates public certificates.
+<br><dt><code>-p</code> <kbd>password</kbd><dd>Encrypt generated files containing private data with
<kbd>password</kbd>
-and the DES-CBC algorithm.
-</p></dd>
-<dt><code>-q</code></dt>
-<dd><p>Set the password for reading files to password.
-</p></dd>
-<dt><code>-S</code> <code>[<code>RSA</code> | <code>DSA</code>]</code></dt>
-<dd><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></dd>
-<dt><code>-s</code> <kbd>name</kbd></dt>
-<dd><p>Set the issuer name to
-<kbd>name</kbd>.
+and the DES-CBC algorithm.
+<br><dt><code>-q</code><dd>Set the password for reading files to password.
+<br><dt><code>-S</code> <code>[RSA | DSA]</code><dd>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.
+<br><dt><code>-s</code> <kbd>name</kbd><dd>Set the issuer name to
+<kbd>name</kbd>.
This is used for the issuer field in certificates
-and in the file name for identity files.
-</p></dd>
-<dt><code>-T</code></dt>
-<dd><p>Generate a trusted certificate.
-By default, the program generates a non-trusted certificate.
-</p></dd>
-<dt><code>-V</code> <kbd>nkeys</kbd></dt>
-<dd><p>Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme.
-</p></dd>
+and in the file name for identity files.
+<br><dt><code>-T</code><dd>Generate a trusted certificate.
+By default, the program generates a non-trusted certificate.
+<br><dt><code>-V</code> <kbd>nkeys</kbd><dd>Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme.
</dl>
-<a name="Random-Seed-File-1"></a>
-<h4 class="subsubsection">1.2.1.5 Random Seed File</h4>
+
+<h5 class="subsubsection">Random Seed File</h5>
+
<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.
+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>
-program.
+program.
If a site supports OpenSSL or its companion OpenSSH,
it is very likely that means to do this are already available.
-</p>
-<p>It is important to understand that entropy must be evolved
+
+
<p>It is important to understand that entropy must be evolved
for each generation, for otherwise the random number sequence
-would be predictable.
+would be predictable.
Various means dependent on external events, such as keystroke intervals,
-can be used to do this and some systems have built-in entropy sources.
+can be used to do this and some systems have built-in entropy sources.
Suitable means are described in the OpenSSL software documentation,
but are outside the scope of this page.
-</p>
-<p>The entropy seed used by the OpenSSL library is contained in a file,
+
+
<p>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 NTP daemon
or the
<code>ntp-keygen</code>
-program.
+program.
The NTP daemon will first look for the file
using the path specified by the
<code>randfile</code>
subcommand of the
<code>crypto</code>
-configuration command.
+configuration command.
If not specified in this way, or when starting the
<code>ntp-keygen</code>
program,
by the
.Ev RANDFILE
environment variable in the user home directory,
-whether root or some other user.
+whether root or some other user.
If the
.Ev RANDFILE
environment variable is not present,
the library will look for the
<code>.rnd</code>
-file in the user home directory.
+file in the user home directory.
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><a name="Cryptographic-Data-Files-1"></a>
-<h4 class="subsubsection">1.2.1.6 Cryptographic Data Files</h4>
-<p>All other file formats begin with two lines.
+
+<h5 class="subsubsection">Cryptographic Data Files</h5>
+
+<p>All other file formats begin with two lines.
The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
+and filestamp.
+The second contains the datestamp in conventional Unix date format.
Lines beginning with # are considered comments and ignored by the
<code>ntp-keygen</code>
program and
<code>ntpd(1ntpdmdoc)</code>
-daemon.
+daemon.
Cryptographic values are encoded first using ASN.1 rules,
then encrypted if necessary, and finally written PEM-encoded
printable ASCII format preceded and followed by MIME content identifier lines.
-</p>
-<p>The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
+
+
<p>The format of the symmetric keys file is somewhat different
+than the other files in the interest of backward compatibility.
Since DES-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
+is MD5 alphanumeric strings.
Following hte heard 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></div>
-<p>where
+<pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd>
+</pre>
+ <p>where
<kbd>keyno</kbd>
is a positive integer in the range 1-65,535,
<kbd>type</kbd>
is the string MD5 defining the key format and
<kbd>key</kbd>
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
+which is a printable ASCII string 16 characters or less in length.
Each character is chosen from the 93 printable characters
in the range 0x21 through 0x7f excluding space and the
‘#’
character.
-</p>
-<p>Note that the keys used by the
+
+
<p>Note that the keys used by the
<code>ntpq(1ntpqmdoc)</code>
and
<code>ntpdc(1ntpdcmdoc)</code>
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
-<samp>ntpkey_MD5key_</samp><kbd>hostname.filestamp</kbd>.
+<samp><span class="file">ntpkey_MD5key_</span></samp><kbd>hostname.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.
+to other subnet hosts.
The NTP daemon loads the file
-<samp>ntp.keys</samp>,
+<samp><span class="file">ntp.keys</span></samp>,
so
<code>ntp-keygen</code>
-installs a soft link from this name to the generated file.
+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.
+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
and
<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>AutoGen</strong>,
+using the <code>agtexi-cmd</code> template and the option descriptions for the <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-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-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-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-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-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-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>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002dkeygen-usage">ntp-keygen usage</a>: ntp-keygen help/usage (<samp><span class="option">--help</span></samp>)
+<li><a accesskey="2" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>: imbits option (-b)
+<li><a accesskey="3" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>: certificate option (-c)
+<li><a accesskey="4" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>: cipher option (-C)
+<li><a accesskey="5" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>: id-key option (-e)
+<li><a accesskey="6" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>: gq-params option (-G)
+<li><a accesskey="7" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>: host-key option (-H)
+<li><a accesskey="8" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>: iffkey option (-I)
+<li><a accesskey="9" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>: ident option (-i)
+<li><a href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>: lifetime option (-l)
+<li><a href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>: md5key option (-M)
+<li><a href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>: modulus option (-m)
+<li><a href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>: pvt-cert option (-P)
+<li><a href="#ntp_002dkeygen-password">ntp-keygen password</a>: password option (-p)
+<li><a href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>: export-passwd option (-q)
+<li><a href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>: sign-key option (-S)
+<li><a href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>: subject-name option (-s)
+<li><a href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>: trusted-cert option (-T)
+<li><a href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>: mv-params option (-V)
+<li><a href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>: mv-keys option (-v)
+<li><a href="#ntp_002dkeygen-config">ntp-keygen config</a>: presetting/configuring ntp-keygen
+<li><a href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>: exit status
+<li><a href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>: Usage
+<li><a href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>: Notes
+<li><a href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a>: Bugs
+</ul>
+
+<div class="node">
+<a name="ntp-keygen-usage"></a>
<a name="ntp_002dkeygen-usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ntp_002dkeygen-help_002fusage-_0028_002d_002dhelp_0029"></a>
-<h4 class="subsection">1.2.2 ntp-keygen help/usage (<samp>--help</samp>)</h4>
-<a name="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
-the usage text by passing it through a pager program.
+
+<h4 class="subsection">ntp-keygen help/usage (<samp><span class="option">--help</span></samp>)</h4>
+
+<p><a name="index-ntp_002dkeygen-help-3"></a>
+This is the automatically generated usage text for ntp-keygen.
+
+
<p>The text printed is the same whether selected with the <code>help</code> option
+(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <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
+used to select the program, defaulting to <samp><span class="file">more</span></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.8p9
Usage: ntp-keygen [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
Flg Arg Option-Name Description
- examining environment variables named NTP_KEYGEN_*
Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org>
-</pre></div>
-
-<hr>
+</pre>
+ <div class="node">
+<a name="ntp-keygen-imbits"></a>
<a name="ntp_002dkeygen-imbits"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-usage">ntp-keygen usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="imbits-option-_0028_002db_0029"></a>
-<h4 class="subsection">1.2.3 imbits option (-b)</h4>
-<a name="index-ntp_002dkeygen_002dimbits"></a>
-
-<p>This is the “identity modulus bits” option.
-This option takes a number argument <samp>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.
-</li></ul>
-
-<p>The number of bits in the identity modulus. The default is 256.
-</p><hr>
+
+<h4 class="subsection">imbits option (-b)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dimbits-4"></a>
+This is the “identity modulus bits” option.
+This option takes a number argument <samp><span class="file">imbits</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>The number of bits in the identity modulus. The default is 256.
+<div class="node">
+<a name="ntp-keygen-certificate"></a>
<a name="ntp_002dkeygen-certificate"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="certificate-option-_0028_002dc_0029"></a>
-<h4 class="subsection">1.2.4 certificate option (-c)</h4>
-<a name="index-ntp_002dkeygen_002dcertificate"></a>
-
-<p>This is the “certificate scheme” option.
-This option takes a string argument <samp>scheme</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>scheme is one of
+
+<h4 class="subsection">certificate option (-c)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dcertificate-5"></a>
+This is the “certificate scheme” option.
+This option takes a string argument <samp><span class="file">scheme</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160,
DSA-SHA, or DSA-SHA1.
-</p>
-<p>Select the certificate message digest/signature encryption scheme.
+
+ <p>Select the certificate message digest/signature encryption scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
-this option is RSA-MD5.
-</p><hr>
+this option is RSA-MD5.
+<div class="node">
+<a name="ntp-keygen-cipher"></a>
<a name="ntp_002dkeygen-cipher"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="cipher-option-_0028_002dC_0029"></a>
-<h4 class="subsection">1.2.5 cipher option (-C)</h4>
-<a name="index-ntp_002dkeygen_002dcipher"></a>
-
-<p>This is the “privatekey cipher” option.
-This option takes a string argument <samp>cipher</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Select the cipher which is used to encrypt the files containing
+
+<h4 class="subsection">cipher option (-C)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dcipher-6"></a>
+This is the “privatekey cipher” option.
+This option takes a string argument <samp><span class="file">cipher</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</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". The openssl tool lists ciphers
-available in "<code>openssl -h</code>" output.
-</code></p><hr>
+equivalent to "<code>-C des-ede3-cbc". The openssl tool lists ciphers
+available in "openssl -h" output.
+</code><div class="node">
+<a name="ntp-keygen-id-key"></a>
<a name="ntp_002dkeygen-id_002dkey"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="id_002dkey-option-_0028_002de_0029"></a>
-<h4 class="subsection">1.2.6 id-key option (-e)</h4>
-<a name="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.
-</li></ul>
-
-<p>Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
-</p><hr>
+
+<h4 class="subsection">id-key option (-e)</h4>
+
+<p><a name="index-ntp_002dkeygen_002did_002dkey-7"></a>
+This is the “write iff or gq identity keys” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Write the IFF or GQ client keys to the standard output. This is
+intended for automatic key distribution by mail.
+<div class="node">
+<a name="ntp-keygen-gq-params"></a>
<a name="ntp_002dkeygen-gq_002dparams"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="gq_002dparams-option-_0028_002dG_0029"></a>
-<h4 class="subsection">1.2.7 gq-params option (-G)</h4>
-<a name="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.
-</li></ul>
-
-<p>Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
-</p><hr>
+
+<h4 class="subsection">gq-params option (-G)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dgq_002dparams-8"></a>
+This is the “generate gq parameters and keys” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate parameters and keys for the GQ identification scheme,
+obsoleting any that may exist.
+<div class="node">
+<a name="ntp-keygen-host-key"></a>
<a name="ntp_002dkeygen-host_002dkey"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="host_002dkey-option-_0028_002dH_0029"></a>
-<h4 class="subsection">1.2.8 host-key option (-H)</h4>
-<a name="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.
-</li></ul>
-
-<p>Generate new host keys, obsoleting any that may exist.
-</p><hr>
+
+<h4 class="subsection">host-key option (-H)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dhost_002dkey-9"></a>
+This is the “generate rsa host key” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate new host keys, obsoleting any that may exist.
+<div class="node">
+<a name="ntp-keygen-iffkey"></a>
<a name="ntp_002dkeygen-iffkey"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="iffkey-option-_0028_002dI_0029"></a>
-<h4 class="subsection">1.2.9 iffkey option (-I)</h4>
-<a name="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.
-</li></ul>
-
-<p>Generate parameters for the IFF identification scheme, obsoleting
-any that may exist.
-</p><hr>
+
+<h4 class="subsection">iffkey option (-I)</h4>
+
+<p><a name="index-ntp_002dkeygen_002diffkey-10"></a>
+This is the “generate iff parameters” option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate parameters for the IFF identification scheme, obsoleting
+any that may exist.
+<div class="node">
+<a name="ntp-keygen-ident"></a>
<a name="ntp_002dkeygen-ident"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ident-option-_0028_002di_0029"></a>
-<h4 class="subsection">1.2.10 ident option (-i)</h4>
-<a name="index-ntp_002dkeygen_002dident"></a>
-
-<p>This is the “set autokey group name” option.
-This option takes a string argument <samp>group</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Set the optional Autokey group name to name. This is used in
+
+<h4 class="subsection">ident option (-i)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dident-11"></a>
+This is the “set autokey group name” option.
+This option takes a string argument <samp><span class="file">group</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</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>}' character,
+using <code>-s/--subject-name</code> following an '<code>}' character,
is also a part of the self-signed host certificate's subject and
-issuer names in the form <code>host</code></code></p><p>’<code>crypto ident</code>’ or ’<code>server ident</code>’ configuration in
-<code>ntpd</code>’s configuration file.
-</p><hr>
+issuer names in the form host
+ <p>'crypto ident' or 'server ident' configuration in
+ntpd's configuration file.
+</code><div class="node">
+<a name="ntp-keygen-lifetime"></a>
<a name="ntp_002dkeygen-lifetime"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-md5key" accesskey="n" rel="next">ntp-keygen md5key</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="lifetime-option-_0028_002dl_0029"></a>
-<h4 class="subsection">1.2.11 lifetime option (-l)</h4>
-<a name="index-ntp_002dkeygen_002dlifetime"></a>
-
-<p>This is the “set certificate lifetime” option.
-This option takes a number argument <samp>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.
-</li></ul>
-
-<p>Set the certificate expiration to lifetime days from now.
-</p><hr>
+
+<h4 class="subsection">lifetime option (-l)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dlifetime-12"></a>
+This is the ``set certificate lifetime'' option.
+This option takes a number argument <samp><span class="file">lifetime</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Set the certificate expiration to lifetime days from now.
+<div class="node">
+<a name="ntp-keygen-md5key"></a>
<a name="ntp_002dkeygen-md5key"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-modulus" accesskey="n" rel="next">ntp-keygen modulus</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="md5key-option-_0028_002dM_0029"></a>
-<h4 class="subsection">1.2.12 md5key option (-M)</h4>
-<a name="index-ntp_002dkeygen_002dmd5key"></a>
-<p>This is the “generate md5 keys” option.
-Generate MD5 keys, obsoleting any that may exist.
-</p><hr>
+<h4 class="subsection">md5key option (-M)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dmd5key-13"></a>
+This is the ``generate md5 keys'' option.
+Generate MD5 keys, obsoleting any that may exist.
+<div class="node">
+<a name="ntp-keygen-modulus"></a>
<a name="ntp_002dkeygen-modulus"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-pvt_002dcert" accesskey="n" rel="next">ntp-keygen pvt-cert</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="modulus-option-_0028_002dm_0029"></a>
-<h4 class="subsection">1.2.13 modulus option (-m)</h4>
-<a name="index-ntp_002dkeygen_002dmodulus"></a>
-
-<p>This is the “modulus” option.
-This option takes a number argument <samp>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.
-</li></ul>
-
-<p>The number of bits in the prime modulus. The default is 512.
-</p><hr>
+
+<h4 class="subsection">modulus option (-m)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dmodulus-14"></a>
+This is the ``modulus'' option.
+This option takes a number argument <samp><span class="file">modulus</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>The number of bits in the prime modulus. The default is 512.
+<div class="node">
+<a name="ntp-keygen-pvt-cert"></a>
<a name="ntp_002dkeygen-pvt_002dcert"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-password" accesskey="n" rel="next">ntp-keygen password</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-password">ntp-keygen password</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="pvt_002dcert-option-_0028_002dP_0029"></a>
-<h4 class="subsection">1.2.14 pvt-cert option (-P)</h4>
-<a name="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.
-</li></ul>
-
-<p>Generate a private certificate. By default, the program generates
-public certificates.
-</p><hr>
+
+<h4 class="subsection">pvt-cert option (-P)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dpvt_002dcert-15"></a>
+This is the ``generate pc private certificate'' option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate a private certificate. By default, the program generates
+public certificates.
+<div class="node">
+<a name="ntp-keygen-password"></a>
<a name="ntp_002dkeygen-password"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="password-option-_0028_002dp_0029"></a>
-<h4 class="subsection">1.2.15 password option (-p)</h4>
-<a name="index-ntp_002dkeygen_002dpassword"></a>
-
-<p>This is the “local private password” option.
-This option takes a string argument <samp>passwd</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Local files containing private data are encrypted with the
+
+<h4 class="subsection">password option (-p)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dpassword-16"></a>
+This is the ``local private password'' option.
+This option takes a string argument <samp><span class="file">passwd</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+
<p>Local files containing private data are encrypted with the
DES-CBC algorithm and the specified password. The same password
-must be specified to the local ntpd via the "crypto pw password"
+must be specified to the local ntpd via the "crypto pw password"
configuration command. The default password is the local
-hostname.
-</p><hr>
+hostname.
+<div class="node">
+<a name="ntp-keygen-export-passwd"></a>
<a name="ntp_002dkeygen-export_002dpasswd"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-sign_002dkey" accesskey="n" rel="next">ntp-keygen sign-key</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-password">ntp-keygen password</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="export_002dpasswd-option-_0028_002dq_0029"></a>
-<h4 class="subsection">1.2.16 export-passwd option (-q)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Export IFF or GQ identity group keys to the standard output,
-encrypted with the DES-CBC algorithm and the specified password.
+
+<h4 class="subsection">export-passwd option (-q)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dexport_002dpasswd-17"></a>
+This is the ``export iff or gq group keys with password'' option.
+This option takes a string argument <samp><span class="file">passwd</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+
<p>Export IFF or GQ identity group keys to the standard output,
+encrypted with the DES-CBC algorithm and the specified password.
The same password must be specified to the remote ntpd via the
-"crypto pw password" configuration command. See also the option
-–id-key (-e) for unencrypted exports.
-</p><hr>
+"crypto pw password" configuration command. See also the option
+--id-key (-e) for unencrypted exports.
+<div class="node">
+<a name="ntp-keygen-sign-key"></a>
<a name="ntp_002dkeygen-sign_002dkey"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-subject_002dname" accesskey="n" rel="next">ntp-keygen subject-name</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="sign_002dkey-option-_0028_002dS_0029"></a>
-<h4 class="subsection">1.2.17 sign-key option (-S)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Generate a new sign key of the designated type, obsoleting any
+
+<h4 class="subsection">sign-key option (-S)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dsign_002dkey-18"></a>
+This is the ``generate sign key (rsa or dsa)'' option.
+This option takes a string argument <samp><span class="file">sign</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</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>
+sign key.
+<div class="node">
+<a name="ntp-keygen-subject-name"></a>
<a name="ntp_002dkeygen-subject_002dname"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-trusted_002dcert" accesskey="n" rel="next">ntp-keygen trusted-cert</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="subject_002dname-option-_0028_002ds_0029"></a>
-<h4 class="subsection">1.2.18 subject-name option (-s)</h4>
-<a name="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>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>Set the Autokey host name, and optionally, group name specified
-following an ’<code>}' character. The host name is used in the file
+
+<h4 class="subsection">subject-name option (-s)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dsubject_002dname-19"></a>
+This is the ``set host and optionally group name'' option.
+This option takes a string argument <samp><span class="file">host@group</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+
<p>Set the Autokey host name, and optionally, group name specified
+following an '<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</code></code></p><p>fields. Specifying ’<code>-s </code></p><p>leaving the host name unchanged while appending <code></code></p><p>subject and issuer fields, as with <code>-i group</code>. The group name, or
+in host
+ <p>fields. Specifying '-s
+ <p>leaving the host name unchanged while appending
+ <p>subject and issuer fields, as with -i group. 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>
+of IFF, GQ, and MV client parameter files.
+</code><div class="node">
+<a name="ntp-keygen-trusted-cert"></a>
<a name="ntp_002dkeygen-trusted_002dcert"></a>
-<div class="header">
-<p>
-Next: <a href="#ntp_002dkeygen-mv_002dparams" accesskey="n" rel="next">ntp-keygen mv-params</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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="trusted_002dcert-option-_0028_002dT_0029"></a>
-<h4 class="subsection">1.2.19 trusted-cert option (-T)</h4>
-<a name="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.
-</li></ul>
-
-<p>Generate a trusted certificate. By default, the program generates
-a non-trusted certificate.
-</p><hr>
+
+<h4 class="subsection">trusted-cert option (-T)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dtrusted_002dcert-20"></a>
+This is the ``trusted certificate (tc scheme)'' option.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate a trusted certificate. By default, the program generates
+a non-trusted certificate.
+<div class="node">
+<a name="ntp-keygen-mv-params"></a>
<a name="ntp_002dkeygen-mv_002dparams"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="mv_002dparams-option-_0028_002dV_0029"></a>
-<h4 class="subsection">1.2.20 mv-params option (-V)</h4>
-<a name="index-ntp_002dkeygen_002dmv_002dparams"></a>
-
-<p>This is the “generate <num> mv parameters” option.
-This option takes a number argument <samp>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.
-</li></ul>
-
-<p>Generate parameters and keys for the Mu-Varadharajan (MV)
-identification scheme.
-</p><hr>
+
+<h4 class="subsection">mv-params option (-V)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dmv_002dparams-21"></a>
+This is the ``generate <num> mv parameters'' option.
+This option takes a number argument <samp><span class="file">num</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+ <ul>
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>Generate parameters and keys for the Mu-Varadharajan (MV)
+identification scheme.
+<div class="node">
+<a name="ntp-keygen-mv-keys"></a>
<a name="ntp_002dkeygen-mv_002dkeys"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-config">ntp-keygen config</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="mv_002dkeys-option-_0028_002dv_0029"></a>
-<h4 class="subsection">1.2.21 mv-keys option (-v)</h4>
-<a name="index-ntp_002dkeygen_002dmv_002dkeys"></a>
-
-<p>This is the “update <num> mv keys” option.
-This option takes a number argument <samp>num</samp>.
-</p>
-<p>This option has some usage constraints. It:
-<li> must be compiled in by defining <code>AUTOKEY</code> during the compilation.
-</li></ul>
-
-<p>This option has no ‘<samp>doc</samp>’ documentation.
-</p>
-
-<hr>
+
+<h4 class="subsection">mv-keys option (-v)</h4>
+
+<p><a name="index-ntp_002dkeygen_002dmv_002dkeys-22"></a>
+This is the ``update <num> mv keys'' option.
+This option takes a number argument <samp><span class="file">num</span></samp>.
+
+<p class="noindent">This option has some usage constraints. It:
+<li>must be compiled in by defining <code>AUTOKEY</code> during the compilation.
+</ul>
+
+ <p>This option has no ‘<samp><span class="samp">doc</span></samp>’ documentation.
+
+<div class="node">
+<a name="ntp-keygen-config"></a>
<a name="ntp_002dkeygen-config"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="presetting_002fconfiguring-ntp_002dkeygen"></a>
-<h4 class="subsection">1.2.22 presetting/configuring ntp-keygen</h4>
+
+<h4 class="subsection">presetting/configuring ntp-keygen</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
-the options listed above in upper case and segmented with underscores.
+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
+the options listed above in upper case and segmented with underscores.
The <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
-</li></ul>
-<p>The environment variables <code>HOME</code>, and <code>PWD</code>
-are expanded and replaced when <samp>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
+
+<p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
+ <ul>
+<li>$HOME
+<li>$PWD
+</ul>
+ The environment variables <code>HOME</code>, and <code>PWD</code>
+are expanded and replaced when <samp><span class="file">ntp-keygen</span></samp> runs.
+For any of these that are plain files, they are simply processed.
+For any that are directories, then a file named <samp><span class="file">.ntprc</span></samp> is searched for
within that directory and processed.
-</p>
-<p>Configuration files may be in a wide variety of formats.
+
+ <p>Configuration files may be in a wide variety of formats.
The basic format is an option name followed by a value (argument) on the
same line. Values may be separated from the option name with a colon,
equal sign or simply white space. Values may be continued across multiple
lines by escaping the newline with a backslash.
-</p>
-<p>Multiple programs may also share the same initialization file.
+
+ <p>Multiple programs may also share the same initialization file.
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></div>
-<p>or by
-</p><div class="example">
-<pre class="example"><?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
+<pre class="example"> [NTP-KEYGEN]
+</pre>
+ <p class="noindent">or by
+<pre class="example"> <?program ntp-keygen>
+</pre>
+ <p class="noindent">Do not mix these styles within one configuration file.
+
+ <p>Compound values and carefully constructed string values may also be
specified using XML syntax:
-</p><div class="example">
-<pre class="example"><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><div class="example">
-<pre class="example">"...<...>..."
-</pre></div>
-<p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
+<pre class="example"> <option-name>
+ <sub-opt>...&lt;...&gt;...</sub-opt>
+ </option-name>
+</pre>
+ <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
+<pre class="example"> "...<...>..."
+</pre>
+ <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
the associated name/value pair list (see: optionFindValue).
-</p>
-<p>The command line options relating to configuration and/or usage help are:
-</p>
-<a name="version-_0028_002d_0029"></a>
-<h4 class="subsubheading">version (-)</h4>
+
+ <p>The command line options relating to configuration and/or usage help are:
+
+<h5 class="subsubheading">version (-)</h5>
<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 infomation may be selected with an option argument.
+detail to provide. The default is to print just the version. The licensing infomation 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>
-<dd><p>Only print the version. This is the default.
-</p></dd>
-<dt>‘<samp>copyright</samp>’</dt>
-<dd><p>Name the copyright usage licensing terms.
-</p></dd>
-<dt>‘<samp>verbose</samp>’</dt>
-<dd><p>Print the full copyright usage licensing terms.
-</p></dd>
+
+ <dl>
+<dt>‘<samp><span class="samp">version</span></samp>’<dd>Only print the version. This is the default.
+<br><dt>‘<samp><span class="samp">copyright</span></samp>’<dd>Name the copyright usage licensing terms.
+<br><dt>‘<samp><span class="samp">verbose</span></samp>’<dd>Print the full copyright usage licensing terms.
</dl>
-<hr>
+<div class="node">
+<a name="ntp-keygen-exit-status"></a>
<a name="ntp_002dkeygen-exit-status"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-config">ntp-keygen config</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ntp_002dkeygen-exit-status-1"></a>
-<h4 class="subsection">1.2.23 ntp-keygen exit status</h4>
+
+<h4 class="subsection">ntp-keygen exit status</h4>
<p>One of the following exit values will be returned:
-</p><dl compact="compact">
-<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
-<dd><p>Successful program execution.
-</p></dd>
-<dt>‘<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>
-<dd><p>A specified configuration file could not be loaded.
-</p></dd>
-<dt>‘<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>
+<dt>‘<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>’<dd>Successful program execution.
+<br><dt>‘<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>’<dd>The operation failed or the command syntax was not valid.
+<br><dt>‘<samp><span class="samp">66 (EX_NOINPUT)</span></samp>’<dd>A specified configuration file could not be loaded.
+<br><dt>‘<samp><span class="samp">70 (EX_SOFTWARE)</span></samp>’<dd>libopts had an internal operational error. Please report
+it to autogen-users@lists.sourceforge.net. Thank you.
</dl>
-<hr>
+ <div class="node">
+<a name="ntp-keygen-Usage"></a>
<a name="ntp_002dkeygen-Usage"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ntp_002dkeygen-Usage-1"></a>
-<h4 class="subsection">1.2.24 ntp-keygen Usage</h4>
-<hr>
+
+<h4 class="subsection">ntp-keygen Usage</h4>
+
+<div class="node">
+<a name="ntp-keygen-Notes"></a>
<a name="ntp_002dkeygen-Notes"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a>,
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ntp_002dkeygen-Notes-1"></a>
-<h4 class="subsection">1.2.25 ntp-keygen Notes</h4>
-<hr>
+
+<h4 class="subsection">ntp-keygen Notes</h4>
+
+<div class="node">
+<a name="ntp-keygen-Bugs"></a>
<a name="ntp_002dkeygen-Bugs"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>
+
</div>
-<a name="ntp_002dkeygen-Bugs-1"></a>
-<h4 class="subsection">1.2.26 ntp-keygen Bugs</h4>
-<hr>
+<h4 class="subsection">ntp-keygen Bugs</h4>
+
+<div class="node">
<a name="Random-Seed-File"></a>
-<div class="header">
-<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>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Cryptographic-Data-Files">Cryptographic Data Files</a>,
+Previous: <a rel="previous" accesskey="p" href="#Running-the-Program">Running the Program</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Random-Seed-File-2"></a>
-<h3 class="section">1.3 Random Seed File</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Random Seed File</h3>
<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 OpenSSL library routines.
+pseudo-random number generator used by the OpenSSL library routines.
If a site supports ssh, it is very likely that means to do this are
-already available.
+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.
-</p>
-<p>The OpenSSL library looks for the file using the path specified by the
+
+
<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
-or some other user.
+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
-directory.
+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>.
+<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>
+
+<div class="node">
<a name="Cryptographic-Data-Files"></a>
-<div class="header">
-<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>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#Random-Seed-File">Random Seed File</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
</div>
-<a name="Cryptographic-Data-Files-2"></a>
-<h3 class="section">1.4 Cryptographic Data Files</h3>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Cryptographic Data Files</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).
+<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
names.
-</p>
-<p>The key name is a string defining the cryptographic key type.
+
+ <p>The key name is a string defining the cryptographic key type.
Key types include public/private keys host and sign, certificate cert
-and several challenge/response key types.
+and several challenge/response key types.
By convention, client files used for
challenges have a par subtype, as in the IFF challenge IFFpar, while
server files for responses have a key subtype, as in the GQ response
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 second line contains the datestamp in conventional Unix date format.
+
+
<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 second line contains the datestamp in conventional Unix date format.
Lines beginning with <code>#</code> are ignored.
-</p>
-<p>The remainder of the file contains cryptographic data encoded first
+
+
<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>ntp.keys</code>,
is somewhat different than the other files in the interest of backward
-compatibility.
+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
-# Sun Dec 9 02:45:57 2012
-
- 1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key
- 2 MD5 lu+H^tF46BKR-6~pV_5 # MD5 key
- 3 MD5 :lnoVsE%Yz*avh%EtNC # MD5 key
- 4 MD5 |fdZrf0sF~;w-i^V # MD5 key
- 5 MD5 IyAG>O"y"LmCRS!*bHC # MD5 key
- 6 MD5 ">e\A>hT/661ri52,,H # MD5 key
- 7 MD5 c9x=M'CfLxax9v)PV-si # MD5 key
- 8 MD5 E|=jvFVov?Bn|Ev=&aK\ # MD5 key
- 9 MD5 T!c4UT&`(m$+m+B6,`Q0 # MD5 key
-10 MD5 JVF/1=)=IFbHbJQz..Cd # MD5 key
-11 SHA1 6dea311109529e436c2b4fccae9bc753c16d1b48 # SHA1 key
-12 SHA1 7076f373d86c4848c59ff8046e49cb7d614ec394 # SHA1 key
-13 SHA1 5f48b1b60591eb01b7cf1d33b7774f08d20262d3 # SHA1 key
-14 SHA1 eed5ab9d9497319ec60cf3781d52607e76720178 # SHA1 key
-15 SHA1 f283562611a04c964da8126296f5f8e58c3f85de # SHA1 key
-16 SHA1 1930da171297dd63549af50b29449de17dcf341f # SHA1 key
-17 SHA1 fee892110358cd4382322b889869e750db8e8a8f # SHA1 key
-18 SHA1 b5520c9fadd7ad3fd8bfa061c8821b65d029bb37 # SHA1 key
-19 SHA1 8c74fb440ec80f453ec6aaa62b9baed0ab723b92 # SHA1 key
-20 SHA1 6bc05f734306a189326000970c19b3910f403795 # SHA1 key
-</pre></div>
-
-<p>Figure 1. Typical Symmetric Key File
-</p>
-<p>Figure 1 shows a typical symmetric keys file used by the reference
-implementation.
+
+<pre class="example"> # ntpkey_MD5key_hms.local.3564038757
+ # Sun Dec 9 02:45:57 2012
+
+ 1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key
+ 2 MD5 lu+H^tF46BKR-6~pV_5 # MD5 key
+ 3 MD5 :lnoVsE%Yz*avh%EtNC # MD5 key
+ 4 MD5 |fdZrf0sF~^V # MD5 key
+ 5 MD5 IyAG>O"y"LmCRS!*bHC # MD5 key
+ 6 MD5 ">e\A # MD5 key
+ 7 MD5 c9x=M'CfLxax9v)PV-si # MD5 key
+ 8 MD5 E|=jvFVov?Bn|Ev=&aK\ # MD5 key
+ 9 MD5 T!c4UT&`(m$+m+B6,`Q0 # MD5 key
+ 10 MD5 JVF/1=)=IFbHbJQz..Cd # MD5 key
+ 11 SHA1 6dea311109529e436c2b4fccae9bc753c16d1b48 # SHA1 key
+ 12 SHA1 7076f373d86c4848c59ff8046e49cb7d614ec394 # SHA1 key
+ 13 SHA1 5f48b1b60591eb01b7cf1d33b7774f08d20262d3 # SHA1 key
+ 14 SHA1 eed5ab9d9497319ec60cf3781d52607e76720178 # SHA1 key
+ 15 SHA1 f283562611a04c964da8126296f5f8e58c3f85de # SHA1 key
+ 16 SHA1 1930da171297dd63549af50b29449de17dcf341f # SHA1 key
+ 17 SHA1 fee892110358cd4382322b889869e750db8e8a8f # SHA1 key
+ 18 SHA1 b5520c9fadd7ad3fd8bfa061c8821b65d029bb37 # SHA1 key
+ 19 SHA1 8c74fb440ec80f453ec6aaa62b9baed0ab723b92 # SHA1 key
+ 20 SHA1 6bc05f734306a189326000970c19b3910f403795 # SHA1 key
+</pre>
+ <p>Figure 1. Typical Symmetric Key File
+
+ <p>Figure 1 shows a typical symmetric keys file used by the reference
+implementation.
Each line of the file contains three fields, first an
integer between 1 and 65534, inclusive, representing the key identifier
-used in the server and peer configuration commands.
+used in the server and peer configuration commands.
Next is the key type for the message digest algorithm,
which in the absence of the
OpenSSL library must be MD5 to designate the MD5 message digest
-algorithm.
+algorithm.
If the OpenSSL library is installed, the key type can be any
-message digest algorithm supported by that library.
+message digest algorithm supported by that library.
However, if
compatibility with FIPS 140-2 is required, the key type must be either
-SHA or SHA1.
+SHA or SHA1.
The key type can be changed using an ASCII text editor.
-</p>
-<p>An MD5 key consists of a printable ASCII string less than or equal to
-16 characters and terminated by whitespace or a # character.
+
+
<p>An MD5 key consists of a printable ASCII string less than or equal to
+16 characters and terminated by whitespace or a # character.
An OpenSSL
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>ntpq</code> and <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>ntp-keygen</code> program generates a MD5 symmetric keys file
+<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.
+secure means to other subnet hosts.
The NTP daemon loads the file <code>ntp.keys</code>, so <code>ntp-keygen</code>
-installs a soft link from this name to the generated file.
+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.
+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>
-
+</body></html>
-</body>
-</html>
.ds B-Font B
.ds I-Font I
.ds R-Font R
-.TH ntp-keygen @NTP_KEYGEN_MS@ "02 Jan 2017" "ntp (4.2.8p9)" "User Commands"
+.TH ntp-keygen @NTP_KEYGEN_MS@ "19 Mar 2017" "ntp (4.2.8p9)" "User Commands"
.\"
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:38 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:42 AM by AutoGen 5.18.5
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
.SH DESCRIPTION
This program generates cryptographic data files used by the NTPv4
authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
-In addition, if the OpenSSL software library has been installed,
-it generates keys, certificate and identity files used in public key
-cryptography.
+It can generate message digest keys used in symmetric key cryptography and,
+if the OpenSSL software library has been installed, it can generate host keys,
+signing keys, certificates, and identity keys and parameters used in Autokey
+public key cryptography.
These files are used for cookie encryption,
-digital signature and challenge/response identification algorithms
+digital signature, and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
.sp \n(Ppu
.ne 2
-All files are in PEM-encoded printable ASCII format,
-so they can be embedded as MIME attachments in mail to other sites
+The message digest symmetric keys file is generated in a format
+compatible with NTPv3.
+All other files are in PEM-encoded printable ASCII format,
+so they can be embedded as MIME attachments in email to other sites
and certificate authorities.
By default, files are not encrypted.
.sp \n(Ppu
.ne 2
-When used to generate message digest keys, the program produces a file
-containing ten pseudo-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+When used to generate message digest symmetric keys, the program
+produces a file containing ten pseudo-random printable ASCII strings
+suitable for the MD5 message digest algorithm included in the
+distribution.
If the OpenSSL library is installed, it produces an additional ten
-hex-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
-The message digest keys file must be distributed and stored
+hex-encoded random bit strings suitable for SHA1, AES-128-CMAC, and
+other message digest algorithms.
+The message digest symmetric keys file must be distributed and stored
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
Some files used by this program are encrypted using a private password.
The
\f\*[B-Font]\-p\f[]
-option specifies the password for local encrypted files and the
+option specifies the read password for local encrypted files and the
\f\*[B-Font]\-q\f[]
-option the password for encrypted files sent to remote sites.
+option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-\fBgethostname\f[]\fR()\f[]
-function, normally the DNS name of the host is used.
+\fChostname\f[]\fR(1)\f[]
+command, normally the DNS name of the host, is used as the the default read
+password, for convenience.
+The
+\f\*[B-Font]ntp-keygen\fP
+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
+no write password is specified, the read password is used
+as the write password by default.
.sp \n(Ppu
.ne 2
The
-\f\*[I-Font]pw\f[]
+\f\*[B-Font]pw\f[]
option of the
-\f\*[I-Font]crypto\f[]
+\f\*[B-Font]crypto\f[]
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
configuration command specifies the read
password for previously encrypted local files.
-This must match the local password used by this program.
+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 password,
+Thus, if files are generated by this program without an explicit password,
they can be read back by
-\f\*[I-Font]ntpd\f[]
-without password but only on the same host.
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
+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.
.sp \n(Ppu
.ne 2
used only by that host, although exceptions exist as noted later on
this page.
The symmetric keys file, normally called
-\f\*[I-Font]ntp.keys\f[],
+\fIntp.keys\f[],
is usually installed in
\fI/etc\f[].
Other files and links are usually installed in
\fI/usr/local/etc\f[],
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
-\f\*[I-Font]keysdir\f[]
-configuration command in such cases.
-Normally, this is in
-\fI/etc\f[].
+In these cases, NFS clients can specify the files in another
+directory such as
+\fI/etc\f[]
+using the
+\f\*[B-Font]keysdir\f[]
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
+configuration file command.
.sp \n(Ppu
.ne 2
This program directs commentary and error messages to the standard
error stream
-\f\*[I-Font]stderr\f[]
+\fIstderr\f[]
and remote files to the standard output stream
-\f\*[I-Font]stdout\f[]
+\fIstdout\f[]
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
-\f\*[I-Font]ntpkey\f[]
+\fIntpkey\&*\f[]
and include the file type, generating host and filestamp,
as described in the
-\*[Lq]Cryptographic Data Files\*[Rq]
+\fICryptographic Data Files\f[]
section below.
.SS Running the Program
-To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually
-\fI/usr/local/etc\f[]
-When run for the first time, or if all files with names beginning with
-\f\*[I-Font]ntpkey\f[]
-have been removed, use the
-\f\*[B-Font]ntp-keygen\fP
-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
-existing keys and parameters and generates only a new certificate with
-new expiration date one year hence.
-.sp \n(Ppu
-.ne 2
-
-Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using
+The safest way to run the
\f\*[B-Font]ntp-keygen\fP
-with the
-\f\*[B-Font]\-T\f[]
-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
-ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
-All group hosts should have acyclic certificate trails ending on the TH.
-.sp \n(Ppu
-.ne 2
-
-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
-\f\*[B-Font]\-S\f[]
-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
-\f\*[B-Font]\-c\f[]
-option.
-The rules say cryptographic media should be generated with proventic
-filestamps, which means the host should already be synchronized before
-this program is run.
-This of course creates a chicken-and-egg problem
-when the host is started for the first time.
-Accordingly, the host time
-should be set by some other means, such as eyeball-and-wristwatch, at
-least so that the certificate lifetime is within the current year.
-After that and when the host is synchronized to a proventic source, the
-certificate should be re-generated.
-.sp \n(Ppu
-.ne 2
-
-Additional information on trusted groups and identity schemes is on the
-\*[Lq]Autokey Public-Key Authentication\*[Rq]
-page.
-.sp \n(Ppu
-.ne 2
-
-The
-\fCntpd\f[]\fR(@NTPD_MS@)\f[]
-configuration command
-\f\*[B-Font]crypto\f[] \f\*[B-Font]pw\f[] \f\*[I-Font]password\f[]
-specifies the read password for previously encrypted files.
-The daemon expires on the spot if the password is missing
-or incorrect.
-For convenience, if a file has been previously encrypted,
-the default read password is the name of the host running
-the program.
-If the previous write password is specified as the host name,
-these files can be read by that host with no explicit password.
-.sp \n(Ppu
-.ne 2
-
-File names begin with the prefix
-\f\*[B-Font]ntpkey_\f[]
-and end with the postfix
-\f\*[I-Font]_hostname.filestamp\f[],
-where
-\f\*[I-Font]hostname\f[]
-is the owner name, usually the string returned
-by the Unix gethostname() routine, and
-\f\*[I-Font]filestamp\f[]
-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
-\f\*[B-Font]rm\f[] \f\*[B-Font]ntpkey\&*\f[]
-command or all files generated
-at a specific time can be removed by a
-\f\*[B-Font]rm\f[]
-\f\*[I-Font]\&*filestamp\f[]
-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.
-.sp \n(Ppu
-.ne 2
-
-All files are installed by default in the keys directory
+program is logged in directly as root.
+The recommended procedure is change to the
+\f\*[I-Font]keys\f[]
+directory, usually
\fI/usr/local/etc\f[],
-which is normally in a shared filesystem
-in NFS-mounted networks.
-The actual location of the keys directory
-and each file can be overridden by configuration commands,
-but this is not recommended.
-Normally, the files for each host are generated by that host
-and used only by that host, although exceptions exist
-as noted later on this page.
-.sp \n(Ppu
-.ne 2
-
-Normally, files containing private values,
-including the host key, sign key and identification parameters,
-are permitted root read/write-only;
-while others containing public values are permitted world readable.
-Alternatively, files containing private values can be encrypted
-and these files permitted world readable,
-which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
-dependent clients can all be installed in the same shared directory.
+then run the program.
.sp \n(Ppu
.ne 2
-The recommended practice is to keep the file name extensions
-when installing a file and to install a soft link
-from the generic names specified elsewhere on this page
-to the generated files.
-This allows new file generations to be activated simply
-by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
-If a link is not present,
-\fCntpd\f[]\fR(@NTPD_MS@)\f[]
-extracts the filestamp from the file itself.
-This allows clients to verify that the file and generation times
-are always current.
-The
-\f\*[B-Font]ntp-keygen\fP
-program uses the same timestamp extension for all files generated
-at one time, so each generation is distinct and can be readily
-recognized in monitoring data.
-.SS Running the program
-The safest way to run the
+To test and gain experience with Autokey concepts, log in as root and
+change to the
+\f\*[I-Font]keys\f[]
+directory, usually
+\fI/usr/local/etc\f[].
+When run for the first time, or if all files with names beginning with
+\fIntpkey\&*\f[]
+have been removed, use the
\f\*[B-Font]ntp-keygen\fP
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-\fI/usr/local/etc\f[],
-then run the program.
-When run for the first time,
-or if all
-\f\*[B-Font]ntpkey\f[]
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
+command without arguments to generate a default
+\f\*[B-Font]RSA\f[]
+host key and matching
+\f\*[B-Font]RSA-MD5\f[]
+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
to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+If run again without options, the program uses the
+existing keys and parameters and generates a new certificate file with
+new expiration date one year hence, and soft link.
.sp \n(Ppu
.ne 2
-The host key is used to encrypt the cookie when required and so must be RSA type.
+The host key is used to encrypt the cookie when required and so must be
+\f\*[B-Font]RSA\f[]
+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 RSA or DSA type.
-By default, the message digest type is MD5, but any combination
+either
+\f\*[B-Font]RSA\f[]
+or
+\f\*[B-Font]DSA\f[]
+type.
+By default, the message digest type is
+\f\*[B-Font]MD5\f[],
+but any combination
of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+can be specified, including those using the
+\f\*[B-Font]AES128CMAC\f[], \f\*[B-Font]MD2\f[], \f\*[B-Font]MD5\f[], \f\*[B-Font]MDC2\f[], \f\*[B-Font]SHA\f[], \f\*[B-Font]SHA1\f[]
+and
+\f\*[B-Font]RIPE160\f[]
+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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Certificates using any digest algorithm are compatible with
+\f\*[B-Font]RSA\f[]
+sign keys;
+however, only
+\f\*[B-Font]SHA\f[]
+and
+\f\*[B-Font]SHA1\f[]
+certificates are compatible with
+\f\*[B-Font]DSA\f[]
+sign keys.
.sp \n(Ppu
.ne 2
.ne 2
Running the program as other than root and using the Unix
-\f\*[B-Font]su\f[]
+\fCsu\f[]\fR(1)\f[]
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-\f\*[B-Font].rnd\f[]
+\fI.rnd\f[]
in the user home directory.
However, there should be only one
-\f\*[B-Font].rnd\f[],
+\fI.rnd\f[],
most conveniently
in the root directory, so it is convenient to define the
-\f\*[B-Font]$RANDFILE\f[]
+RANDFILE
environment variable used by the OpenSSL library as the path to
-\f\*[B-Font]/.rnd\f[].
+\fI.rnd\f[].
.sp \n(Ppu
.ne 2
\fI/etc\f[]
using the
\f\*[B-Font]keysdir\f[]
-command.
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
+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
by the Autokey protocol.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
+Since uniqueness is insured by the
+\f\*[I-Font]hostname\f[]
+and
+\f\*[I-Font]filestamp\f[]
+file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
.sp \n(Ppu
.ne 2
to the generated files.
This allows new file generations to be activated simply
by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+If a link is present,
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
+follows it to the file name to extract the
+\f\*[I-Font]filestamp\f[].
If a link is not present,
\fCntpd\f[]\fR(@NTPD_MS@)\f[]
-extracts the filestamp from the file itself.
+extracts the
+\f\*[I-Font]filestamp\f[]
+from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
\f\*[B-Font]ntp-keygen\fP
-program uses the same timestamp extension for all files generated
+program uses the same
+\f\*[I-Font]filestamp\f[]
+extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-.SS Running the program
-The safest way to run the
-\f\*[B-Font]ntp-keygen\fP
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-\fI/usr/local/etc\f[],
-then run the program.
-When run for the first time,
-or if all
-\f\*[B-Font]ntpkey\f[]
-files have been removed,
-the program generates a RSA host key file and matching RSA-MD5 certificate file,
-which is all that is necessary in many cases.
-The program also generates soft links from the generic names
-to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
.sp \n(Ppu
.ne 2
-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.
-When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
-By default, the message digest type is MD5, but any combination
-of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Run the command on as many hosts as necessary.
+Designate one of them as the trusted host (TH) using
+\f\*[B-Font]ntp-keygen\fP
+with the
+\f\*[B-Font]\-T\f[]
+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
+ascendant host towards the TH to sign its certificate, which is then
+provided to the immediately descendant host on request.
+All group hosts should have acyclic certificate trails ending on the TH.
.sp \n(Ppu
.ne 2
-Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
-Certificates or certificate requests derived from them should be compatible
-with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
-However, the identification parameter files, although encoded
-as the other files, are probably not compatible with anything other than Autokey.
+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
+\f\*[B-Font]\-S\f[]
+option and this can be either
+\f\*[B-Font]RSA\f[]
+or
+\f\*[B-Font]DSA\f[]
+type.
+By default, the signature
+message digest type is
+\f\*[B-Font]MD5\f[],
+but any combination of sign key type and
+message digest type supported by the OpenSSL library can be specified
+using the
+\f\*[B-Font]\-c\f[]
+option.
.sp \n(Ppu
.ne 2
-Running the program as other than root and using the Unix
-\f\*[B-Font]su\f[]
-command
-to assume root may not work properly, since by default the OpenSSL library
-looks for the random seed file
-\f\*[B-Font].rnd\f[]
-in the user home directory.
-However, there should be only one
-\f\*[B-Font].rnd\f[],
-most conveniently
-in the root directory, so it is convenient to define the
-\f\*[B-Font]$RANDFILE\f[]
-environment variable used by the OpenSSL library as the path to
-\f\*[B-Font]/.rnd\f[].
+The rules say cryptographic media should be generated with proventic
+filestamps, which means the host should already be synchronized before
+this program is run.
+This of course creates a chicken-and-egg problem
+when the host is started for the first time.
+Accordingly, the host time
+should be set by some other means, such as eyeball-and-wristwatch, at
+least so that the certificate lifetime is within the current year.
+After that and when the host is synchronized to a proventic source, the
+certificate should be re-generated.
.sp \n(Ppu
.ne 2
-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
-\fI/etc\f[]
-using the
-\f\*[B-Font]keysdir\f[]
-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
-by the Autokey protocol.
+Additional information on trusted groups and identity schemes is on the
+\*[Lq]Autokey Public-Key Authentication\*[Rq]
+page.
.sp \n(Ppu
.ne 2
-Ordinarily, cryptographic files are generated by the host that uses them,
-but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
-The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
-It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
-The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
-seconds.
-seconds.
-s Trusted Hosts and Groups
+File names begin with the prefix
+\fIntpkey\f[]_
+and end with the suffix
+\fI_\f[]\f\*[I-Font]hostname\f[]. \f\*[I-Font]filestamp\f[],
+where
+\f\*[I-Font]hostname\f[]
+is the owner name, usually the string returned
+by the Unix
+\fChostname\f[]\fR(1)\f[]
+command, and
+\f\*[I-Font]filestamp\f[]
+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
+\f\*[B-Font]rm\f[] \fIntpkey\&*\f[]
+command or all files generated
+at a specific time can be removed by a
+\f\*[B-Font]rm\f[] \fI\&*\f[]\f\*[I-Font]filestamp\f[]
+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.
+.SS Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
\fIAuthentication\f[] \fIOptions\f[]
section of
\fCntp.conf\f[]\fR(5)\f[].
-The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+The default cryptotype uses
+\f\*[B-Font]RSA\f[]
+encryption,
+\f\*[B-Font]MD5\f[]
+message digest
+and
+\f\*[B-Font]TC\f[]
+identification.
First, configure a NTP subnet including one or more low-stratum
trusted hosts from which all other hosts derive synchronization
directly or indirectly.
On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-\f\*[B-Font]ntpkey\f[]
+\fIntpkey\f[]
files.
Then run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]RSA\f[]
or
\f\*[B-Font]DSA\f[].
-The most often need to do this is when a DSA-signed certificate is used.
+The most frequent need to do this is when a
+\f\*[B-Font]DSA\f[]\-signed
+certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
\f\*[B-Font]ntp-keygen\fP
option and selected
\f\*[I-Font]scheme\f[]
as needed.
-f
+If
\f\*[B-Font]ntp-keygen\fP
is run again without these options, it generates a new certificate
-using the same scheme and sign key.
+using the same scheme and sign key, and soft link.
.sp \n(Ppu
.ne 2
Simply run
\f\*[B-Font]ntp-keygen\fP
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys, and soft links.
However, if the host or sign key is changed,
\fCntpd\f[]\fR(@NTPD_MS@)\f[]
should be restarted.
at which time the protocol is restarted.
.SS Identity Schemes
As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default
+\f\*[B-Font]TC\f[]
+identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
-including PC, IFF, GQ and MV described on the
-"Identification Schemes"
-page
-(maybe available at
-\f[C]http://www.eecis.udel.edu/%7emills/keygen.html\f[]).
+including
+\f\*[B-Font]PC\f[], \f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[]
+and
+\f\*[B-Font]MV\f[]
+schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
\f\*[B-Font]\-P\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to generate the host key file
-\fIntpkey_RSAkey_\f[]\f\*[I-Font]alice.filestamp\f[]
+\fIntpkey\f[]_ \f\*[B-Font]RSA\f[] \fIkey_alice.\f[] \f\*[I-Font]filestamp\f[]
and trusted private certificate file
-\fIntpkey_RSA-MD5_cert_\f[]\f\*[I-Font]alice.filestamp\f[].
+\fIntpkey\f[]_ \f\*[B-Font]RSA-MD5\f[] \f\*[B-Font]_\f[] \fIcert_alice.\f[] \f\*[I-Font]filestamp\f[],
+and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
-On each host bob install a soft link from the generic name
+On each host
+\f\*[I-Font]bob\f[]
+install a soft link from the generic name
\fIntpkey_host_\f[]\f\*[I-Font]bob\f[]
to the host key file and soft link
\fIntpkey_cert_\f[]\f\*[I-Font]bob\f[]
by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
-to all other hosts in the group.
+to all other hosts in the group, and recreating the soft links.
.sp \n(Ppu
.ne 2
-For the IFF scheme proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]IFF\f[]
+scheme proceed as in the
+\f\*[B-Font]TC\f[]
+scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the
+\f\*[B-Font]IFF\f[]
+parameter file.
On trusted host alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-T\f[]
\f\*[B-Font]\-I\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to produce her parameter file
-\fIntpkey_IFFpar_\f[]\f\*[I-Font]alice.filestamp\f[],
+\fIntpkey_IFFpar_alice.\f[]\f\*[I-Font]filestamp\f[],
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
-\fIntpkey_iff_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_iff_alice\f[]
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
-As the IFF scheme is independent
+As the
+\f\*[B-Font]IFF\f[]
+scheme is independent
of keys and certificates, these files can be refreshed as needed.
.sp \n(Ppu
.ne 2
After generating the parameter file, on alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-e\f[]
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+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
-\fIntpkey_iff_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_iff_alice\f[]
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
.sp \n(Ppu
.ne 2
-For the GQ scheme proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]GQ\f[]
+scheme proceed as in the
+\f\*[B-Font]TC\f[]
+scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the
+\f\*[B-Font]IFF\f[]
+parameter file.
On trusted host alice run
\f\*[B-Font]ntp-keygen\fP
\f\*[B-Font]\-T\f[]
\f\*[B-Font]\-G\f[]
\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
to produce her parameter file
-\fIntpkey_GQpar_\f[]\f\*[I-Font]alice.filestamp\f[],
+\fIntpkey_GQpar_alice.\f[]\f\*[I-Font]filestamp\f[],
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-\fIntpkey_gq_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_gq_alice\f[]
to this file.
-In addition, on each host bob install a soft link
+In addition, on each host
+\f\*[I-Font]bob\f[]
+install a soft link
from generic
\fIntpkey_gq_\f[]\f\*[I-Font]bob\f[]
to this file.
-As the GQ scheme updates the GQ parameters file and certificate
+As the
+\f\*[B-Font]GQ\f[]
+scheme updates the
+\f\*[B-Font]GQ\f[]
+parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
.sp \n(Ppu
.ne 2
-For the MV scheme, proceed as in the TC scheme to generate keys
+For the
+\f\*[B-Font]MV\f[]
+scheme, proceed as in the
+\f\*[B-Font]TC\f[]
+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.
\f\*[I-Font]n\f[]
is the number of revokable keys (typically 5) to produce
the parameter file
-\fIntpkeys_MVpar_\f[]\f\*[I-Font]trish.filestamp\f[]
+\fIntpkeys_MVpar_trish.\f[]\f\*[I-Font]filestamp\f[]
and client key files
-\fIntpkeys_MVkeyd_\f[]\f\*[I-Font]trish.filestamp\f[]
+\fIntpkeys_MVkey\f[]\f\*[I-Font]d\f[] \f\*[I-Font]_\f[] \fItrish.\f[] \f\*[I-Font]filestamp\f[]
where
\f\*[I-Font]d\f[]
is the key number (0 \&<
\f\*[I-Font]n\f[]).
Copy the parameter file to alice and install a soft link
from the generic
-\fIntpkey_mv_\f[]\f\*[I-Font]alice\f[]
+\fIntpkey_mv_alice\f[]
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
-It doesn't matter which client key file goes to alice,
+It does not matter which client key file goes to alice,
since they all work the same way.
-Alice copies the client key file to all of her cliens.
+Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-\fIntpkey_mvkey_\f[]\f\*[I-Font]bob\f[]
+\fIntpkey_mvkey_bob\f[]
to the client key file.
-As the MV scheme is independent of keys and certificates,
+As the
+\f\*[B-Font]MV\f[]
+scheme is independent of keys and certificates,
these files can be refreshed as needed.
.SS Command Line Options
.TP 7
-.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]scheme\f[]
-Select certificate message digest/signature encryption scheme.
+.NOP \f\*[B-Font]\-b\f[] \f\*[B-Font]\-\-imbits\f[]= \f\*[I-Font]modulus\f[]
+Set the number of bits in the identity modulus for generating identity keys to
+\f\*[I-Font]modulus\f[]
+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.
+.TP 7
+.NOP \f\*[B-Font]\-c\f[] \f\*[B-Font]\-\-certificate\f[]= \f\*[I-Font]scheme\f[]
+Select certificate signature encryption/message digest scheme.
The
\f\*[I-Font]scheme\f[]
can be one of the following:
-. Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA ,
+\f\*[B-Font]RSA-MD2\f[], \f\*[B-Font]RSA-MD5\f[], \f\*[B-Font]RSA-MDC2\f[], \f\*[B-Font]RSA-SHA\f[], \f\*[B-Font]RSA-SHA1\f[], \f\*[B-Font]RSA-RIPEMD160\f[], \f\*[B-Font]DSA-SHA\f[],
or
\f\*[B-Font]DSA-SHA1\f[].
-Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+Note that
+\f\*[B-Font]RSA\f[]
+schemes must be used with an
+\f\*[B-Font]RSA\f[]
+sign key and
+\f\*[B-Font]DSA\f[]
+schemes must be used with a
+\f\*[B-Font]DSA\f[]
+sign key.
The default without this option is
\f\*[B-Font]RSA-MD5\f[].
+If compatibility with FIPS 140-2 is required, either the
+\f\*[B-Font]DSA-SHA\f[]
+or
+\f\*[B-Font]DSA-SHA1\f[]
+scheme must be used.
.TP 7
-.NOP \f\*[B-Font]\-d\f[]
-Enable debugging.
+.NOP \f\*[B-Font]\-C\f[] \f\*[B-Font]\-\-cipher\f[]= \f\*[I-Font]cipher\f[]
+Select the OpenSSL cipher to encrypt the files containing private keys.
+The default without this option is three-key triple DES in CBC mode,
+\f\*[B-Font]des-ede3-cbc\f[].
+The
+\f\*[B-Font]openssl\f[] \f\*[B-Font]\-h\f[]
+command provided with OpenSSL displays available ciphers.
+.TP 7
+.NOP \f\*[B-Font]\-d\f[] \f\*[B-Font]\-\-debug-level\f[]
+Increase debugging verbosity level.
This option displays the cryptographic data produced in eye-friendly billboards.
.TP 7
-.NOP \f\*[B-Font]\-e\f[]
-Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
+.NOP \f\*[B-Font]\-D\f[] \f\*[B-Font]\-\-set-debug-level\f[]= \f\*[I-Font]level\f[]
+Set the debugging verbosity to
+\f\*[I-Font]level\f[].
+This option displays the cryptographic data produced in eye-friendly billboards.
.TP 7
-.NOP \f\*[B-Font]\-G\f[]
-Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
+.NOP \f\*[B-Font]\-e\f[] \f\*[B-Font]\-\-id-key\f[]
+Write the
+\f\*[B-Font]IFF\f[]
+or
+\f\*[B-Font]GQ\f[]
+public parameters from the
+\f\*[I-Font]IFFkey\f[] \f\*[I-Font]or\f[] \f\*[I-Font]GQkey\f[]
+client keys file previously specified
+as unencrypted data to the standard output stream
+\fIstdout\f[].
+This is intended for automatic key distribution by email.
.TP 7
-.NOP \f\*[B-Font]\-g\f[]
-Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
+.NOP \f\*[B-Font]\-G\f[] \f\*[B-Font]\-\-gq-params\f[]
+Generate a new encrypted
+\f\*[B-Font]GQ\f[]
+parameters and key file for the Guillou-Quisquater (GQ) identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-I\f[]
+and
+\f\*[B-Font]\-V\f[]
+options.
.TP 7
-.NOP \f\*[B-Font]\-H\f[]
-Generate new host keys, obsoleting any that may exist.
+.NOP \f\*[B-Font]\-H\f[] \f\*[B-Font]\-\-host-key\f[]
+Generate a new encrypted
+\f\*[B-Font]RSA\f[]
+public/private host key file.
.TP 7
-.NOP \f\*[B-Font]\-I\f[]
-Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
+.NOP \f\*[B-Font]\-I\f[] \f\*[B-Font]\-\-iffkey\f[]
+Generate a new encrypted
+\f\*[B-Font]IFF\f[]
+key file for the Schnorr (IFF) identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-G\f[]
+and
+Fl V
+options.
.TP 7
-.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]name\f[]
-Set the suject name to
-\f\*[I-Font]name\f[].
-This is used as the subject field in certificates
-and in the file name for host and sign keys.
+.NOP \f\*[B-Font]\-i\f[] \f\*[B-Font]\-\-ident\f[]= \f\*[I-Font]group\f[]
+Set the optional Autokey group name to
+\f\*[I-Font]group\f[].
+This is used in the identity scheme parameter file names of
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[],
+and
+\f\*[B-Font]MV\f[]
+client parameters files.
+In that role, the default is the host name if no group is provided.
+The group name, if specified using
+\f\*[B-Font]\-i\f[]
+or
+\f\*[B-Font]\-s\f[]
+following an
+\[oq]@@\[cq]
+character, is also used in certificate subject and issuer names in the form
+\f\*[I-Font]host\f[] \f\*[I-Font]@@\f[] \f\*[I-Font]group\f[]
+and should match the group specified via
+\f\*[B-Font]crypto\f[] \f\*[B-Font]ident\f[]
+or
+\f\*[B-Font]server\f[] \f\*[B-Font]ident\f[]
+in the ntpd configuration file.
.TP 7
-.NOP \f\*[B-Font]\-M\f[]
-Generate MD5 keys, obsoleting any that may exist.
+.NOP \f\*[B-Font]\-l\f[] \f\*[B-Font]\-\-lifetime\f[]= \f\*[I-Font]days\f[]
+Set the lifetime for certificate expiration to
+\f\*[I-Font]days\f[].
+The default lifetime is one year (365 days).
.TP 7
-.NOP \f\*[B-Font]\-P\f[]
-Generate a private certificate.
-By default, the program generates public certificates.
+.NOP \f\*[B-Font]\-m\f[] \f\*[B-Font]\-\-modulus\f[]= \f\*[I-Font]bits\f[]
+Set the number of bits in the prime modulus for generating files to
+\f\*[I-Font]bits\f[].
+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.
.TP 7
-.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
-Encrypt generated files containing private data with
-\f\*[I-Font]password\f[]
-and the DES-CBC algorithm.
+.NOP \f\*[B-Font]\-M\f[] \f\*[B-Font]\-\-md5key\f[]
+Generate a new symmetric keys file containing 10
+\f\*[B-Font]MD5\f[]
+keys, and if OpenSSL is available, 10
+\f\*[B-Font]SHA\f[]
+keys.
+An
+\f\*[B-Font]MD5\f[]
+key is a string of 20 random printable ASCII characters, while a
+\f\*[B-Font]SHA\f[]
+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.
.TP 7
-.NOP \f\*[B-Font]\-q\f[]
-Set the password for reading files to password.
+.NOP \f\*[B-Font]\-p\f[] \f\*[B-Font]\-\-password\f[]= \f\*[I-Font]passwd\f[]
+Set the password for reading and writing encrypted files to
+\f\*[I-Font]passwd\f[].
+These include the host, sign and identify key files.
+By default, the password is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
.TP 7
-.NOP \f\*[B-Font]\-S\f[] [\f\*[B-Font]RSA\f[] | \f\*[B-Font]DSA\f[]]
-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.
+.NOP \f\*[B-Font]\-P\f[] \f\*[B-Font]\-\-pvt-cert\f[]
+Generate a new private certificate used by the
+\f\*[B-Font]PC\f[]
+identity scheme.
+By default, the program generates public certificates.
+Note: the PC identity scheme is not recommended for new installations.
.TP 7
-.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]name\f[]
-Set the issuer name to
-\f\*[I-Font]name\f[].
-This is used for the issuer field in certificates
-and in the file name for identity files.
+.NOP \f\*[B-Font]\-q\f[] \f\*[B-Font]\-\-export-passwd\f[]= \f\*[I-Font]passwd\f[]
+Set the password for writing encrypted
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[] \f\*[B-Font]and\f[] \f\*[B-Font]MV\f[]
+identity files redirected to
+\fIstdout\f[]
+to
+\f\*[I-Font]passwd\f[].
+In effect, these files are decrypted with the
+\f\*[B-Font]\-p\f[]
+password, then encrypted with the
+\f\*[B-Font]\-q\f[]
+password.
+By default, the password is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
.TP 7
-.NOP \f\*[B-Font]\-T\f[]
+.NOP \f\*[B-Font]\-s\f[] \f\*[B-Font]\-\-subject-key\f[]= [host] [@@ \f\*[I-Font]group\f[]]
+Specify the Autokey host name, where
+\f\*[I-Font]host\f[]
+is the optional host name and
+\f\*[I-Font]group\f[]
+is the optional group name.
+The host name, and if provided, group name are used in
+\f\*[I-Font]host\f[] \f\*[I-Font]@@\f[] \f\*[I-Font]group\f[]
+form as certificate subject and issuer.
+Specifying
+\f\*[B-Font]\-s\f[] \f\*[B-Font]\-@@\f[] \f\*[I-Font]group\f[]
+is allowed, and results in leaving the host name unchanged, as with
+\f\*[B-Font]\-i\f[] \f\*[I-Font]group\f[].
+The group name, or if no group is provided, the host name are also used in the
+file names of
+\f\*[B-Font]IFF\f[], \f\*[B-Font]GQ\f[],
+and
+\f\*[B-Font]MV\f[]
+identity scheme client parameter files.
+If
+\f\*[I-Font]host\f[]
+is not specified, the default host name is the string returned by the Unix
+\f\*[B-Font]hostname\f[]
+command.
+.TP 7
+.NOP \f\*[B-Font]\-S\f[] \f\*[B-Font]\-\-sign-key\f[]= [\f\*[B-Font]RSA\f[] | \f\*[B-Font]DSA\f[]]
+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
+\f\*[B-Font]DSA\f[].
+.TP 7
+.NOP \f\*[B-Font]\-T\f[] \f\*[B-Font]\-\-trusted-cert\f[]
Generate a trusted certificate.
By default, the program generates a non-trusted certificate.
.TP 7
-.NOP \f\*[B-Font]\-V\f[] \f\*[I-Font]nkeys\f[]
-Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme.
+.NOP \f\*[B-Font]\-V\f[] \f\*[B-Font]\-\-mv-params\f[] \f\*[I-Font]nkeys\f[]
+Generate
+\f\*[I-Font]nkeys\f[]
+encrypted server keys and parameters for the Mu-Varadharajan (MV)
+identity scheme.
+This option is mutually exclusive with the
+\f\*[B-Font]\-I\f[]
+and
+\f\*[B-Font]\-G\f[]
+options.
+Note: support for this option should be considered a work in progress.
.PP
.SS Random Seed File
All cryptographically sound key generation schemes must have means
The entropy seed used by the OpenSSL library is contained in a file,
usually called
-\f\*[B-Font].rnd\f[],
+\fI.rnd\f[],
which must be available when starting the NTP daemon
or the
\f\*[B-Font]ntp-keygen\fP
RANDFILE
environment variable is not present,
the library will look for the
-\f\*[B-Font].rnd\f[]
+\fI.rnd\f[]
file in the user home directory.
+Since both the
+\f\*[B-Font]ntp-keygen\fP
+program and
+\fCntpd\f[]\fR(@NTPD_MS@)\f[]
+daemon must run as root, the logical place to put this file is in
+\fI/.rnd\f[]
+or
+\fI/root/.rnd\f[].
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.
.SS Cryptographic Data Files
-All other file formats begin with two lines.
-The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
-Lines beginning with # are considered comments and ignored by the
+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
+\fIntpkey_\f[]\f\*[I-Font]key\f[] \f\*[I-Font]_\f[] \f\*[I-Font]name\f[]. \f\*[I-Font]filestamp\f[],
+where
+\f\*[I-Font]key\f[]
+is the key or parameter type,
+\f\*[I-Font]name\f[]
+is the host or group name and
+\f\*[I-Font]filestamp\f[]
+is the filestamp (NTP seconds) when the file was created.
+By convention,
+\f\*[I-Font]key\f[]
+names in generated file names include both upper and lower case
+characters, while
+\f\*[I-Font]key\f[]
+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
+\fIdate\f[]
+format.
+Lines beginning with
+\[oq]#\[cq]
+are considered comments and ignored by the
\f\*[B-Font]ntp-keygen\fP
program and
\fCntpd\f[]\fR(@NTPD_MS@)\f[]
daemon.
-Cryptographic values are encoded first using ASN.1 rules,
-then encrypted if necessary, and finally written PEM-encoded
-printable ASCII format preceded and followed by MIME content identifier lines.
.sp \n(Ppu
.ne 2
-The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
-Since DES-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
-Following hte heard the keys are
-entered one per line in the format
+The remainder of the file contains cryptographic data, encoded first using ASN.1
+rules, then encrypted if necessary, and finally written in PEM-encoded
+printable ASCII text, preceded and followed by MIME content identifier lines.
+.sp \n(Ppu
+.ne 2
+
+The format of the symmetric keys file, ordinarily named
+\fIntp.keys\f[],
+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.
+.br
+.in +4
+.nf
+# ntpkey_MD5key_bk.ntp.org.3595864945
+# Thu Dec 12 19:22:25 2013
+1 MD5 L";Nw<\`.I<f4U0)247"i # MD5 key
+2 MD5 &>l0%XXK9O'51VwV<xq~ # MD5 key
+3 MD5 lb4zLW~d^!K:]RsD'qb6 # MD5 key
+4 MD5 Yue:tL[+vR)M\`n~bY,'? # MD5 key
+5 MD5 B;fx'Kgr/&4ZTbL6=RxA # MD5 key
+6 MD5 4eYwa\`o}3i@@@@V@@..R9!l # MD5 key
+7 MD5 \`A.([h+;wTQ|xfi%Sn_! # MD5 key
+8 MD5 45:V,r4]l6y^JH6"Sh?F # MD5 key
+9 MD5 3-5vcn*6l29DS?Xdsg)* # MD5 key
+10 MD5 2late4Me # MD5 key
+11 SHA1 a27872d3030a9025b8446c751b4551a7629af65c # SHA1 key
+12 SHA1 21bc3b4865dbb9e920902abdccb3e04ff97a5e74 # SHA1 key
+13 SHA1 2b7736fe24fef5ba85ae11594132ab5d6f6daba9 # SHA1 key
+14 SHA a5332809c8878dd3a5b918819108a111509aeceb # SHA key
+15 MD2 2fe16c88c760ff2f16d4267e36c1aa6c926e6964 # MD2 key
+16 MD4 b2691811dc19cfc0e2f9bcacd74213f29812183d # MD4 key
+17 MD5 e4d6735b8bdad58ec5ffcb087300a17f7fef1f7c # MD5 key
+18 MDC2 a8d5e2315c025bf3a79174c87fbd10477de2eabc # MDC2 key
+19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
+20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
+.in -4
+.fi
+.in +4
+Figure 1. Typical Symmetric Key File
+.in -4
+.sp \n(Ppu
+.ne 2
+
+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
.in +4
\f\*[I-Font]keyno\f[] \f\*[I-Font]type\f[] \f\*[I-Font]key\f[]
.in -4
where
\f\*[I-Font]keyno\f[]
-is a positive integer in the range 1-65,535,
+is a positive integer in the range 1-65534;
\f\*[I-Font]type\f[]
-is the string MD5 defining the key format and
+is the key type for the message digest algorithm, which in the absence of the
+OpenSSL library must be
+\f\*[B-Font]MD5\f[]
+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
+\f\*[B-Font]SHA\f[]
+or
+\f\*[B-Font]SHA1\f[];
\f\*[I-Font]key\f[]
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
-Each character is chosen from the 93 printable characters
-in the range 0x21 through 0x7f excluding space and the
+which is a printable ASCII string 20 characters or less in length:
+each character is chosen from the 93 printable characters
+in the range 0x21 through 0x7e (
+\[oq]\[cq]!
+through
+\[oq]~\[cq]
+\&) excluding space and the
+\[oq]#\[cq]
+character, and terminated by whitespace or a
\[oq]#\[cq]
character.
+An OpenSSL key consists of a hex-encoded ASCII string of 40 characters, which
+is truncated as necessary.
.sp \n(Ppu
.ne 2
The
\f\*[B-Font]ntp-keygen\fP
-program generates a MD5 symmetric keys file
-\fIntpkey_MD5key_\f[]\f\*[I-Font]hostname.filestamp\f[].
+program generates a symmetric keys file
+\fIntpkey_MD5key_\f[]\f\*[I-Font]hostname\f[]. \f\*[I-Font]filestamp\f[].
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
certificate scheme.
.sp
scheme is one of
-RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160,
+RSA-MD2, RSA-MD5, RSA-MDC2, RSA-SHA, RSA-SHA1, RSA-RIPEMD160,
DSA-SHA, or DSA-SHA1.
.sp
-Select the certificate message digest/signature encryption scheme.
+Select the certificate signature encryption/message digest scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
this option is RSA-MD5.
.sp
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". The openssl tool lists ciphers
+equivalent to "\fB-C des-ede3-cbc\fP". The openssl tool lists ciphers
available in "\fBopenssl \-h\fP" output.
.TP
.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[]
.NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-id\-key\f[]
Write IFF or GQ identity keys.
.sp
-Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
+Write the public parameters from the IFF or GQ client keys to
+the standard output.
+This is intended for automatic key distribution by email.
.TP
.NOP \f\*[B-Font]\-G\f[], \f\*[B-Font]\-\-gq\-params\f[]
Generate GQ parameters and keys.
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 \fB-i/--ident\fP or
-using \fB-s/--subject-name\fP following an '\fB@\fP' character,
-is also a part of the self-signed host certificate's subject and
-issuer names in the form \fBhost@group\fP and should match the
-'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in
-\fBntpd\fP's configuration file.
+using \fB-s/--subject-name\fP following an '\fB@@\fP' character,
+is also a part of the self-signed host certificate subject and
+issuer names in the form \fBhost@@group\fP and should match the
+'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in the
+\fBntpd\fP configuration file.
.TP
.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]lifetime\f[], \f\*[B-Font]\-\-lifetime\f[]=\f\*[I-Font]lifetime\f[]
set certificate lifetime.
.sp
Set the certificate expiration to lifetime days from now.
.TP
-.NOP \f\*[B-Font]\-M\f[], \f\*[B-Font]\-\-md5key\f[]
-generate MD5 keys.
-.sp
-Generate MD5 keys, obsoleting any that may exist.
-.TP
.NOP \f\*[B-Font]\-m\f[] \f\*[I-Font]modulus\f[], \f\*[B-Font]\-\-modulus\f[]=\f\*[I-Font]modulus\f[]
-modulus.
+prime modulus.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]modulus\f[]
.sp
The number of bits in the prime modulus. The default is 512.
.TP
+.NOP \f\*[B-Font]\-M\f[], \f\*[B-Font]\-\-md5key\f[]
+generate symmetric keys.
+.sp
+Generate symmetric keys, obsoleting any that may exist.
+.TP
.NOP \f\*[B-Font]\-P\f[], \f\*[B-Font]\-\-pvt\-cert\f[]
generate PC private certificate.
.sp
"crypto pw password" configuration command. See also the option
--id-key (-e) for unencrypted exports.
.TP
-.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]sign\f[], \f\*[B-Font]\-\-sign\-key\f[]=\f\*[I-Font]sign\f[]
-generate sign key (RSA or DSA).
-.sp
-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.
-.TP
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]host@group\f[], \f\*[B-Font]\-\-subject\-name\f[]=\f\*[I-Font]host@group\f[]
set host and optionally group name.
.sp
Set the Autokey host name, and optionally, group name specified
-following an '\fB@\fP' character. The host name is used in the file
+following an '\fB@@\fP' 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 \fBhost@group\fP form for the host certificate's subject and issuer
-fields. Specifying '\fB-s @group\fP' is allowed, and results in
-leaving the host name unchanged while appending \fB@group\fP to the
+in \fBhost@@group\fP form for the host certificate subject and issuer
+fields. Specifying '\fB-s @@group\fP' is allowed, and results in
+leaving the host name unchanged while appending \fB@@group\fP to the
subject and issuer fields, as with \fB-i group\fP. 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.
.TP
+.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]sign\f[], \f\*[B-Font]\-\-sign\-key\f[]=\f\*[I-Font]sign\f[]
+generate sign key (RSA or DSA).
+.sp
+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.
+.TP
.NOP \f\*[B-Font]\-T\f[], \f\*[B-Font]\-\-trusted\-cert\f[]
trusted certificate (TC scheme).
.sp
If any of these are directories, then the file \fI.ntprc\fP
is searched for within those directories.
.SH USAGE
-The
-\f\*[B-Font]\-p\f[] \f\*[I-Font]password\f[]
-option specifies the write password and
-\f\*[B-Font]\-q\f[] \f\*[I-Font]password\f[]
-option the read password for previously encrypted files.
-The
-\f\*[B-Font]ntp-keygen\fP
-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
-no write password is specified, the read password is used
-as the write password by default.
.SH "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.SH "FILES"
Copyright (C) 1992-2017 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,
-from one to several minutes with modern architectures
-such as UltraSPARC and up to tens of minutes to an hour
-with older architectures such as SPARC IPC.
+It can take quite a while to generate some cryptographic values.
.sp \n(Ppu
.ne 2
-.Dd January 2 2017
+.Dd March 19 2017
.Dt NTP_KEYGEN @NTP_KEYGEN_MS@ User Commands
.Os
.\" EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.mdoc)
.\"
-.\" It has been AutoGen-ed January 2, 2017 at 12:05:35 PM by AutoGen 5.18.5
+.\" It has been AutoGen-ed March 19, 2017 at 10:10:39 AM by AutoGen 5.18.5
.\" From the definitions ntp-keygen-opts.def
.\" and the template file agmdoc-cmd.tpl
.Sh NAME
.Sh DESCRIPTION
This program generates cryptographic data files used by the NTPv4
authentication and identification schemes.
-It generates MD5 key files used in symmetric key cryptography.
-In addition, if the OpenSSL software library has been installed,
-it generates keys, certificate and identity files used in public key
-cryptography.
+It can generate message digest keys used in symmetric key cryptography and,
+if the OpenSSL software library has been installed, it can generate host keys,
+signing keys, certificates, and identity keys and parameters used in Autokey
+public key cryptography.
These files are used for cookie encryption,
-digital signature and challenge/response identification algorithms
+digital signature, and challenge/response identification algorithms
compatible with the Internet standard security infrastructure.
.Pp
-All files are in PEM\-encoded printable ASCII format,
-so they can be embedded as MIME attachments in mail to other sites
+The message digest symmetric keys file is generated in a format
+compatible with NTPv3.
+All other files are in PEM\-encoded printable ASCII format,
+so they can be embedded as MIME attachments in email to other sites
and certificate authorities.
By default, files are not encrypted.
.Pp
-When used to generate message digest keys, the program produces a file
-containing ten pseudo\-random printable ASCII strings suitable for the
-MD5 message digest algorithm included in the distribution.
+When used to generate message digest symmetric keys, the program
+produces a file containing ten pseudo\-random printable ASCII strings
+suitable for the MD5 message digest algorithm included in the
+distribution.
If the OpenSSL library is installed, it produces an additional ten
-hex\-encoded random bit strings suitable for the SHA1 and other message
-digest algorithms.
-The message digest keys file must be distributed and stored
+hex\-encoded random bit strings suitable for SHA1, AES\-128\-CMAC, and
+other message digest algorithms.
+The message digest symmetric keys file must be distributed and stored
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
Some files used by this program are encrypted using a private password.
The
.Fl p
-option specifies the password for local encrypted files and the
+option specifies the read password for local encrypted files and the
.Fl q
-option the password for encrypted files sent to remote sites.
+option the write password for encrypted files sent to remote sites.
If no password is specified, the host name returned by the Unix
-.Fn gethostname
-function, normally the DNS name of the host is used.
+.Xr hostname 1
+command, normally the DNS name of the host, is used as the the default read
+password, for convenience.
+The
+.Nm
+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
+no write password is specified, the read password is used
+as the write password by default.
.Pp
The
-.Ar pw
+.Cm pw
option of the
-.Ar crypto
+.Ic crypto
+.Xr ntpd @NTPD_MS@
configuration command specifies the read
password for previously encrypted local files.
-This must match the local password used by this program.
+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 password,
+Thus, if files are generated by this program without an explicit password,
they can be read back by
-.Ar ntpd
-without password but only on the same host.
+.Xr ntpd @NTPD_MS@
+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.
.Pp
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
-.Ar ntp.keys ,
+.Pa ntp.keys ,
is usually installed in
.Pa /etc .
Other files and links are usually installed in
.Pa /usr/local/etc ,
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
-.Ar keysdir
-configuration command in such cases.
-Normally, this is in
-.Pa /etc .
+In these cases, NFS clients can specify the files in another
+directory such as
+.Pa /etc
+using the
+.Ic keysdir
+.Xr ntpd @NTPD_MS@
+configuration file command.
.Pp
This program directs commentary and error messages to the standard
error stream
-.Ar stderr
+.Pa stderr
and remote files to the standard output stream
-.Ar stdout
+.Pa stdout
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
-.Ar ntpkey
+.Pa ntpkey\&*
and include the file type, generating host and filestamp,
as described in the
-.Dq Cryptographic Data Files
+.Sx "Cryptographic Data Files"
section below.
.Ss Running the Program
-To test and gain experience with Autokey concepts, log in as root and
-change to the keys directory, usually
-.Pa /usr/local/etc
-When run for the first time, or if all files with names beginning with
-.Ar ntpkey
-have been removed, use the
-.Nm
-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
-existing keys and parameters and generates only a new certificate with
-new expiration date one year hence.
-.Pp
-Run the command on as many hosts as necessary.
-Designate one of them as the trusted host (TH) using
-.Nm
-with the
-.Fl T
-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
-ascendant host towards the TH to sign its certificate, which is then
-provided to the immediately descendant host on request.
-All group hosts should have acyclic certificate trails ending on the TH.
-.Pp
-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
-.Fl S
-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
-.Fl c
-option.
-The rules say cryptographic media should be generated with proventic
-filestamps, which means the host should already be synchronized before
-this program is run.
-This of course creates a chicken\-and\-egg problem
-when the host is started for the first time.
-Accordingly, the host time
-should be set by some other means, such as eyeball\-and\-wristwatch, at
-least so that the certificate lifetime is within the current year.
-After that and when the host is synchronized to a proventic source, the
-certificate should be re\-generated.
-.Pp
-Additional information on trusted groups and identity schemes is on the
-.Dq Autokey Public\-Key Authentication
-page.
-.Pp
-The
-.Xr ntpd @NTPD_MS@
-configuration command
-.Ic crypto pw Ar password
-specifies the read password for previously encrypted files.
-The daemon expires on the spot if the password is missing
-or incorrect.
-For convenience, if a file has been previously encrypted,
-the default read password is the name of the host running
-the program.
-If the previous write password is specified as the host name,
-these files can be read by that host with no explicit password.
-.Pp
-File names begin with the prefix
-.Cm ntpkey_
-and end with the postfix
-.Ar _hostname.filestamp ,
-where
-.Ar hostname
-is the owner name, usually the string returned
-by the Unix gethostname() routine, and
-.Ar filestamp
-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
-.Ic rm ntpkey\&*
-command or all files generated
-at a specific time can be removed by a
-.Ic rm
-.Ar \&*filestamp
-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.
-.Pp
-All files are installed by default in the keys directory
-.Pa /usr/local/etc ,
-which is normally in a shared filesystem
-in NFS\-mounted networks.
-The actual location of the keys directory
-and each file can be overridden by configuration commands,
-but this is not recommended.
-Normally, the files for each host are generated by that host
-and used only by that host, although exceptions exist
-as noted later on this page.
-.Pp
-Normally, files containing private values,
-including the host key, sign key and identification parameters,
-are permitted root read/write\-only;
-while others containing public values are permitted world readable.
-Alternatively, files containing private values can be encrypted
-and these files permitted world readable,
-which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
-dependent clients can all be installed in the same shared directory.
-.Pp
-The recommended practice is to keep the file name extensions
-when installing a file and to install a soft link
-from the generic names specified elsewhere on this page
-to the generated files.
-This allows new file generations to be activated simply
-by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
-If a link is not present,
-.Xr ntpd @NTPD_MS@
-extracts the filestamp from the file itself.
-This allows clients to verify that the file and generation times
-are always current.
-The
-.Nm
-program uses the same timestamp extension for all files generated
-at one time, so each generation is distinct and can be readily
-recognized in monitoring data.
-.Ss Running the program
The safest way to run the
.Nm
program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
+The recommended procedure is change to the
+.Ar keys
+directory, usually
.Pa /usr/local/etc ,
then run the program.
-When run for the first time,
-or if all
-.Cm ntpkey
-files have been removed,
-the program generates a RSA host key file and matching RSA\-MD5 certificate file,
+.Pp
+To test and gain experience with Autokey concepts, log in as root and
+change to the
+.Ar keys
+directory, usually
+.Pa /usr/local/etc .
+When run for the first time, or if all files with names beginning with
+.Pa ntpkey\&*
+have been removed, use the
+.Nm
+command without arguments to generate a default
+.Cm RSA
+host key and matching
+.Cm RSA\-MD5
+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
to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+If run again without options, the program uses the
+existing keys and parameters and generates a new certificate file with
+new expiration date one year hence, and soft link.
.Pp
-The host key is used to encrypt the cookie when required and so must be RSA type.
+The host key is used to encrypt the cookie when required and so must be
+.Cm RSA
+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 RSA or DSA type.
-By default, the message digest type is MD5, but any combination
+either
+.Cm RSA
+or
+.Cm DSA
+type.
+By default, the message digest type is
+.Cm MD5 ,
+but any combination
of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 message digest algorithms.
+can be specified, including those using the
+.Cm AES128CMAC , MD2 , MD5 , MDC2 , SHA , SHA1
+and
+.Cm RIPE160
+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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+Certificates using any digest algorithm are compatible with
+.Cm RSA
+sign keys;
+however, only
+.Cm SHA
+and
+.Cm SHA1
+certificates are compatible with
+.Cm DSA
+sign keys.
.Pp
Private/public key files and certificates are compatible with
other OpenSSL applications and very likely other libraries as well.
as the other files, are probably not compatible with anything other than Autokey.
.Pp
Running the program as other than root and using the Unix
-.Ic su
+.Xr su 1
command
to assume root may not work properly, since by default the OpenSSL library
looks for the random seed file
-.Cm .rnd
+.Pa .rnd
in the user home directory.
However, there should be only one
-.Cm .rnd ,
+.Pa .rnd ,
most conveniently
in the root directory, so it is convenient to define the
-.Cm $RANDFILE
+.Ev RANDFILE
environment variable used by the OpenSSL library as the path to
-.Cm /.rnd .
+.Pa .rnd .
.Pp
Installing the keys as root might not work in NFS\-mounted
shared file systems, as NFS clients may not be able to write
.Pa /etc
using the
.Ic keysdir
-command.
+.Xr ntpd @NTPD_MS@
+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
by the Autokey protocol.
Alternatively, files containing private values can be encrypted
and these files permitted world readable,
which simplifies maintenance in shared file systems.
-Since uniqueness is insured by the hostname and
-file name extensions, the files for a NFS server and
+Since uniqueness is insured by the
+.Ar hostname
+and
+.Ar filestamp
+file name extensions, the files for an NTP server and
dependent clients can all be installed in the same shared directory.
.Pp
The recommended practice is to keep the file name extensions
to the generated files.
This allows new file generations to be activated simply
by changing the link.
-If a link is present, ntpd follows it to the file name
-to extract the filestamp.
+If a link is present,
+.Xr ntpd @NTPD_MS@
+follows it to the file name to extract the
+.Ar filestamp .
If a link is not present,
.Xr ntpd @NTPD_MS@
-extracts the filestamp from the file itself.
+extracts the
+.Ar filestamp
+from the file itself.
This allows clients to verify that the file and generation times
are always current.
The
.Nm
-program uses the same timestamp extension for all files generated
+program uses the same
+.Ar filestamp
+extension for all files generated
at one time, so each generation is distinct and can be readily
recognized in monitoring data.
-.Ss Running the program
-The safest way to run the
+.Pp
+Run the command on as many hosts as necessary.
+Designate one of them as the trusted host (TH) using
.Nm
-program is logged in directly as root.
-The recommended procedure is change to the keys directory,
-usually
-.Pa /usr/local/etc ,
-then run the program.
-When run for the first time,
-or if all
-.Cm ntpkey
-files have been removed,
-the program generates a RSA host key file and matching RSA\-MD5 certificate file,
-which is all that is necessary in many cases.
-The program also generates soft links from the generic names
-to the respective files.
-If run again, the program uses the same host key file,
-but generates a new certificate file and link.
+with the
+.Fl T
+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
+ascendant host towards the TH to sign its certificate, which is then
+provided to the immediately descendant host on request.
+All group hosts should have acyclic certificate trails ending on the TH.
.Pp
-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.
-When necessary, a different sign key can be specified and this can be
-either RSA or DSA type.
-By default, the message digest type is MD5, but any combination
-of sign key type and message digest type supported by the OpenSSL library
-can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2
-and RIPE160 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 RSA sign keys;
-however, only SHA and SHA1 certificates are compatible with DSA sign keys.
+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
+.Fl S
+option and this can be either
+.Cm RSA
+or
+.Cm DSA
+type.
+By default, the signature
+message digest type is
+.Cm MD5 ,
+but any combination of sign key type and
+message digest type supported by the OpenSSL library can be specified
+using the
+.Fl c
+option.
.Pp
-Private/public key files and certificates are compatible with
-other OpenSSL applications and very likely other libraries as well.
-Certificates or certificate requests derived from them should be compatible
-with extant industry practice, although some users might find
-the interpretation of X509v3 extension fields somewhat liberal.
-However, the identification parameter files, although encoded
-as the other files, are probably not compatible with anything other than Autokey.
+The rules say cryptographic media should be generated with proventic
+filestamps, which means the host should already be synchronized before
+this program is run.
+This of course creates a chicken\-and\-egg problem
+when the host is started for the first time.
+Accordingly, the host time
+should be set by some other means, such as eyeball\-and\-wristwatch, at
+least so that the certificate lifetime is within the current year.
+After that and when the host is synchronized to a proventic source, the
+certificate should be re\-generated.
.Pp
-Running the program as other than root and using the Unix
-.Ic su
-command
-to assume root may not work properly, since by default the OpenSSL library
-looks for the random seed file
-.Cm .rnd
-in the user home directory.
-However, there should be only one
-.Cm .rnd ,
-most conveniently
-in the root directory, so it is convenient to define the
-.Cm $RANDFILE
-environment variable used by the OpenSSL library as the path to
-.Cm /.rnd .
+Additional information on trusted groups and identity schemes is on the
+.Dq Autokey Public\-Key Authentication
+page.
.Pp
-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
-.Pa /etc
-using the
-.Ic keysdir
+File names begin with the prefix
+.Pa ntpkey Ns _
+and end with the suffix
+.Pa _ Ns Ar hostname . Ar filestamp ,
+where
+.Ar hostname
+is the owner name, usually the string returned
+by the Unix
+.Xr hostname 1
+command, and
+.Ar filestamp
+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
+.Ic rm Pa ntpkey\&*
+command or all files generated
+at a specific time can be removed by a
+.Ic rm Pa \&* Ns Ar filestamp
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
-by the Autokey protocol.
-.Pp
-Ordinarily, cryptographic files are generated by the host that uses them,
-but it is possible for a trusted agent (TA) to generate these files
-for other hosts; however, in such cases files should always be encrypted.
-The subject name and trusted name default to the hostname
-of the host generating the files, but can be changed by command line options.
-It is convenient to designate the owner name and trusted name
-as the subject and issuer fields, respectively, of the certificate.
-The owner name is also used for the host and sign key files,
-while the trusted name is used for the identity files.
-seconds.
-seconds.
-s Trusted Hosts and Groups
+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.
+.Ss Trusted Hosts and Groups
Each cryptographic configuration involves selection of a signature scheme
and identification scheme, called a cryptotype,
as explained in the
.Sx Authentication Options
section of
.Xr ntp.conf 5 .
-The default cryptotype uses RSA encryption, MD5 message digest
-and TC identification.
+The default cryptotype uses
+.Cm RSA
+encryption,
+.Cm MD5
+message digest
+and
+.Cm TC
+identification.
First, configure a NTP subnet including one or more low\-stratum
trusted hosts from which all other hosts derive synchronization
directly or indirectly.
.Pp
On each trusted host as root, change to the keys directory.
To insure a fresh fileset, remove all
-.Cm ntpkey
+.Pa ntpkey
files.
Then run
.Nm
.Cm RSA
or
.Cm DSA .
-The most often need to do this is when a DSA\-signed certificate is used.
+The most frequent need to do this is when a
+.Cm DSA Ns \-signed
+certificate is used.
If it is necessary to use a different certificate scheme than the default,
run
.Nm
option and selected
.Ar scheme
as needed.
-f
+If
.Nm
is run again without these options, it generates a new certificate
-using the same scheme and sign key.
+using the same scheme and sign key, and soft link.
.Pp
After setting up the environment it is advisable to update certificates
from time to time, if only to extend the validity interval.
Simply run
.Nm
with the same flags as before to generate new certificates
-using existing keys.
+using existing keys, and soft links.
However, if the host or sign key is changed,
.Xr ntpd @NTPD_MS@
should be restarted.
at which time the protocol is restarted.
.Ss Identity Schemes
As mentioned on the Autonomous Authentication page,
-the default TC identity scheme is vulnerable to a middleman attack.
+the default
+.Cm TC
+identity scheme is vulnerable to a middleman attack.
However, there are more secure identity schemes available,
-including PC, IFF, GQ and MV described on the
-.Qq Identification Schemes
-page
-(maybe available at
-.Li http://www.eecis.udel.edu/%7emills/keygen.html ) .
+including
+.Cm PC , IFF , GQ
+and
+.Cm MV
+schemes described below.
These schemes are based on a TA, one or more trusted hosts
and some number of nontrusted hosts.
Trusted hosts prove identity using values provided by the TA,
.Fl P
.Fl p Ar password
to generate the host key file
-.Pa ntpkey_RSAkey_ Ns Ar alice.filestamp
+.Pa ntpkey Ns _ Cm RSA Pa key_alice. Ar filestamp
and trusted private certificate file
-.Pa ntpkey_RSA\-MD5_cert_ Ns Ar alice.filestamp .
+.Pa ntpkey Ns _ Cm RSA\-MD5 _ Pa cert_alice. Ar filestamp ,
+and soft links.
Copy both files to all group hosts;
they replace the files which would be generated in other schemes.
-On each host bob install a soft link from the generic name
+On each host
+.Ar bob
+install a soft link from the generic name
.Pa ntpkey_host_ Ns Ar bob
to the host key file and soft link
.Pa ntpkey_cert_ Ns Ar bob
by trusted host alice.
In this scheme it is not possible to refresh
either the keys or certificates without copying them
-to all other hosts in the group.
+to all other hosts in the group, and recreating the soft links.
.Pp
-For the IFF scheme proceed as in the TC scheme to generate keys
+For the
+.Cm IFF
+scheme proceed as in the
+.Cm TC
+scheme to generate keys
and certificates for all group hosts, then for every trusted host in the group,
-generate the IFF parameter file.
+generate the
+.Cm IFF
+parameter file.
On trusted host alice run
.Nm
.Fl T
.Fl I
.Fl p Ar password
to produce her parameter file
-.Pa ntpkey_IFFpar_ Ns Ar alice.filestamp ,
+.Pa ntpkey_IFFpar_alice. Ns Ar filestamp ,
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
-.Pa ntpkey_iff_ Ns Ar alice
+.Pa ntpkey_iff_alice
to this file.
If there are no hosts restricted to operate only as clients,
there is nothing further to do.
-As the IFF scheme is independent
+As the
+.Cm IFF
+scheme is independent
of keys and certificates, these files can be refreshed as needed.
.Pp
If a rogue client has the parameter file, it could masquerade
After generating the parameter file, on alice run
.Nm
.Fl e
-and pipe the output to a file or mail program.
-Copy or mail this file to all restricted clients.
+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
-.Pa ntpkey_iff_ Ns Ar alice
+.Pa ntpkey_iff_alice
to this file.
To further protect the integrity of the keys,
each file can be encrypted with a secret password.
.Pp
-For the GQ scheme proceed as in the TC scheme to generate keys
+For the
+.Cm GQ
+scheme proceed as in the
+.Cm TC
+scheme to generate keys
and certificates for all group hosts, then for every trusted host
-in the group, generate the IFF parameter file.
+in the group, generate the
+.Cm IFF
+parameter file.
On trusted host alice run
.Nm
.Fl T
.Fl G
.Fl p Ar password
to produce her parameter file
-.Pa ntpkey_GQpar_ Ns Ar alice.filestamp ,
+.Pa ntpkey_GQpar_alice. Ns Ar filestamp ,
which includes both server and client keys.
Copy this file to all group hosts and install a soft link
from the generic
-.Pa ntpkey_gq_ Ns Ar alice
+.Pa ntpkey_gq_alice
to this file.
-In addition, on each host bob install a soft link
+In addition, on each host
+.Ar bob
+install a soft link
from generic
.Pa ntpkey_gq_ Ns Ar bob
to this file.
-As the GQ scheme updates the GQ parameters file and certificate
+As the
+.Cm GQ
+scheme updates the
+.Cm GQ
+parameters file and certificate
at the same time, keys and certificates can be regenerated as needed.
.Pp
-For the MV scheme, proceed as in the TC scheme to generate keys
+For the
+.Cm MV
+scheme, proceed as in the
+.Cm TC
+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.
.Ar n
is the number of revokable keys (typically 5) to produce
the parameter file
-.Pa ntpkeys_MVpar_ Ns Ar trish.filestamp
+.Pa ntpkeys_MVpar_trish. Ns Ar filestamp
and client key files
-.Pa ntpkeys_MVkeyd_ Ns Ar trish.filestamp
+.Pa ntpkeys_MVkey Ns Ar d _ Pa trish. Ar filestamp
where
.Ar d
is the key number (0 \&<
.Ar n ) .
Copy the parameter file to alice and install a soft link
from the generic
-.Pa ntpkey_mv_ Ns Ar alice
+.Pa ntpkey_mv_alice
to this file.
Copy one of the client key files to alice for later distribution
to her clients.
-It doesn't matter which client key file goes to alice,
+It does not matter which client key file goes to alice,
since they all work the same way.
-Alice copies the client key file to all of her cliens.
+Alice copies the client key file to all of her clients.
On client bob install a soft link from generic
-.Pa ntpkey_mvkey_ Ns Ar bob
+.Pa ntpkey_mvkey_bob
to the client key file.
-As the MV scheme is independent of keys and certificates,
+As the
+.Cm MV
+scheme is independent of keys and certificates,
these files can be refreshed as needed.
.Ss Command Line Options
.Bl -tag -width indent
-.It Fl c Ar scheme
-Select certificate message digest/signature encryption scheme.
+.It Fl b Fl \-imbits Ns = Ar modulus
+Set the number of bits in the identity modulus for generating identity keys to
+.Ar modulus
+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.
+.It Fl c Fl \-certificate Ns = Ar scheme
+Select certificate signature encryption/message digest scheme.
The
.Ar scheme
can be one of the following:
-. Cm RSA\-MD2 , RSA\-MD5 , RSA\-SHA , RSA\-SHA1 , RSA\-MDC2 , RSA\-RIPEMD160 , DSA\-SHA ,
+.Cm RSA\-MD2 , RSA\-MD5 , RSA\-MDC2 , RSA\-SHA , RSA\-SHA1 , RSA\-RIPEMD160 , DSA\-SHA ,
or
.Cm DSA\-SHA1 .
-Note that RSA schemes must be used with a RSA sign key and DSA
-schemes must be used with a DSA sign key.
+Note that
+.Cm RSA
+schemes must be used with an
+.Cm RSA
+sign key and
+.Cm DSA
+schemes must be used with a
+.Cm DSA
+sign key.
The default without this option is
.Cm RSA\-MD5 .
-.It Fl d
-Enable debugging.
+If compatibility with FIPS 140\-2 is required, either the
+.Cm DSA\-SHA
+or
+.Cm DSA\-SHA1
+scheme must be used.
+.It Fl C Fl \-cipher Ns = Ar cipher
+Select the OpenSSL cipher to encrypt the files containing private keys.
+The default without this option is three\-key triple DES in CBC mode,
+.Cm des\-ede3\-cbc .
+The
+.Ic openssl Fl h
+command provided with OpenSSL displays available ciphers.
+.It Fl d Fl \-debug\-level
+Increase debugging verbosity level.
This option displays the cryptographic data produced in eye\-friendly billboards.
-.It Fl e
-Write the IFF client keys to the standard output.
-This is intended for automatic key distribution by mail.
-.It Fl G
-Generate parameters and keys for the GQ identification scheme,
-obsoleting any that may exist.
-.It Fl g
-Generate keys for the GQ identification scheme
-using the existing GQ parameters.
-If the GQ parameters do not yet exist, create them first.
-.It Fl H
-Generate new host keys, obsoleting any that may exist.
-.It Fl I
-Generate parameters for the IFF identification scheme,
-obsoleting any that may exist.
-.It Fl i Ar name
-Set the suject name to
-.Ar name .
-This is used as the subject field in certificates
-and in the file name for host and sign keys.
-.It Fl M
-Generate MD5 keys, obsoleting any that may exist.
-.It Fl P
-Generate a private certificate.
+.It Fl D Fl \-set\-debug\-level Ns = Ar level
+Set the debugging verbosity to
+.Ar level .
+This option displays the cryptographic data produced in eye\-friendly billboards.
+.It Fl e Fl \-id\-key
+Write the
+.Cm IFF
+or
+.Cm GQ
+public parameters from the
+.Ar IFFkey or GQkey
+client keys file previously specified
+as unencrypted data to the standard output stream
+.Pa stdout .
+This is intended for automatic key distribution by email.
+.It Fl G Fl \-gq\-params
+Generate a new encrypted
+.Cm GQ
+parameters and key file for the Guillou\-Quisquater (GQ) identity scheme.
+This option is mutually exclusive with the
+.Fl I
+and
+.Fl V
+options.
+.It Fl H Fl \-host\-key
+Generate a new encrypted
+.Cm RSA
+public/private host key file.
+.It Fl I Fl \-iffkey
+Generate a new encrypted
+.Cm IFF
+key file for the Schnorr (IFF) identity scheme.
+This option is mutually exclusive with the
+.Fl G
+and
+Fl V
+options.
+.It Fl i Fl \-ident Ns = Ar group
+Set the optional Autokey group name to
+.Ar group .
+This is used in the identity scheme parameter file names of
+.Cm IFF , GQ ,
+and
+.Cm MV
+client parameters files.
+In that role, the default is the host name if no group is provided.
+The group name, if specified using
+.Fl i
+or
+.Fl s
+following an
+.Ql @
+character, is also used in certificate subject and issuer names in the form
+.Ar host @ group
+and should match the group specified via
+.Ic crypto Cm ident
+or
+.Ic server Cm ident
+in the ntpd configuration file.
+.It Fl l Fl \-lifetime Ns = Ar days
+Set the lifetime for certificate expiration to
+.Ar days .
+The default lifetime is one year (365 days).
+.It Fl m Fl \-modulus Ns = Ar bits
+Set the number of bits in the prime modulus for generating files to
+.Ar bits .
+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.
+.It Fl M Fl \-md5key
+Generate a new symmetric keys file containing 10
+.Cm MD5
+keys, and if OpenSSL is available, 10
+.Cm SHA
+keys.
+An
+.Cm MD5
+key is a string of 20 random printable ASCII characters, while a
+.Cm SHA
+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.
+.It Fl p Fl \-password Ns = Ar passwd
+Set the password for reading and writing encrypted files to
+.Ar passwd .
+These include the host, sign and identify key files.
+By default, the password is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl P Fl \-pvt\-cert
+Generate a new private certificate used by the
+.Cm PC
+identity scheme.
By default, the program generates public certificates.
-.It Fl p Ar password
-Encrypt generated files containing private data with
-.Ar password
-and the DES\-CBC algorithm.
-.It Fl q
-Set the password for reading files to password.
-.It Fl S Oo Cm RSA | DSA Oc
-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.
-.It Fl s Ar name
-Set the issuer name to
-.Ar name .
-This is used for the issuer field in certificates
-and in the file name for identity files.
-.It Fl T
+Note: the PC identity scheme is not recommended for new installations.
+.It Fl q Fl \-export\-passwd Ns = Ar passwd
+Set the password for writing encrypted
+.Cm IFF , GQ and MV
+identity files redirected to
+.Pa stdout
+to
+.Ar passwd .
+In effect, these files are decrypted with the
+.Fl p
+password, then encrypted with the
+.Fl q
+password.
+By default, the password is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl s Fl \-subject\-key Ns = Ar Oo host Oc Op @ Ar group
+Specify the Autokey host name, where
+.Ar host
+is the optional host name and
+.Ar group
+is the optional group name.
+The host name, and if provided, group name are used in
+.Ar host @ group
+form as certificate subject and issuer.
+Specifying
+.Fl s @ Ar group
+is allowed, and results in leaving the host name unchanged, as with
+.Fl i Ar group .
+The group name, or if no group is provided, the host name are also used in the
+file names of
+.Cm IFF , GQ ,
+and
+.Cm MV
+identity scheme client parameter files.
+If
+.Ar host
+is not specified, the default host name is the string returned by the Unix
+.Ic hostname
+command.
+.It Fl S Fl \-sign\-key Ns = Op Cm RSA | DSA
+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
+.Cm DSA .
+.It Fl T Fl \-trusted\-cert
Generate a trusted certificate.
By default, the program generates a non\-trusted certificate.
-.It Fl V Ar nkeys
-Generate parameters and keys for the Mu\-Varadharajan (MV) identification scheme.
+.It Fl V Fl \-mv\-params Ar nkeys
+Generate
+.Ar nkeys
+encrypted server keys and parameters for the Mu\-Varadharajan (MV)
+identity scheme.
+This option is mutually exclusive with the
+.Fl I
+and
+.Fl G
+options.
+Note: support for this option should be considered a work in progress.
.El
.Ss Random Seed File
All cryptographically sound key generation schemes must have means
.Pp
The entropy seed used by the OpenSSL library is contained in a file,
usually called
-.Cm .rnd ,
+.Pa .rnd ,
which must be available when starting the NTP daemon
or the
.Nm
program.
The NTP daemon will first look for the file
using the path specified by the
-.Ic randfile
+.Cm randfile
subcommand of the
.Ic crypto
configuration command.
.Ev RANDFILE
environment variable is not present,
the library will look for the
-.Cm .rnd
+.Pa .rnd
file in the user home directory.
+Since both the
+.Nm
+program and
+.Xr ntpd @NTPD_MS@
+daemon must run as root, the logical place to put this file is in
+.Pa /.rnd
+or
+.Pa /root/.rnd .
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.
.Ss Cryptographic Data Files
-All other file formats begin with two lines.
-The first contains the file name, including the generated host name
-and filestamp.
-The second contains the datestamp in conventional Unix date format.
-Lines beginning with # are considered comments and ignored by the
+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
+.Pa ntpkey_ Ns Ar key _ Ar name . Ar filestamp ,
+where
+.Ar key
+is the key or parameter type,
+.Ar name
+is the host or group name and
+.Ar filestamp
+is the filestamp (NTP seconds) when the file was created.
+By convention,
+.Ar key
+names in generated file names include both upper and lower case
+characters, while
+.Ar key
+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
+.Pa date
+format.
+Lines beginning with
+.Ql #
+are considered comments and ignored by the
.Nm
program and
.Xr ntpd @NTPD_MS@
daemon.
-Cryptographic values are encoded first using ASN.1 rules,
-then encrypted if necessary, and finally written PEM\-encoded
-printable ASCII format preceded and followed by MIME content identifier lines.
.Pp
-The format of the symmetric keys file is somewhat different
-than the other files in the interest of backward compatibility.
-Since DES\-CBC is deprecated in NTPv4, the only key format of interest
-is MD5 alphanumeric strings.
-Following hte heard the keys are
-entered one per line in the format
-.D1 Ar keyno type key
+The remainder of the file contains cryptographic data, encoded first using ASN.1
+rules, then encrypted if necessary, and finally written in PEM\-encoded
+printable ASCII text, preceded and followed by MIME content identifier lines.
+.Pp
+The format of the symmetric keys file, ordinarily named
+.Pa ntp.keys ,
+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.
+.Bd -literal -unfilled -offset center
+# ntpkey_MD5key_bk.ntp.org.3595864945
+# Thu Dec 12 19:22:25 2013
+1 MD5 L";Nw<\`.I<f4U0)247"i # MD5 key
+2 MD5 &>l0%XXK9O'51VwV<xq~ # MD5 key
+3 MD5 lb4zLW~d^!K:]RsD'qb6 # MD5 key
+4 MD5 Yue:tL[+vR)M\`n~bY,'? # MD5 key
+5 MD5 B;fx'Kgr/&4ZTbL6=RxA # MD5 key
+6 MD5 4eYwa\`o}3i@@V@..R9!l # MD5 key
+7 MD5 \`A.([h+;wTQ|xfi%Sn_! # MD5 key
+8 MD5 45:V,r4]l6y^JH6"Sh?F # MD5 key
+9 MD5 3\-5vcn*6l29DS?Xdsg)* # MD5 key
+10 MD5 2late4Me # MD5 key
+11 SHA1 a27872d3030a9025b8446c751b4551a7629af65c # SHA1 key
+12 SHA1 21bc3b4865dbb9e920902abdccb3e04ff97a5e74 # SHA1 key
+13 SHA1 2b7736fe24fef5ba85ae11594132ab5d6f6daba9 # SHA1 key
+14 SHA a5332809c8878dd3a5b918819108a111509aeceb # SHA key
+15 MD2 2fe16c88c760ff2f16d4267e36c1aa6c926e6964 # MD2 key
+16 MD4 b2691811dc19cfc0e2f9bcacd74213f29812183d # MD4 key
+17 MD5 e4d6735b8bdad58ec5ffcb087300a17f7fef1f7c # MD5 key
+18 MDC2 a8d5e2315c025bf3a79174c87fbd10477de2eabc # MDC2 key
+19 RIPEMD160 77ca332cafb30e3cafb174dcd5b80ded7ba9b3d2 # RIPEMD160 key
+20 AES128CMAC f92ff73eee86c1e7dc638d6489a04e4e555af878 # AES128CMAC key
+.Ed
+.D1 Figure 1. Typical Symmetric Key File
+.Pp
+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
+.D1 Ar keyno Ar type Ar key
where
.Ar keyno
-is a positive integer in the range 1\-65,535,
+is a positive integer in the range 1\-65534;
.Ar type
-is the string MD5 defining the key format and
+is the key type for the message digest algorithm, which in the absence of the
+OpenSSL library must be
+.Cm MD5
+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
+.Cm SHA
+or
+.Cm SHA1 ;
.Ar key
is the key itself,
-which is a printable ASCII string 16 characters or less in length.
-Each character is chosen from the 93 printable characters
-in the range 0x21 through 0x7f excluding space and the
+which is a printable ASCII string 20 characters or less in length:
+each character is chosen from the 93 printable characters
+in the range 0x21 through 0x7e (
+.Ql !
+through
+.Ql ~
+\&) excluding space and the
+.Ql #
+character, and terminated by whitespace or a
.Ql #
character.
+An OpenSSL key consists of a hex\-encoded ASCII string of 40 characters, which
+is truncated as necessary.
.Pp
Note that the keys used by the
.Xr ntpq @NTPQ_MS@
.Pp
The
.Nm
-program generates a MD5 symmetric keys file
-.Pa ntpkey_MD5key_ Ns Ar hostname.filestamp .
+program generates a symmetric keys file
+.Pa ntpkey_MD5key_ Ns Ar hostname Ns . Ns Ar filestamp .
Since the file contains private shared keys,
it should be visible only to root and distributed by secure means
to other subnet hosts.
certificate scheme.
.sp
scheme is one of
-RSA\-MD2, RSA\-MD5, RSA\-SHA, RSA\-SHA1, RSA\-MDC2, RSA\-RIPEMD160,
+RSA\-MD2, RSA\-MD5, RSA\-MDC2, RSA\-SHA, RSA\-SHA1, RSA\-RIPEMD160,
DSA\-SHA, or DSA\-SHA1.
.sp
-Select the certificate message digest/signature encryption scheme.
+Select the certificate signature encryption/message digest scheme.
Note that RSA schemes must be used with a RSA sign key and DSA
schemes must be used with a DSA sign key. The default without
this option is RSA\-MD5.
.sp
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". The openssl tool lists ciphers
+equivalent to "\fB\-C des\-ede3\-cbc\fP". The openssl tool lists ciphers
available in "\fBopenssl \-h\fP" output.
.It Fl d , Fl \-debug\-level
Increase debug verbosity level.
.It Fl e , Fl \-id\-key
Write IFF or GQ identity keys.
.sp
-Write the IFF or GQ client keys to the standard output. This is
-intended for automatic key distribution by mail.
+Write the public parameters from the IFF or GQ client keys to
+the standard output.
+This is intended for automatic key distribution by email.
.It Fl G , Fl \-gq\-params
Generate GQ parameters and keys.
.sp
that role, the default is the host name if this option is not
provided. The group name, if specified using \fB\-i/\-\-ident\fP or
using \fB\-s/\-\-subject\-name\fP following an '\fB@\fP' character,
-is also a part of the self\-signed host certificate's subject and
+is also a part of the self\-signed host certificate subject and
issuer names in the form \fBhost@group\fP and should match the
-\'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in
-\fBntpd\fP's configuration file.
+\'\fBcrypto ident\fP' or '\fBserver ident\fP' configuration in the
+\fBntpd\fP configuration file.
.It Fl l Ar lifetime , Fl \-lifetime Ns = Ns Ar lifetime
set certificate lifetime.
This option takes an integer number as its argument.
.sp
Set the certificate expiration to lifetime days from now.
-.It Fl M , Fl \-md5key
-generate MD5 keys.
-.sp
-Generate MD5 keys, obsoleting any that may exist.
.It Fl m Ar modulus , Fl \-modulus Ns = Ns Ar modulus
-modulus.
+prime modulus.
This option takes an integer number as its argument.
The value of
.Ar modulus
.in -4
.sp
The number of bits in the prime modulus. The default is 512.
+.It Fl M , Fl \-md5key
+generate symmetric keys.
+.sp
+Generate symmetric keys, obsoleting any that may exist.
.It Fl P , Fl \-pvt\-cert
generate PC private certificate.
.sp
The same password must be specified to the remote ntpd via the
"crypto pw password" configuration command. See also the option
-\-id\-key (\-e) for unencrypted exports.
-.It Fl S Ar sign , Fl \-sign\-key Ns = Ns Ar sign
-generate sign key (RSA or DSA).
-.sp
-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.
.It Fl s Ar host@group , Fl \-subject\-name Ns = Ns Ar host@group
set host and optionally group name.
.sp
following an '\fB@\fP' 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 \fBhost@group\fP form for the host certificate's subject and issuer
+in \fBhost@group\fP form for the host certificate subject and issuer
fields. Specifying '\fB\-s @group\fP' is allowed, and results in
leaving the host name unchanged while appending \fB@group\fP to the
subject and issuer fields, as with \fB\-i group\fP. 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.
+.It Fl S Ar sign , Fl \-sign\-key Ns = Ns Ar sign
+generate sign key (RSA or DSA).
+.sp
+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.
.It Fl T , Fl \-trusted\-cert
trusted certificate (TC scheme).
.sp
If any of these are directories, then the file \fI.ntprc\fP
is searched for within those directories.
.Sh USAGE
-The
-.Fl p Ar password
-option specifies the write password and
-.Fl q Ar password
-option the read password for previously encrypted files.
-The
-.Nm
-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
-no write password is specified, the read password is used
-as the write password by default.
.Sh "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.Sh "FILES"
Copyright (C) 1992\-2017 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,
-from one to several minutes with modern architectures
-such as UltraSPARC and up to tens of minutes to an hour
-with older architectures such as SPARC IPC.
+It can take quite a while to generate some cryptographic values.
.Pp
Please report bugs to http://bugs.ntp.org .
.Pp
projects / thirdparty / ntp.git / commitdiff
