]> git.openfabrics.org - ~shefty/ibacm.git/commitdiff
Update ib_acme.1 and ibacm.1 man pages
authorHal Rosenstock <hal@mellanox.com>
Sun, 16 Jun 2013 12:26:36 +0000 (15:26 +0300)
committerSean Hefty <sean.hefty@intel.com>
Fri, 28 Jun 2013 17:13:31 +0000 (10:13 -0700)
Signed-off-by: Hal Rosenstock <hal@mellanox.com>
Signed-off-by: Sean Hefty <sean.hefty@intel.com>
man/ib_acme.1
man/ibacm.1

index adea02370ad7b1c73532cb689f967593875b50ee..e89c6fd5a2f13c496c756826d95c66b77ccb45e3 100644 (file)
@@ -1,13 +1,13 @@
-.TH "ib_acme" 7 "2010-12-06" "ib_acme" "ib_acme" ib_acme
+.TH "ib_acme" 7 "2013-06-15" "ib_acme" "ib_acme" ib_acme
 .SH NAME
 ib_acme \- test and configuration utility for the IB ACM
 .SH SYNOPSIS
 .sp
 .nf
-\fIib_acme\fR [-f addr_format] [-s src_addr] -d dest_addr [-v]
+\fIib_acme\fR [-f addr_format] [-s src_addr] -d dest_addr [-v] [-c] [-P] [-S svc_addr]
 .fi
 .nf
-\fIib_acme\fR [-G] [-O]
+\fIib_acme\fR [-A [addr_file]] [-O [opt_file]] [-D dest_dir] [-V]
 .fi
 .SH "DESCRIPTION"
 ib_acme provides assistance configuring and testing the ibacm service.
@@ -42,17 +42,26 @@ resolved path information is usable given the current cluster configuration.
 Instructs the ACM service to only returned information that currently resides
 in its local cache.
 .TP
-\-A
+\-P
+Queries performance data from the destination service
+.TP
+\-S svc_addr
+address of ACM service, default: local service
+.TP
+\-A [addr_file]
 With this option, the ib_acme utility automatically generates the address
 configuration file ibacm_addr.cfg.  The generated file is
 constructed using the system host name and any IP addresses that are
 assigned to IPoIB device instances.
 .TP
-\-O
+\-O [opt_file]
 With this option, the ib_acme utility automatically generates the option
 configuration file ibacm_opts.cfg.  The generated file is currently generated
 using static information.
 .TP
+\-D dest_dir
+Specify the destination directory for the output files.
+.TP
 \-V
 Enables verbose output.  When combined with -A or -O options, ib_acme will
 display additional details, such as generated address information saved
@@ -78,4 +87,4 @@ numerical ranges inside the brackets using the following example as a
 guide: node[1-3,5,7-8].  This will result in testing node1, node2, node3,
 node5, node7, and node8.
 .SH "SEE ALSO"
-ibacm(7) ibacm(1)
+ibacm(7), ibacm(1)
index 075b98e61ca7b78b75b96718d9d46f772325de61..35b79c6646b40d5f06cf90921f1fa196d160dbbf 100644 (file)
@@ -1,10 +1,10 @@
-.TH "ibacm" 1 "2012-03-01" "ibacm" "ibacm" ibacm
+.TH "ibacm" 1 "2013-06-15" "ibacm" "ibacm" ibacm
 .SH NAME
 ibacm \- address and route resolution services for InfiniBand.
 .SH SYNOPSIS
 .sp
 .nf
-\fIibacm\fR
+\fIibacm\fR [-D] [-P] [-A addr_file] [-O option_file]
 .fi
 .SH "DESCRIPTION"
 The IB ACM implements and provides a framework for name,
@@ -33,6 +33,19 @@ different fabric topologies.
 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 "OPTIONS"
+.TP
+\-D
+run in daemon mode (default)
+.TP
+\-P
+run as standard process
+.TP
+\-A addr_file
+address configuration file
+.TP
+\-O option_file
+option configuration file
 .SH "QUICK START GUIDE"
 1. Prerequisites: libibverbs and libibumad must be installed.
 The IB stack should be running with IPoIB configured.
@@ -46,6 +59,7 @@ These steps assume that the user has administrative privileges.
 the ibacm service is running.
 .P
 5. Install librdmacm, using the build option --with-ib_acm if needed.
+This build option is not needed with librdmacm 1.0.17 or newer.
 The librdmacm will automatically use the ibacm service.
 On failures, the librdmacm will fall back to normal resolution.
 .P
@@ -132,4 +146,4 @@ limited to 4.
 .P
 - The number of multicast groups that an endpoint can support is limited to 2.
 .SH "SEE ALSO"
-ibacm(7) ib_acme(1), rdma_cm(7)
+ibacm(7), ib_acme(1), rdma_cm(7)