librdmacm/man: add man pages for new APIs

Signed-off-by: Sean Hefty <sean.hefty@intel.com>

diff --git a/Makefile.am b/Makefile.am
index 8701002cf7e75f4fe9bd7625b89ad0a735a94f41..8e96fddecc3c12b0660a2b7de4498c575f1d9c9d 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -68,6 +68,9 @@ man_MANS = \
        man/rdma_resolve_route.3 \
        man/rdma_event_str.3 \
        man/rdma_set_option.3 \
+       man/rdma_create_ep.3 \
+       man/rdma_destroy_ep.3 \
+       man/rdma_getaddrinfo.3 \
        man/ucmatose.1 \
        man/udaddy.1 \
        man/mckey.1 \

diff --git a/man/rdma_destroy_ep.3 b/man/rdma_destroy_ep.3
new file mode 100644 (file)
index 0000000..a88294e
--- /dev/null
+++ b/man/rdma_destroy_ep.3
@@ -0,0 +1,18 @@
+.TH "RDMA_DESTROY_EP" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.SH NAME
+rdma_destroy_ep \- Release a communication identifier.
+.SH SYNOPSIS
+.B "#include <rdma/rdma_cma.h>"
+.P
+.B "int" rdma_destroy_ep
+.BI "(struct rdma_cm_id *" id ");"
+.SH ARGUMENTS
+.IP "id" 12
+The communication identifier to destroy.
+.SH "DESCRIPTION"
+Destroys the specified rdma_cm_id and all associated resources
+.SH "NOTES"
+rdma_destroy_ep will automatically destroy any QP associated with
+the rdma_cm_id.
+.SH "SEE ALSO"
+rdma_create_ep(3)

diff --git a/man/rdma_getaddrinfo.3 b/man/rdma_getaddrinfo.3
new file mode 100644 (file)
index 0000000..8a1d601
--- /dev/null
+++ b/man/rdma_getaddrinfo.3
@@ -0,0 +1,83 @@
+.TH "RDMA_GETADDRINFO" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.SH NAME
+rdma_getaddrinfo \- Provides transport independent address translation.
+.SH SYNOPSIS
+.B "#include <rdma/rdma_cma.h>"
+.P
+.B "int" rdma_getaddrinfo
+.BI "(char *" node ","
+.BI "char *" service ","
+.BI "struct rdma_addrinfo *" hints ","
+.BI "struct rdma_addrinfo **" res ");"
+.SH ARGUMENTS
+.IP "node" 12
+Optional, name, dotted-decimal IPv4, or IPv6 hex address to resolve.
+.IP "service" 12
+Service name or port number of address.
+.IP "hints" 12
+Reference to an rdma_addrinfo structure containing hints about the type
+of service the caller supports.
+.IP "res" 12
+A pointer to a linked list of rdma_addrinfo structures containing response
+information.
+.SH "DESCRIPTION"
+Resolves the destination node and service address and returns
+information needed to establish communication.  Provides the
+RDMA functional equivalent to getaddrinfo.
+.SH "NOTES"
+Either node or service must be provided.  If hints are provided, the
+operation will be controlled by hints.ai_flags.  If RAI_PASSIVE is
+specified, the call will resolve address information for use on the
+passive side of a connection.
+.SH "rdma_addrinfo"
+.IP "ai_flags" 12
+Hint flags that control the operation.  Supported flags are:
+.P
+RAI_PASSIVE - indicates that the results will be used on the passive/listening
+side of a connection.
+.IP "ai_family" 12
+Address family for the source and destination address.  Supported families
+are: AF_INET, AF_INET6, and AF_IB.
+.IP "ai_qp_type" 12
+Indicates the type of RDMA QP used for communication.  Supported types are:
+IBV_UD (unreliable datagram) and IBV_RC (reliable connected).
+.IP "ai_port_space" 12
+RDMA port space in use.  Supported values are: RDMA_PS_UDP and RDMA_PS_TCP.
+.IP "ai_src_len" 12
+The length of the source address referenced by ai_src_addr.  This will be 0
+if an appropriate source address could not be discovered for a given
+destination.
+.IP "ai_dst_len" 12
+The length of the destination address referenced by ai_dst_addr.  This
+will be 0 if the RAI_PASSIVE flag was specified as part of the hints.
+.IP "ai_src_addr" 12
+If provided, the address for the local RDMA device.
+.IP "ai_dst_addr" 12
+If provided, the address for the destination RDMA device.
+.IP "ai_src_canonname" 12
+The canonical for the source.
+.IP "ai_dst_canonname" 12
+The canonical for the destination.
+.IP "ai_route_len" 12
+Size of the routing information buffer referenced by ai_route.  This will
+be 0 if the underlying transport does not require routing data, or none 
+could be resolved.
+.IP "ai_route" 12
+Routing information for RDMA transports that require routing data as part
+of connection establishment.  The format of the routing data depends on
+the underlying transport.  If Infiniband transports are
+used, ai_route will reference an array of struct ib_path_data.
+.IP "ai_connect_len" 12
+Size of connection information referenced by ai_connect.  This will be
+0 if the underlying transport does not require additional connection
+information.
+.IP "ai_connect" 12
+Data exchanged as part of the connection establishment process.  If provided,
+ai_connect data must be transferred as private data, with any user supplied
+private data following it.
+.IP "ai_next" 12
+Pointer to the next rdma_addrinfo structure in the list.  Will be NULL
+if no more structures exist.
+.SH "SEE ALSO"
+rdma_create_id(3), rdma_resolve_route(3), rdma_connect(3), rdma_create_qp(3),
+rdma_bind_addr(3), rdma_create_ep(3)