]> git.openfabrics.org - ~shefty/librdmacm.git/commitdiff
rdma_xserver/client: Fix man page formatting
authorRoland Dreier <roland@purestorage.com>
Tue, 16 Oct 2012 19:44:39 +0000 (19:44 +0000)
committerSean Hefty <sean.hefty@intel.com>
Wed, 17 Oct 2012 00:28:33 +0000 (17:28 -0700)
Putting 'r' at the beginning of a line in the nroff source for man pages
is confusing to nroff because lines that start with a single quote
character ' or a dot character . are treated as control lines, which is
not what's intended here.  Some of the man page text ends up left out of
the formatted output.

Fix this by just wrapping the text slightly differently in the source
(which doesn't matter since nroff reflows the text anyway).  Also add a
missing ".TP" so that the -p and -c options are not run together in the
formatted output.

Signed-off-by: Roland Dreier <roland@purestorage.com>
man/rdma_xclient.1
man/rdma_xserver.1

index 087e7fe26079947264ad98d36aca107f08ade0d1..b4bb04560d2325fa089bb444647edf8602bd1a8c 100644 (file)
@@ -20,9 +20,10 @@ By default, the client will attempt to connect to the server using
 \-p server_port
 Specifies the port number that the server listens on.  By default the server
 listens on port 7471.
+.TP
 \-c communication type
-Specifies the type of communication established with the server program.
-'r' results in using a reliable-connected QP (the default).  'x' uses
+Specifies the type of communication established with the server program.  'r'
+results in using a reliable-connected QP (the default).  'x' uses
 extended reliable-connected XRC QPs.
 .SH "NOTES"
 Basic usage is to start rdma_xserver, then connect to the server using the
index 75529e418a515ddff7a09d27fb28e3dc8fa92b2b..a26c96239389e27e7e76183983d0800738728bbd 100644 (file)
@@ -14,9 +14,10 @@ data.
 \-p port
 Changes the port number that the server listens on.  By default the server
 listens on port 7471.
+.TP
 \-c communication type
-Specifies the type of communication established with the client program.
-'r' results in using a reliable-connected QP (the default).  'x' uses
+Specifies the type of communication established with the client program.  'r'
+results in using a reliable-connected QP (the default).  'x' uses
 extended reliable-connected XRC QPs.
 .SH "NOTES"
 Basic usage is to start rdma_xserver, then connect to the server using the