Skip to content

Commit 0b3d969

Browse files
committed
SWPTP-1555: document tstool --config-file
1 parent 244cf4d commit 0b3d969

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/tstool.8

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
.Op Fl -help
1010
.Nm
1111
.Op Fl -verbose | v
12+
.Op Fl -config-file Pa file | Fl f Pa file
1213
.Op Fl -persistent
1314
.Op Fl -initial
1415
.Ar command ...
@@ -18,6 +19,17 @@ Examine and adjust PTP Hardware Clock devices, system clock and interface timest
1819
This utility uses the mechanisms available to sfptpd to manipulate precision clocks on the system.
1920
.Pp
2021
Clocks may be specified by phc number, interface name or 'system'.
22+
.Pp
23+
A configuration file in the same format as used by
24+
.Xr sfptpd 8
25+
may be supplied.
26+
Any settings in the configuration file will take precedence over the command line options.
27+
Note that this behaviour differs from
28+
.Nm sfptpd
29+
which performs a second pass of the command line arguments after interpreting the config file.
30+
The config file is useful for expressing options like
31+
.Ql phc_diff_methods
32+
for defining the preferred clock comparison methods to use.
2133
.Ss Commands
2234
.Bl -item -compact
2335
.It

0 commit comments

Comments
 (0)