.\" -*- nroff -*" .TH ptpd 8 "November, 2013" "version 2.3.0" "Precision Time Protocol daemon" .SH NAME ptpd \- Precision Time Protocol daemon (1588-2008) .SH SYNOPSIS .B ptpd \fB[ -?hH ]\fR \fB[ -e \fISETTING\fB ]\fR \fB[ -kvOLAl ]\fR \fB[ -smMyEPanCV ]\fR \fB[ -c \fIFILE\fB ]\fR \fB[ -R \fIDIR\fB ]\fR \fB[ -f \fIFILE\fB ]\fR \fB[ -S \fIFILE\fB ]\fR \fB[ -d \fIDOMAIN\fB ]\fR \fB[ -u \fIADDRESS\fB ]\fR \fB[ -r \fINUMBER\fB ]\fR \fB-i \fIINTERFACE\fB\fR .SH DESCRIPTION PTPd is a daemon that implements the Precision Time Protocol (PTP) Version 2 as defined by the IEEE 1588-2008 standard. PTP was developed to provide very precise time coordination of LAN connected computers. The daemon must run as .B root in order to be able to manipluate the system clock and use low port numbers. PTPd is feature rich, supports IPv4 multicast, unicast and hybrid mode (mixed) operation, as well as Ethernet mode. Even without hardware assistance, PTPd is able to achieve and maintain sub-microsecond level timing precision and is able to withstand PTP Grandmaster failovers, link failures and restarts with minimal impact to timing performance. PTPd is lightweight, portable and currently supports Linux, FreeBSD and Mac OS X and runs on multiple CPU architectures, 32-bit and 64-bit, including x86 and ARM. .SH COMMAND-LINE CONFIGURATION As of version 2.3.0, configuration file is the preferred mechanism for configuring PTPd, therefore the options available as short (\fI-x\fR) and long options (\fI--xxxxx\fR) mostly provide basic control over the daemon operation, and only provide the very basic PTP protocol settings. The rest of the settings (see \fBptpd.conf(5)\fR) can also be specified as command-line options, but they take the long \fI--key:section="value"\fR form. .SH BASIC DAEMON OPTIONS .TP \fB-c --config-file \fIPATH\fR Path to configuration file (see \fBptpd2.conf(5)\fR) .TP \fB-k --check-config\fR Check configuration and exit - return 0 if configuration is correct. .TP \fB-v --version\fR Print version string and exit .TP \fB-h --help\fR Show help screen .TP \fB-H --long-help\fR Show detailed help for all settings and behaviours .TP \fB-e --explain \fISETTING\fR Show help for a single setting (\fIsection:key\fR) .TP \fB-O --default-config\fR Show default configuration and exit (output usable as a configuration file) .TP \fB-L --ignore-lock\fR Skip lock file checks and locking (also \fIglobal:ignore_lock\fR) .TP \fB-A --auto-lock\fR Use preset / port mode specific lock file names - useful when running multiple instances .TP \fB-l --lockfile\fR Specify lock file path (also \fIglobal:lock_file\fR) .TP \fB-p --print-lockfile\fR Print path to lock file and exit (useful for init scripts in combination with auto lock files) .TP \fB-R --lock-directory \fIDIR\fR Directory to store lock files (also \fIglobal:lock_directory\fR) .TP \fB-f --log-file \fIPATH\fR Path to log file (also \fIglobal:logfile\fR) .TP \fB-S --statistics-file \fII PATH\fR Path to statistics file (also \fIglobal:statistics_file\fR) .SH BASIC PTP PROTOCOL OPTIONS .TP \fB-i --interface \fDEV\fR \fIREQUIRED:\fRInterface to use - eth0, etc (also \fIptpengine:interface\fR) .TP \fB-d --domain \fINUMBER\fR PTP domain number to become part of (also \fIptpengine:domain\fR) .TP \fB-s --slaveonly\fR Slave only mode (also \fIptpengine:preset=slaveonly\fR) .TP \fB-m --masterslave\fR Full IEEE 1588 implementation: master, slave when not best GM (also \fIptpengine:preset=masterslave\fR) .TP \fB-M --masteronly\fR Master only mode: passive when not best GM (also \fIptpengine:preset=masteronly\fR) .TP \fB-y --hybrid\fR Hybrid mode - mixed multicast and unicast operation (multicast for sync and announce, unicast for delay request and response (also \fIptpengine:ip_mode=hybrid\fR) .TP \fB-u --unicast \fIIP\fR Unicast mode (no unicast negotiation) - send all messages to \fIIP\fR (also \fIptpengine:ip_mode=unicast\fR + \fIptpengine:unicast_address\fR) \fB-E --e2e\fR End to end delay detection (also \fIptpengine:delay_mechanism=E2E\fR) .TP \fB-E --p2p\fR Peer to peer delay detection (also \fIptpengine:delay_mechanism=P2P\fR) .TP \fB-a --delay-override\fR In slave state, override delay request interval announced by master (also \fIptpengine:log_delayreq_override\fR) - the value of \fIptpengine:log_delayreq_interval\fR is used .TP \fB-r --delay-interval \fINUMBER\fR Specify delay request message interval (log 2) - (also \fIptpengine:log_delayreq_interval\fR) .TP \fB-n --clock:no_adjust\fR Do not adjust the clock (also \fIclock:no_adjust\fR) .TP \fB-D