Signed-off-by: Richard Cochran <richardcoch...@gmail.com> --- phc2sys.8 | 122 +++++++++++++++++++++++++++--------------------------- 1 file changed, 61 insertions(+), 61 deletions(-)
diff --git a/phc2sys.8 b/phc2sys.8 index b686d72..33c126e 100644 --- a/phc2sys.8 +++ b/phc2sys.8 @@ -262,12 +262,38 @@ sets the program options. This is the only used option. .SH FILE OPTIONS +.TP +.B clock_servo +The servo which is used to synchronize the local clock. Valid values +are "pi" for a PI controller, "linreg" for an adaptive controller using +linear regression, "ntpshm" for the NTP SHM reference clock to allow +another process to synchronize the local clock (the SHM segment number +is set to the domain number), and "nullf" for a servo that always dials +frequency offset zero (for use in SyncE nodes). The default is "pi." +Same as option +.B \-E +(see above). + .TP .B domainNumber Specify the domain number used by phc2sys. The default is 0. Same as option .B \-n (see above). +.TP +.B first_step_threshold +Specify the step threshold applied only on the first update. It is the +maximum offset that is corrected by adjusting clock. It's specified in +seconds. The value of 0.0 disables stepping on start. The default is +0.00002 (20 microseconds). +Same as option +.B \-F +(see above). + +.TP +.B free-running +Don't adjust the sink clock if enabled. The default is 0 (disabled). + .TP .B kernel_leap When a leap second is announced, let the kernel apply it by stepping the @@ -296,49 +322,17 @@ Same as option (see above). .TP -.B sanity_freq_limit -The maximum allowed frequency offset between uncorrected clock and the -system monotonic clock in parts per billion (ppb). This is used as a -sanity check of the synchronized clock. When a larger offset is measured, -a warning message will be printed and the servo will be reset. When set -to 0, the sanity check is disabled. The default is 200000000 (20%). +.B ntpshm_segment +The number of the SHM segment used by ntpshm servo. The default is 0. Same as option -.B \-L +.B \-M (see above). .TP -.B clock_servo -The servo which is used to synchronize the local clock. Valid values -are "pi" for a PI controller, "linreg" for an adaptive controller using -linear regression, "ntpshm" for the NTP SHM reference clock to allow -another process to synchronize the local clock (the SHM segment number -is set to the domain number), and "nullf" for a servo that always dials -frequency offset zero (for use in SyncE nodes). The default is "pi." +.B pi_integral_const +Specifies the integral constant of the PI controller. Same as option -.B \-E -(see above). - -.TP -.B free-running -Don't adjust the sink clock if enabled. The default is 0 (disabled). - -.TP -.B transportSpecific -The transport specific field. Must be in the range 0 to 255. -The default is 0. - -.TP -.B use_syslog -Print messages to the system log if enabled. The default is 1 (enabled). -Related to option -.B \-q -(see above). - -.TP -.B verbose -Print messages to the standard output if enabled. The default is 0 (disabled). -Related to option -.B \-m +.B \-I (see above). .TP @@ -349,10 +343,19 @@ Same as option (see above). .TP -.B pi_integral_const -Specifies the integral constant of the PI controller. +.B refclock_sock_address +The address of the UNIX domain socket to be used by the refclock_sock servo. +The default is /var/run/refclock.ptp.sock. + +.TP +.B sanity_freq_limit +The maximum allowed frequency offset between uncorrected clock and the +system monotonic clock in parts per billion (ppb). This is used as a +sanity check of the synchronized clock. When a larger offset is measured, +a warning message will be printed and the servo will be reset. When set +to 0, the sanity check is disabled. The default is 200000000 (20%). Same as option -.B \-I +.B \-L (see above). .TP @@ -368,26 +371,9 @@ Same as option (see above). .TP -.B first_step_threshold -Specify the step threshold applied only on the first update. It is the -maximum offset that is corrected by adjusting clock. It's specified in -seconds. The value of 0.0 disables stepping on start. The default is -0.00002 (20 microseconds). -Same as option -.B \-F -(see above). - -.TP -.B refclock_sock_address -The address of the UNIX domain socket to be used by the refclock_sock servo. -The default is /var/run/refclock.ptp.sock. - -.TP -.B ntpshm_segment -The number of the SHM segment used by ntpshm servo. The default is 0. -Same as option -.B \-M -(see above). +.B transportSpecific +The transport specific field. Must be in the range 0 to 255. +The default is 0. .TP .B uds_address @@ -397,6 +383,20 @@ Same as option .B \-z (see above). +.TP +.B use_syslog +Print messages to the system log if enabled. The default is 1 (enabled). +Related to option +.B \-q +(see above). + +.TP +.B verbose +Print messages to the standard output if enabled. The default is 0 (disabled). +Related to option +.B \-m +(see above). + .SH TIME SCALE USAGE .B Ptp4l -- 2.30.2 _______________________________________________ Linuxptp-devel mailing list Linuxptp-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linuxptp-devel
