diff options
author | Leon Romanovsky <leonro@mellanox.com> | 2017-06-26 15:54:44 +0300 |
---|---|---|
committer | Leon Romanovsky <leonro@mellanox.com> | 2017-06-26 15:55:25 +0300 |
commit | cec17adeabd7358d1b5fe314bf1c29dd35884b95 (patch) | |
tree | 9b46bc9ee4ce1c524173c2e8c18c0f19e23bb4cc | |
parent | e2a0349bacd06f5d10bde56f84f9ef09de645ef6 (diff) | |
download | iproute2-topic/rdmatool-netlink.tar.gz |
rdma: Add initial manual for the tooltopic/rdmatool-netlink
Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
-rw-r--r-- | man/man8/rdma.8 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/man/man8/rdma.8 b/man/man8/rdma.8 new file mode 100644 index 000000000..7578c15ee --- /dev/null +++ b/man/man8/rdma.8 @@ -0,0 +1,82 @@ +.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux" +.SH NAME +rdma \- RDMA tool +.SH SYNOPSIS +.sp +.ad l +.in +8 +.ti -8 +.B rdma +.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | " +.BR help " }" +.sp + +.ti -8 +.IR OBJECT " := { " +.BR dev " | " link " }" +.sp + +.ti -8 +.IR OPTIONS " := { " +\fB\-V\fR[\fIersion\fR] } + +.SH OPTIONS + +.TP +.BR "\-V" , " -Version" +Print the version of the +.B rdma +tool and exit. + +.SS +.I OBJECT + +.TP +.B dev +- RDMA device. + +.TP +.B link +- RDMA port related. + +.PP +The names of all objects may be written in full or +abbreviated form, for example +.B stats +can be abbreviated as +.B stat +or just +.B s. + +.SS +.I COMMAND + +Specifies the action to perform on the object. +The set of possible actions depends on the object type. +As a rule, it is possible to +.B show +(or +.B list +) objects, but some objects do not allow all of these operations +or have some additional commands. The +.B help +command is available for all objects. It prints +out a list of available commands and argument syntax conventions. +.sp +If no command is given, some default command is assumed. +Usually it is +.B list +or, if the objects of this class cannot be listed, +.BR "help" . + +.SH EXIT STATUS +Exit status is 0 if command was successful or a positive integer upon failure. + +.SH REPORTING BUGS +Report any bugs to the Linux RDMA mailing list +.B <linux-rdma@vger.kernel.org> +where the development and maintenance is primarily done. +You do not have to be subscribed to the list to send a message there. + +.SH AUTHOR +Leon Romanovsky <leonro@mellanox.com> |