contrib/ofed/librdmacm/man/rdma_client.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_CLIENT" 1 "2010-07-19" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 rdma_client \- simple RDMA CM connection and ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIrdma_client\fR [-s server_address] [-p server_port]
   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 .SH "NOTES"
  25 Basic usage is to start rdma_server, then connect to the server using the
  26 rdma_client program.
  27 .P
  28 Because this test maps RDMA resources to userspace, users must ensure
  29 that they have available system resources and permissions.  See the
  30 libibverbs README file for additional details.
  31 .SH "SEE ALSO"
  32 rdma_cm(7), udaddy(1), mckey(1), rping(1), rdma_server(1)