The man page is from Debian: Package: iproute2 Version: 6.11.0-1 Severity: minor Tags: patch Improve the layout of the man page according to the "man-page(7)" guidelines, the output of "mandoc -lint T", the output of "groff -mandoc -t -ww -b -z", that of a shell script, and typographical conventions. -.- Output from a script "chk_man" is in the attachment. -.- Signed-off-by: Bjarni Ingi Gislason diff --git a/dcb-pfc.8 b/dcb-pfc.8.new index 735c16e..01fdb34 100644 --- a/dcb-pfc.8 +++ b/dcb-pfc.8.new @@ -3,20 +3,19 @@ dcb-pfc \- show / manipulate PFC (Priority-based Flow Control) settings of the DCB (Data Center Bridging) subsystem .SH SYNOPSIS -.sp .ad l .in +8 .ti -8 .B dcb -.RI "[ " OPTIONS " ] " +.RI "[ " OPTIONS " ]" .B pfc .RI "{ " COMMAND " | " help " }" .sp .ti -8 .B dcb pfc show dev -.RI DEV +.I DEV .RB "[ " pfc-cap " ]" .RB "[ " prio-pfc " ]" .RB "[ " macsec-bypass " ]" @@ -26,7 +25,7 @@ the DCB (Data Center Bridging) subsystem .ti -8 .B dcb pfc set dev -.RI DEV +.I DEV .RB "[ " prio-pfc " " \fIPFC-MAP " ]" .RB "[ " macsec-bypass " { " on " | " off " } ]" .RB "[ " delay " " \fIINTEGER\fR " ]" @@ -35,7 +34,7 @@ the DCB (Data Center Bridging) subsystem .IR PFC-MAP " := [ " PFC-MAP " ] " PFC-MAPPING .ti -8 -.IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fR "{ " +.IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fR { .IR \fBon\fR " | " \fBoff\fR " }" .ti -8 @@ -45,17 +44,22 @@ the DCB (Data Center Bridging) subsystem .B dcb pfc is used to configure Priority-based Flow Control attributes through Linux -DCB (Data Center Bridging) interface. PFC permits marking flows with a -certain priority as lossless, and holds related configuration, as well as -PFC counters. +DCB (Data Center Bridging) interface. +PFC permits marking flows with a certain priority as lossless, +and holds related configuration, +as well as PFC counters. .SH PARAMETERS -For read-write parameters, the following describes only the write direction, -i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the -parameter name is to be used as a simple keyword without further arguments. This -instructs the tool to show the value of a given parameter. When no parameters -are given, the tool shows the complete PFC configuration. +For read-write parameters, +the following describes only the write direction, +i.e., as used with the \fBset\fR command. +For the \fBshow\fR command, +the parameter name is to be used as a simple keyword without further +arguments. +This instructs the tool to show the value of a given parameter. +When no parameters are given, +the tool shows the complete PFC configuration. .TP .B pfc-cap @@ -64,13 +68,13 @@ simultaneously support PFC. .TP .B requests -A read-only count of the sent PFC frames per traffic class. Only shown when --s is given, or when requested explicitly. +A read-only count of the sent PFC frames per traffic class. +Only shown when \-s is given, or when requested explicitly. .TP .B indications -A read-only count of the received PFC frames per traffic class. Only shown -when -s is given, or when requested explicitly. +A read-only count of the received PFC frames per traffic class. +Only shown when \-s is given, or when requested explicitly. .TP .B macsec-bypass \fR{ \fBon\fR | \fBoff\fR } @@ -81,8 +85,10 @@ MACsec is disabled. .B prio-pfc \fIPFC-MAP \fIPFC-MAP\fR uses the array parameter syntax, see .BR dcb (8) -for details. Keys are priorities, values are on / off indicators of whether -PFC is enabled for a given priority. +for details. +Keys are priorities, +values are on / off indicators of whether PFC is enabled for a given +priority. .TP .B delay \fIINTEGER