.\" Automatically generated by Pandoc 3.4
.\"
.TH "STATIME.TOML" "5" "" "statime 0.2.2" "statime"
.SH NAME
\f[CR]statime.toml\f[R] \- configuration file for the statime
ptp\-daemon
.SH DESCRIPTION
Configuration of ntpd\-rs happens in the \f[CR]statime.toml\f[R]
configuration format.
The toml format is in lots of ways similar to a simple ini with several
extensions allowing a json\-like syntax.
.PP
The statime configuration file consists of several sections, each of
which configures a separate part of the ptp\-daemon process.
Each of the sections is described in the rest of this document.
Many settings will have defaults, which will be indicated by each
configuration setting shown.
.SH CONFIGURATION
.TP
\f[CR]identity\f[R] = \f[I]clock identity\f[R] (\f[B]unset\f[R])
The unique identity of this clock.
A clock identity is encoded as a 16\-character hexadecimal string, for
example \f[CR]identity = \[dq]00FFFFFFFFFFFFFB\[dq]\f[R].
If unset the clock identity is derived from a MAC address.
.TP
\f[CR]domain\f[R] = \f[I]u8\f[R] (\f[B]0\f[R])
The PTP domain of this instance.
All instances in domain are synchronized to the Grandmaster Clock of the
domain, but are not necessarily synchronized to PTP clocks in another
domain.
.TP
\f[CR]sdo\-id\f[R] = \f[I]u12\f[R] (\f[B]0\f[R])
The \[lq]source domain identity\[rq] of this PTP instance.
Together with the \f[CR]domain\f[R] it identifies a domain.
.TP
\f[CR]priority1\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
A tie breaker for the best master clock algorithm in the range
\f[CR]0..256\f[R].
\f[CR]0\f[R] being the highest priority and \f[CR]255\f[R] the lowest.
.TP
\f[CR]priority2\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
A tie breaker for the best master clock algorithm in the range
\f[CR]0..256\f[R].
\f[CR]0\f[R] being the highest priority and \f[CR]255\f[R] the lowest.
.TP
\f[CR]path\-trace\f[R] = \f[I]bool\f[R]
The instance uses the path trace option.
This allows detecting clock loops when enabled on all instances in the
network.
.TP
\f[CR]virtual\-system\-clock\f[R] = \f[I]bool\f[R] (\f[B]false\f[R])
Use a virtual overlay clock instead of adjusting the system clock.
.SS \f[CR][[port]]\f[R]
.TP
\f[CR]interface\f[R] = \f[I]interface name\f[R]
The network interface of this PTP port.
For instance \f[CR]\[dq]lo\[dq]\f[R] or \f[CR]\[dq]enp0s31f6\[dq]\f[R]
.TP
\f[CR]announce\-interval\f[R] = \f[I]interval\f[R] (\f[B]1\f[R])
How often an announce message is sent by a master.
Defined as an exponent of 2, so a value of 1 means every 2\[ha]1 = 2
seconds.
.TP
\f[CR]sync\-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
How often sync message is sent by a master.
Defined as an exponent of 2, so a value of 0 means every 2\[ha]0 = 1
seconds.
.TP
\f[CR]announce\-receipt\-timeout\f[R] = \f[I]number of announce intervals\f[R] (\f[B]3\f[R])
Number of announce intervals to wait for announce messages from other
masters before the port becomes master itself.
.TP
\f[CR]delay\-asymmetry\f[R] = \f[I]nanoseconds\f[R] (\f[B]0\f[R])
Correct for a difference between slave\-to\-master and master\-to\-slave
propagation time.
The value is positive when the slave\-to\-master propagation time is
longer than the master\-to\-slave propagation time.
.TP
\f[CR]delay\-mechanism\f[R] = \f[I]mechanism\f[R] (\f[B]E2E\f[R])
Which delay mechanism to use on the port.
Either \f[CR]\[dq]E2E\[dq]\f[R] for end\-to\-end delay determination, or
\f[CR]\[dq]P2P\[dq]\f[R] for the peer to peer delay mechanism.
.TP
\f[CR]delay\-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
How often delay request messages are sent by a slave in end\-to\-end
mode.
Currently the only supported delay mechanism is end\-to\-end (E2E).
Defined as an exponent of 2, so a value of 0 means every 2\[ha]0 = 1
seconds
.TP
\f[CR]master\-only\f[R] = \f[I]bool\f[R] (\f[B]false\f[R])
The port is always a master instance, and will never become a slave
instance.
.TP
\f[CR]hardware\-clock\f[R] = \f[I]index\f[R] (\f[B]unset\f[R])
Index of a hardware clock device, for instance \f[CR]0\f[R] for
\f[CR]/dev/ptp0\f[R].
.TP
\f[CR]acceptable\-master\-list\f[R] = [ \f[I]clock identity\f[R], .. ] (\f[B]unset\f[R])
List of clock identities that this port will accept as its master.
A clock identity is encoded as a 16\-character hexadecimal string, for
example
\f[CR]acceptable\-master\-list = [\[dq]00FFFFFFFFFFFFFB\[dq]]\f[R].
The default is to accept all clock identities.