contrib/ofed/librdmacm/man/rping.1

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