contrib/ofed/librdmacm/man/rping.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RPING" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 rping \- RDMA CM connection and RDMA ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIrping\fR -s [-v] [-V] [-d] [-P] [-a address] [-p port]
   9                 [-C message_count] [-S message_size]
  10 \fIrping\fR -c [-v] [-V] [-d] [-I address] -a address [-p port]
  11                 [-C message_count] [-S message_size]
  12 .fi
  13 .SH "DESCRIPTION"
  14 Establishes a reliable RDMA connection between two nodes using the
  15 librdmacm, optionally performs RDMA transfers between the nodes,
  16 then disconnects.
  17 .SH "OPTIONS"
  18 .TP
  19 \-s
  20 Run as the server.
  21 .TP
  22 \-c
  23 Run as the client.
  24 .TP
  25 \-a address
  26 On the server, specifies the network address to bind the connection to.
  27 To bind to any address with IPv6 use -a ::0 .
  28 On the client, specifies the server address to connect to.
  29 .TP
  30 \-I address
  31 The address to bind to as the source IP address to use. This is useful
  32 if you have multiple addresses on the same network or complex routing.
  33 .TP
  34 \-p
  35 Port number for listening server.
  36 .TP
  37 \-v
  38 Display ping data.
  39 .TP
  40 \-V
  41 Validate ping data.
  42 .TP
  43 \-d
  44 Display debug information.
  45 .TP
  46 \-C message_count
  47 The number of messages to transfer over each connection.  (default infinite)
  48 .TP
  49 \-S message_size
  50 The size of each message transferred, in bytes.  (default 100)
  51 .TP
  52 \-P
  53 Run the server in persistent mode.  This allows multiple rping clients
  54 to connect to a single server instance. The server will run until killed.
  55 .SH "NOTES"
  56 Because this test maps RDMA resources to userspace, users must ensure
  57 that they have available system resources and permissions.  See the
  58 libibverbs README file for additional details.
  59 .SH "SEE ALSO"
  60 rdma_cm(7), ucmatose(1), udaddy(1), mckey(1)