contrib/ofed/librdmacm/man/rdma_xclient.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_XCLIENT" 1 "2011-06-15" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 rdma_xclient \- RDMA CM communication client test program
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIrdma_xclient\fR [-s server_address] [-p server_port] [-c comm_type]
   9 .fi
  10 .SH "DESCRIPTION"
  11 Uses synchronous librdmam calls to establish an RDMA connection between
  12 two nodes.  This example is intended to provide a very simple coding
  13 example of how to use RDMA.
  14 .SH "OPTIONS"
  15 .TP
  16 \-s server_address
  17 Specifies the address of the system that the rdma_server is running on.
  18 By default, the client will attempt to connect to the server using
  19 127.0.0.1.
  20 .TP
  21 \-p server_port
  22 Specifies the port number that the server listens on.  By default the server
  23 listens on port 7471.
  24 .TP
  25 \-c communication type
  26 Specifies the type of communication established with the server program.  'r'
  27 results in using a reliable-connected QP (the default).  'x' uses
  28 extended reliable-connected XRC QPs.
  29 .SH "NOTES"
  30 Basic usage is to start rdma_xserver, then connect to the server using the
  31 rdma_client program.
  32 .P
  33 Because this test maps RDMA resources to userspace, users must ensure
  34 that they have available system resources and permissions.  See the
  35 libibverbs README file for additional details.
  36 .SH "SEE ALSO"
  37 rdma_cm(7), udaddy(1), mckey(1), rping(1), rdma_xserver(1), rdma_client(1)