freebsd-dev/contrib/ofed/librdmacm/man/rdma_xclient.1
Hans Petter Selasky d6b92ffa99 OFED user-space import and update for use with Linux-4.9 compatible RDMA
kernel APIs.

List of sources used:

1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git"
Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75

2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git
Top commit 85f841cf209f791c89a075048a907020e924528d

3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git"
Tag 1.3.13 with some additional patches from Mellanox.

4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git"
Tag 1.6.7 with some additional patches from Mellanox.

Added the required Makefiles for building and installing.

Sponsored by:	Mellanox Technologies
2017-08-02 16:00:30 +00:00

38 lines
1.4 KiB
Groff

.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.TH "RDMA_XCLIENT" 1 "2011-06-15" "librdmacm" "librdmacm" librdmacm
.SH NAME
rdma_xclient \- RDMA CM communication client test program
.SH SYNOPSIS
.sp
.nf
\fIrdma_xclient\fR [-s server_address] [-p server_port] [-c comm_type]
.fi
.SH "DESCRIPTION"
Uses synchronous librdmam calls to establish an RDMA connection between
two nodes. This example is intended to provide a very simple coding
example of how to use RDMA.
.SH "OPTIONS"
.TP
\-s server_address
Specifies the address of the system that the rdma_server is running on.
By default, the client will attempt to connect to the server using
127.0.0.1.
.TP
\-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
extended reliable-connected XRC QPs.
.SH "NOTES"
Basic usage is to start rdma_xserver, then connect to the server using the
rdma_client program.
.P
Because this test maps RDMA resources to userspace, users must ensure
that they have available system resources and permissions. See the
libibverbs README file for additional details.
.SH "SEE ALSO"
rdma_cm(7), udaddy(1), mckey(1), rping(1), rdma_xserver(1), rdma_client(1)