TS2ALT(8)

NAME
tz2alt - Monitors daylight savings time changes and publishes them to PTP stack.

SYNOPSIS
ts2alt [ -hmqv ] [ -f conf ] [ -k key ] [ -p period ] [ -w window ] [ -z timezone ] [ long-options ] ...

DESCRIPTION
tz2alt leverages the local time zone database to monitor for changes in daylight savings time and publishes the pending changes to the PTP stack.

OPTIONS

-f config
    Read configuration from the specified file. No configuration file is read by default.

-h  Displays the command line help summary.

-l print-level
    Sets the maximum syslog level of messages which should be printed or sent to the system logger. The default is 6 (LOG_INFO).

-m  Prints log messages to the standard output.

-q  Prevents sending log messages to the system logger.

-v  Prints the software version and exits.

LONG OPTIONS
Each and every configuration file option (see below) may also appear as a "long" style command line argument. For example, the use_syslog option may be set using either of these two forms.
    --use_syslog 1 --use_syslog=1
Option values given on the command line override values in the global section of the configuration file.

CONFIGURATION FILE
The configuration file is divided into sections. Each section starts with a line containing its name enclosed in brackets and it follows with settings. Each setting is placed on a separate line, it contains the name of the option and the value separated by whitespace characters. Empty lines and lines starting with # are ignored.

GLOBAL OPTIONS

active_key_id
    Used in conjunction with spp and sa_file directives to specify which key from the spp defined Security Association should be used for outbound icv calculations. All Security Assocations are read from the file specified by sa_file. Requires spp and sa_file directives. Must be in the range of 1 to 2^32-1, inclusive. The default is 0 (disabled).

domainNumber
    The domain attribute of the local clock. The default is 0.

leapfile
    The path to the current leap seconds definition file. In a Debian system this file is provided by the tzdata package and can be found at /usr/share/zoneinfo/leap-seconds.list. If a leapfile is configured it will be reloaded if modified. The default is an empty string, which causes the program to use a hard coded table that reflects the known leap seconds on the date of the software's release.

logging_level
    The maximum logging level of messages which should be printed. The default is 6 (LOG_INFO).

message_tag
    The tag which is added to all messages printed to the standard output or system log. If the tag contains the string "{level}", it will be replaced with the log level of the message as a number. The default is an empty string (which cannot be set in the configuration file as the option requires an argument).

sa_file
    Specifies the location of the file containing Security Associations used for immediate security processing of the Authentication TLV in support of the optional security mechanism defined in ieee1588-2019 ch 14.16. See SECURITY ASSOCIATION OPTIONS for more info on file contents. The default is an empty string. (disabled).

spp Specifies the security parameters pointer for the desired security association to be used for authentication tlv support. If specified, the port owning the spp will attempt to attach (outbound) and check (inbound) authentication tlvs for all messages in accordance to the corresponding security association sourced via the sa_file directive. Not compatible with one step ports. Must be in the range of -1 to 255, inclusive. The default is -1 (disabled).

transportSpecific
    The transport specific field. Must be in the range 0 to 255. The default is 0.

use_syslog
    Print messages to the system log if enabled. The default is 1 (enabled).

verbose
    Print messages to the standard output if enabled. The default is 0 (disabled).

WARNING
Be cautious when sharing the same configuration file between ptp4l, phc2sys, and tz2alt. Keep in mind that values specified in the configuration file take precedence over the default values. If an option which is common to the other programs is set in the configuration file, then the value will be applied to all the programs using the file, and this might not be what is expected. It is recommended to use separate configuration files for ptp4l, phc2sys, and tz2alt in order to avoid any unexpected behavior.

SEE ALSO
ptp4l(8)