man pages: Consistency improvements

Signed-off-by: Stefan Raspl <raspl@linux.ibm.com>

Author: Stefan Raspl

README.md

@@ -45,6 +45,7 @@ Release History:
     - `smc_rnics`: Use '`n/a`' to indicate missing PNET ID
     - `smc_chk`: New tool to perform SMC eligilibilty checks, requires `man` and
                `python3` to be installed
+    - `man` pages: Consistency improvements
 
     Bug fixes:
     - `smc_pnet.8`: Use correct spelling for 'PNET ID'

smc-device.8

@@ -154,5 +154,5 @@ PNET-ID of the device. "*" means PNET-ID is set by the user.
 
 .SH SEE ALSO
 .br
-.BR smc (8),
-.BR smc-linkgroup (8)
+.BR smcd (8),
+.BR smcr (8)

smc-linkgroup.8

@@ -212,5 +212,5 @@ GID of the peer RoCE port used by the link.
 
 .SH SEE ALSO
 .br
-.BR smc (8),
-.BR smc-device (8)
+.BR smcd (8),
+.BR smcr (8)

smc.8

@@ -17,7 +17,7 @@ smc \- Print information about SMC linkgroups, links, devices
 .sp
 
 .IR OBJECT " := { "
-.BR linkgroup " | " device " }"
+.BR linkgroup " | " device " | " info " }"
 .sp
 
 .IR OPTIONS " := { "
@@ -46,13 +46,17 @@ Print more detailed information.
 .SS
 .I OBJECT
 
-.B linkgroup
-Linkgroup(s) or link(s) of the SMC.
-
-.TP
 .B device
 Device(s) of the SMC.
 
+.TP
+.B info
+Generic SMC information.
+
+.TP
+.B linkgroup
+Linkgroup(s) or link(s) of the SMC.
+
 .PP
 The names of all objects can be abbreviated down to
 a unique stem. For example
@@ -93,4 +97,5 @@ writes a message to stderr and completes with a return code other than 0.
 .SH SEE ALSO
 .BR af_smc (7),
 .BR smc-device (8),
+.BR smc-info (8),
 .BR smc-linkgroup (8)

smc_chk.8

@@ -4,7 +4,7 @@
 
 
 .SH NAME
-smc_chk \- SMC support diagnostics.
+smc_chk \- SMC support diagnostics
 
 
 .SH SYNOPSIS
@@ -14,31 +14,41 @@ smc_chk \- SMC support diagnostics.
 .BI "smc_chk -i "INTERFACE
 
 .SH DESCRIPTION
-Use option
+Use
 .B -C/--connect
-for diagnostics on SMC support of a service running at
-.IR IP .
-In absence of a particular service to test with, use option
+to obtain diagnostic information about the SMC support of a service that runs at a
+given
+.IR IP
+address.
+Otherwise, you can use
 .B -S/--server
-to start a server and
-.B -C/--connect
-for manual live tests.
-Or use option
-.B -i
-to print the PNET ID of the specified
+to start a server before connecting with
+.IR -C .
+Use
+.B -i/--pnetid
+to print the PNET ID of a specified
 .IR INTERFACE .
 
 
 .SH OPTIONS
 .TP
 .BI "\-C, \-\-connect " IP
-Test SMC-D and/or SMC-R connectivity to
+Test SMC-D and SMC-R connectivity to
 .IR IP .
 Use option
 .B -p/--port
 to specify a
 .IR PORT .
-Can be used with any (remote) service.
+.I IP
+can specify any service, including remote services.
+By default,
+.I IP
+is assumed be in IPv4 format.
+Specify
+.B -6/--IPv6
+if
+.I IP
+is an address in IPv6 format.
 .TP
 .BR "\-d, \-\-debug "
 Show debug messages.
@@ -49,7 +59,7 @@ Display a brief
 usage information.
 .TP
 .BI "\-i, \-\-pnetid " INTERFACE
-Print PNET ID of interface
+Print the PNET ID of interface
 .I INTERFACE
 and exit.
 .TP
@@ -58,19 +68,19 @@ Use port
 .I PORT
 for any live tests. If
 .I PORT
-is already in use, the next free port will be used.
+is already in use, the next free port is used.
 .TP
 .BR "\-S, \-\-server"
 Start a server for manual tests. Use option
 .B -p/--port
-to specify a
-.IR PORT .
+to specify a port.
 .TP
 .BR "\-v, \-\-version"
 Display version information.
 .TP
 .BR "\-6, \-\-ipv6"
-IP address provided in IPv6 format.
+.I IP
+address provided is in IPv6 format.
 
 
 .SH Examples
@@ -99,4 +109,4 @@ If an error occurs, a return code other than 0 is returned.
 .BR smc_run (8),
 .BR smcd (8),
 .BR smcr (8),
-.BR smcss (8),
+.BR smcss (8)

smc_pnet.8

@@ -10,7 +10,7 @@
 .TH SMC_PNET 8 "January 2017" "smc-tools" "Linux Programmer's Manual"
 
 .SH NAME
-smc_pnet \- create, destroy, and change the SMC PNET table.
+smc_pnet \- create, destroy, and change the SMC PNET table
 
 .SH SYNOPSIS
 
@@ -172,7 +172,6 @@ completes with a return code other than 0.
 .BR smc_chk (8)
 .BR smc_rnics (8),
 .BR smc_run (8),
-.BR smcss (8),
-.BR smc (8),
-.BR smc-linkgroup (8),
-.BR smc-device (8)
+.BR smcd (8),
+.BR smcr (8),
+.BR smcss (8)

smc_rnics.8

@@ -4,7 +4,7 @@
 
 
 .SH NAME
-smc_rnics \- list, enable and disable (R)NICS as used by SMC-R and SMC-D.
+smc_rnics \- list, enable and disable (R)NICS as used by SMC-R and SMC-D
 
 
 .SH SYNOPSIS
@@ -110,7 +110,6 @@ If an error occurs, a return code other than 0 is returned.
 .BR af_smc (7),
 .BR smc_pnet (8),
 .BR smc_run (8),
-.BR smcss (8),
-.BR smc (8),
-.BR smc-linkgroup (8),
-.BR smc-device (8)
+.BR smcd (8),
+.BR smcr (8),
+.BR smcss (8)

smc_run.8

@@ -8,7 +8,7 @@
 .TH SMC_RUN 8 "January 2017" "smc-tools" "Linux Programmer's Manual "
 .SH NAME
 smc_run \- start a TCP socket program with the capability to use SMC as
-networking protocol.
+networking protocol
 
 .SH SYNOPSIS
 
@@ -52,8 +52,7 @@ An invalid option was specified.
 .BR smc_chk (8)
 .BR smc_pnet (8),
 .BR smc_rnics (8),
+.BR smcd (8),
+.BR smcr (8),
 .BR smcss (8),
-.BR smc (8),
-.BR smc-linkgroup (8),
-.BR smc-device (8),
 .BR tcp (7)

smcd-device.8

@@ -164,6 +164,4 @@ PNET-ID of the device. Preceding "*" means PNET-ID is set by the user. (e.g "*PN
 .SH SEE ALSO
 .br
 .BR smcd (8),
-.BR smcr (8),
-.BR smcd-linkgroup (8),
-.BR smcr-linkgroup (8)
+.BR smcr (8)

smcd-linkgroup.8

@@ -219,6 +219,4 @@ GID of the peer RoCE port used by the link.
 .SH SEE ALSO
 .br
 .BR smcd (8),
-.BR smcr (8),
-.BR smcd-device (8),
-.BR smcr-device (8)
+.BR smcr (8)