summaryrefslogtreecommitdiff
path: root/third_party/ptpd-1.1.0/src/ptpd.8
blob: 2452d7fa3c827a9143d89884a205a4bfdc6cba18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.\" -*- nroff -*"
.TH ptpd 8 "August 9, 2010" "version 1.1.0" "Precision Time Protocol daemon"
.SH NAME
ptpd \- Precision Time Protocol daemon
.SH SYNOPSIS
.B ptpd

[-?]
[-c]
[-S]
[-f FILE]
[-R FILE]
[-d]
[-D]
[-x]
[-M NUMBER]
[-t]
[-T ttl]
[-a NUMBER,NUMBER]
[-w NUMBER]
[-b NAME]
[-u ADDRESS]
[-l NUMBER,NUMBER]
[-o NUMBER]
[-e NUMBER]
[-y NUMBER]
[-m NUMBER]
[-g]
[-p]
[-s NUMBER]
[-i NAME]
[-v NUMBER]
[-n NAME]
[-k NUMBER,NUMBER]

.SH DESCRIPTION
Implements version 1 of the Precision Time Protocol (PTP) as defined
by the IEEE 1588 standard. PTP was developed to provide very precise
time coordination of LAN connected computers.
.PP
PTPd is a complete implementation of the IEEE 1588 specification for a
standard (non-boundary) clock. PTPd has been tested with and is known
to work properly with other IEEE 1588 implementations. The source code
for PTPd is freely available under a BSD-style license. Thanks to
contributions from users, PTPd is becoming an increasingly portable,
interoperable, and stable IEEE 1588 implementation.
.PP
For more information, see http://ptpd.sourceforge.net/
.SH OPTIONS
.TP
.B \-?
display a short help text
.TP
.B \-c
run in command line (non-daemon) mode
.TP
.B \-S
log information to syslog
.TP
.B \-f FILE
send output to FILE
.TP
.B \-R FILE
record quality data to FILE
.TP
.B \-d
display stats
.TP
.B \-D
display stats in .csv format
.TP
.B \-x
do not reset the clock if off by more than one second
.TP
.B \-M NUMBER
do not reset the clock if off by more than NUMBER nanoseconds
.TP
.B \-t
do not adjust the system clock
.TP
.B \-T
set multicast TTL for packets.  Defaults to 1.
.TP
.B \-a NUMBER,NUMBER
specify clock servo P and I attenuations
.TP
.B \-w NUMBER
specify one way delay filter stiffness
.TP
.B \-b NAME
bind PTP to network interface NAME
.TP
.B \-u ADDRESS
don't multicast, send messages unicast to ADDRESS
.TP
.B \-l NUMBER,NUMBER
specify inbound, outbound latency in nsec
.TP
.B \-o NUMBER
specify current UTC offset
.TP
.B \-e NUMBER
specify epoch NUMBER
.TP
.B \-y NUMBER
specify sync interval in 2^NUMBER sec
.TP
.B \-m NUMBER
specify max number of foreign master records
.TP
.B \-g
run as slave only
.TP
.B \-p
make this a preferred clock
.TP
.B \-s NUMBER
specify system clock stratum
.TP
.B \-i NAME
specify system clock identifier
.TP
.B \-v NUMBER
specify system clock allen variance
.TP
.B \-n NAME
specify PTP subdomain name (not related to IP or DNS)
.TP
.B \-k NUMBER,NUMBER
send a management message of key, record, then exit

.SH AUTHORS
.PP
Originally written and maintained by Kendall Correll
<kendall_c@users.sourceforge.net>
.PP
Steven Kreuzer <skreuzer@freebsd.org> 
.PP
George Neville-Neil <gnn@freebsd.org>
.PP
This manual page was originally written by Andrew Straw
<strawman@astraw.com> for the Debian Project (but may be used by
others).