--- /dev/null
+Bottom: ee5a2628067bf8a3611baad080f8c5d89dde03ae
+Top: 5988260ae44191fb9e9ef4fcd0fe294df404610d
+Author: Sean Hefty <sean.hefty@intel.com>
+Date: 2012-03-01 16:52:51 -0800
+
+Refresh of rename-ibacm
+
+---
+
+diff --git a/man/ibacm.1 b/man/ibacm.1
+index af57d0b..ed4b7a5 100644
+--- a/man/ibacm.1
++++ b/man/ibacm.1
+@@ -1,10 +1,10 @@
+-.TH "ib_acm" 1 "2010-12-08" "ib_acm" "ib_acm" ib_acm
++.TH "ibacm" 1 "2012-03-01" "ibacm" "ibacm" ibacm
+ .SH NAME
+-ib_acm \- address and route resolution services for InfiniBand.
++ibacm \- address and route resolution services for InfiniBand.
+ .SH SYNOPSIS
+ .sp
+ .nf
+-\fIib_acm\fR
++\fIibacm\fR
+ .fi
+ .SH "DESCRIPTION"
+ The IB ACM implements and provides a framework for name,
+@@ -13,8 +13,8 @@ It is intended to address connection setup scalability issues running
+ MPI applications on large clusters. The IB ACM provides information
+ needed to establish a connection, but does not implement the CM protocol.
+ .P
+-A primary user of the ib_acm service is the librdmacm library. This
+-enables applications to make use of the ib_acm service without code
++A primary user of the ibacm service is the librdmacm library. This
++enables applications to make use of the ibacm service without code
+ changes or needing to be aware that the service is in use.
+ The librdmacm can invoke IB ACM services when built using the --with-ib_acm
+ option. The IB ACM services tie in under the rdma_resolve_addr,
+@@ -28,7 +28,7 @@ implementation limits network traffic, SA interactions, and centralized
+ services. ACM supports multiple resolution protocols in order to handle
+ different fabric topologies.
+ .P
+-The IB ACM package is comprised of two components: the ib_acm service
++The IB ACM package is comprised of two components: the ibacm service
+ and a test/configuration utility - ib_acme. Both are userspace components
+ and are available for Linux and Windows. Additional details are given below.
+ .SH "QUICK START GUIDE"
+@@ -36,71 +36,71 @@ and are available for Linux and Windows. Additional details are given below.
+ The IB stack should be running with IPoIB configured.
+ These steps assume that the user has administrative privileges.
+ .P
+-2. Install the IB ACM package. This installs ib_acm, and ib_acme.
++2. Install the IB ACM package. This installs ibacm, and ib_acme.
+ .P
+-3. Run 'ib_acm' as administrator to start the ib_acm daemon.
++3. Run 'ibacm' as administrator to start the ibacm daemon.
+ .P
+ 4. Optionally, run 'ib_acme -d <dest_ip> -v' to verify that
+-the ib_acm service is running.
++the ibacm service is running.
+ .P
+ 5. Install librdmacm using the build option --with-ib_acm.
+-The librdmacm will automatically use the ib_acm service.
++The librdmacm will automatically use the ibacm service.
+ On failures, the librdmacm will fall back to normal resolution.
+ .SH "NOTES"
+ ib_acme:
+ .P
+ The ib_acme program serves a dual role. It acts as a utility to test
+-ib_acm operation and help verify if the ib_acm service and selected
++ibacm operation and help verify if the ibacm service and selected
+ protocol is usable for a given cluster configuration. Additionally,
+-it automatically generates ib_acm configuration files to assist with
++it automatically generates ibacm configuration files to assist with
+ or eliminate manual setup.
+ .P
+ acm configuration files:
+ .P
+-The ib_acm service relies on two configuration files.
++The ibacm service relies on two configuration files.
+ .P
+ The acm_addr.cfg file contains name and address mappings for each IB
+ <device, port, pkey> endpoint. Although the names in the acm_addr.cfg
+ file can be anything, ib_acme maps the host name and IP addresses to
+-the IB endpoints. If the address file cannot be found, the ib_acm
++the IB endpoints. If the address file cannot be found, the ibacm
+ service will attempt to create one using default values.
+ .P
+ The acm_opts.cfg file provides a set of configurable options for the
+-ib_acm service, such as timeout, number of retries, logging level, etc.
++ibacm service, such as timeout, number of retries, logging level, etc.
+ ib_acme generates the acm_opts.cfg file using static information. If
+-an option file cannot be found, ib_acm will use default values.
++an option file cannot be found, ibacm will use default values.
+ .P
+-ib_acm:
++ibacm:
+ .P
+-The ib_acm service is responsible for resolving names and addresses to
++The ibacm service is responsible for resolving names and addresses to
+ InfiniBand path information and caching such data. It
+ should execute with administrative privileges.
+ .P
+-The ib_acm implements a client interface over TCP sockets, which is
++The ibacm implements a client interface over TCP sockets, which is
+ abstracted by the librdmacm library. One or more back-end protocols are
+-used by the ib_acm service to satisfy user requests. Although the
+-ib_acm supports standard SA path record queries on the back-end, it
++used by the ibacm service to satisfy user requests. Although the
++ibacm supports standard SA path record queries on the back-end, it
+ also supports a resolution protocol based on multicast traffic.
+ The latter is not usable on all fabric topologies, specifically
+ ones that may not have reversible paths or fabrics using torus routing.
+ Users should use the ib_acme utility to verify that multicast protocol
+ is usable before running other applications.
+ .P
+-Conceptually, the ib_acm service implements an ARP like protocol and either
++Conceptually, the ibacm service implements an ARP like protocol and either
+ uses IB multicast records to construct path record data or queries the
+ SA directly, depending on the selected route protocol. By default, the
+-ib_acm services uses and caches SA path record queries.
++ibacm services uses and caches SA path record queries.
+ .P
+ Specifically, all IB endpoints join a number of multicast groups.
+ Multicast groups differ based on rates, mtu, sl, etc., and are prioritized.
+ All participating endpoints must be able to communicate on the lowest
+-priority multicast group. The ib_acm assigns one or more names/addresses
++priority multicast group. The ibacm assigns one or more names/addresses
+ to each IB endpoint using the acm_addr.cfg file. Clients provide source
+ and destination names or addresses as input to the service, and receive
+ as output path record data.
+ .P
+ The service maps a client's source name/address to a local IB endpoint.
+-If a client does not provide a source address, then the ib_acm service
++If a client does not provide a source address, then the ibacm service
+ will select one based on the destination and local routing tables. If the
+ destination name/address is not cached locally, it sends a multicast
+ request out on the lowest priority multicast group on the local endpoint.
+@@ -114,8 +114,8 @@ data, which is returned to the client.
+ .P
+ The current implementation of the IB ACM has several additional restrictions:
+ .P
+-- The ib_acm is limited in its handling of dynamic changes.
+-ib_acm must be stopped and restarted if a cluster is reconfigured.
++- The ibacm is limited in its handling of dynamic changes.
++ibacm must be stopped and restarted if a cluster is reconfigured.
+ .P
+ - Cached data does not timed out and is only updated if a new resolution
+ request is received from a different QPN than a cached request.
+@@ -127,4 +127,4 @@ limited to 4.
+ .P
+ - The number of multicast groups that an endpoint can support is limited to 2.
+ .SH "SEE ALSO"
+-ib_acm(7) ib_acme(1), rdma_cm(7)
++ibacm(7) ib_acme(1), rdma_cm(7)
+diff --git a/man/ibacm.7 b/man/ibacm.7
+index f26ffb8..22c28a3 100644
+--- a/man/ibacm.7
++++ b/man/ibacm.7
+@@ -1,6 +1,6 @@
+-.TH "IB_ACM" 7 "2009-09-09" "IB_ACM" "IB ACM User Guide" IB_ACM\r
++.TH "IBACM" 7 "2012-03-01" "IBACM" "IB ACM User Guide" IBACM\r
+ .SH NAME\r
+-ib_acm \- InfiniBand communication management assistant\r
++ibacm \- InfiniBand communication management assistant\r
+ .SH SYNOPSIS\r
+ .B "#include <infiniband/ib_acm.h>"\r
+ .SH "DESCRIPTION"\r
+@@ -19,9 +19,9 @@ The IB ACM does not require IPoIB or use standard naming services, such as
+ DNS, and limits network communication, especially with the IB SA.\r
+ Because it uses multicast traffic and limits SA interaction, it may\r
+ not support all cluster configurations. The ib_acme utility assists in\r
+-verifying what options of the ib_acm service may be usable.\r
++verifying what options of the ibacm service may be usable.\r
+ .P\r
+-Client interactions with the ib_acm service are done over sockets through\r
++Client interactions with the ibacm service are done over sockets through\r
+ a standard TCP connection. The librdmacm abstracts this interaction.\r
+ .SH "RETURN CODES"\r
+ .IP "== 0"\r
+@@ -30,4 +30,4 @@ success
+ error\r
+ .SH "SEE ALSO"\r
+ ib_acm_resolve_name(3), ib_acm_resolve_ip(3), ib_acm_resolve_path(3)\r
+-ib_acme(1), ib_acm(1)\r
++ib_acme(1), ibacm(1)
projects / ~shefty / ibacm.git / commitdiff