[ofa-general] [PATCH] libibumad/man: umad_get_pkey man page

Sasha Khapyorsky sashak at voltaire.com
Tue Jan 15 11:05:40 PST 2008


Signed-off-by: Sasha Khapyorsky <sashak at voltaire.com>
---
 libibumad/Makefile.am         |    1 +
 libibumad/man/umad_get_pkey.3 |   23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+), 0 deletions(-)
 create mode 100644 libibumad/man/umad_get_pkey.3

diff --git a/libibumad/Makefile.am b/libibumad/Makefile.am
index 5b8a69a..f014f57 100644
--- a/libibumad/Makefile.am
+++ b/libibumad/Makefile.am
@@ -12,6 +12,7 @@ man_MANS = man/umad_debug.3 man/umad_get_ca.3 \
 	   man/umad_get_mad.3 man/umad_get_mad_addr.3 \
 	   man/umad_set_grh_net.3 man/umad_set_grh.3 \
 	   man/umad_set_addr_net.3 man/umad_set_addr.3 man/umad_set_pkey.3 \
+	   man/umad_get_pkey.3 \
 	   man/umad_register.3 man/umad_register_oui.3 man/umad_unregister.3 \
 	   man/umad_send.3 man/umad_recv.3 man/umad_poll.3 \
 	   man/umad_get_issm_path.3
diff --git a/libibumad/man/umad_get_pkey.3 b/libibumad/man/umad_get_pkey.3
new file mode 100644
index 0000000..a03c0a6
--- /dev/null
+++ b/libibumad/man/umad_get_pkey.3
@@ -0,0 +1,23 @@
+.\" -*- nroff -*-
+.\"
+.TH UMAD_GET_PKEY 3  "Jan 15, 2008" "OpenIB" "OpenIB Programmer\'s Manual"
+.SH "NAME"
+umad_get_pkey \- get pkey index from umad buffer
+.SH "SYNOPSIS"
+.nf
+.B #include <infiniband/umad.h>
+.sp
+.BI "int umad_get_pkey(void " "*umad");
+.fi
+.SH "DESCRIPTION"
+.B umad_get_pkey()
+gets the pkey index from the specified
+.I umad\fR
+buffer.
+.SH "RETURN VALUE"
+.B umad_get_pkey()
+returns value of pkey index (or zero if pkey index is not supported by
+user_mad interface).
+.SH "AUTHOR"
+.TP
+Sasha Khapyorsky <sashak at voltaire.com>
-- 
1.5.4.rc2.60.gb2e62




More information about the general mailing list