Skip to content

Commit

Permalink
Update man pages to reflect the new clientOnly option.
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Cochran <[email protected]>
  • Loading branch information
richardcochran committed Jan 18, 2021
1 parent 4c3b99b commit f7f6edf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
16 changes: 10 additions & 6 deletions ptp4l.8
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ associated with a network interface. This option specifies the PHC
device (e.g. /dev/ptp0) to be used when running on legacy kernels.
.TP
.B \-s
Enable the slaveOnly mode.
Enable the clientOnly mode.
.TP
.BI \-l " print-level"
Set the maximum syslog level of messages which should be printed or sent to
Expand All @@ -99,11 +99,11 @@ Display a help message.
.SH LONG OPTIONS

Each and every configuration file option (see below) may also appear
as a "long" style command line argument. For example, the slaveOnly
as a "long" style command line argument. For example, the clientOnly
option may be set using either of these two forms.

.RS
\f(CW\-\-slaveOnly 1 \-\-slaveOnly=1\fP
\f(CW\-\-clientOnly 1 \-\-clientOnly=1\fP
.RE

Option values given on the command line override values in the global
Expand Down Expand Up @@ -380,9 +380,13 @@ Enable two-step mode for sync messages. One-step mode can be used only with
hardware time stamping.
The default is 1 (enabled).
.TP
.B slaveOnly
.B clientOnly
The local clock is a client-only clock if enabled. The default is 0 (disabled).
.TP
.B slaveOnly
This option is deprecated and will be removed in a future release.
Use "clientOnly" instead.
.TP
.B socket_priority
Configure the SO_PRIORITY of sockets. This is to support cases where a user
wants to route ptp4l traffic using Linux qdiscs for the purpose of traffic
Expand Down Expand Up @@ -722,8 +726,8 @@ instead of running the best master clock algorithm (BMCA) described in
1588 profile. This can be used to speed up the start time for servers
and clients when you know the roles of the devices in advance. When set to
\'noop', the traditional BMCA algorithm used by 1588 is skipped. masterOnly and
slaveOnly will be used to determine the server or client role for the device. In a
bridge, slaveOnly (which is a global option) can be set to make all ports
clientOnly will be used to determine the server or client role for the device. In a
bridge, clientOnly (which is a global option) can be set to make all ports
assume the client role. masterOnly (which is a per-port config option) can then
be used to set individual ports to take on the server role.
The default value is 'ptp' which runs the BMCA related state machines.
Expand Down
4 changes: 2 additions & 2 deletions timemaster.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH TIMEMASTER 8 "October 2014" "linuxptp"
.TH TIMEMASTER 8 "January 2021" "linuxptp"
.SH NAME

timemaster - run NTP with PTP as reference clocks
Expand Down Expand Up @@ -130,7 +130,7 @@ extra options are added by default.

The \fBptp_domain\fR section specifies a PTP domain that should be used as a
time source. The PTP domain number is included in the name of the section. The
\fBptp4l\fR instances are configured to run in the \fBslaveOnly\fR mode. In
\fBptp4l\fR instances are configured to run in the \fBclientOnly\fR mode. In
this section at least the \fBinterfaces\fR option needs to be set, other
options are optional.

Expand Down

0 comments on commit f7f6edf

Please sign in to comment.