Updated nroff-generated man pages

Signed-off-by: OFIWG Bot <ofiwg@lists.openfabrics.org>
pmodels · Oct 11, 2024 · 64426b9 · 64426b9
1 parent 527d320
commit 64426b9
Show file tree

Hide file tree

Showing 53 changed files with 1,273 additions and 510 deletions.
diff --git a/fabtests/man/man7/fabtests.7 b/fabtests/man/man7/fabtests.7
@@ -1,6 +1,20 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
-.TH "fabtests" "7" "2024\-09\-13" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "fabtests" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
 .hy
 .SH NAME
 .PP
@@ -268,7 +282,7 @@ FI_ENORX) can be read by the application, if RNR happens.
 \f[I]fi_efa_rnr_queue_resend\f[R]
 This test modifies the RNR retry count (rnr_retry) to 0 via fi_setopt,
 and then tests RNR queue/re-send logic for different packet types.
-To run the test, one needs to use \f[C]-c\f[R] option to specify the
+To run the test, one needs to use \f[V]-c\f[R] option to specify the
 category of packet types.
 .SS Component tests
 .PP
@@ -448,9 +462,9 @@ The default endpoint type is rdm.
 Allocate data buffers on the specified device, rather than in host
 memory.
 Valid options are ze, cuda and synapseai.
+.TP
 *-a
-.IP \[bu] 2
-: The name of a shared address vector.
+The name of a shared address vector.
 This option only applies to tests that support shared address vectors.
 .TP
 \f[I]-B \f[R]
@@ -462,9 +476,9 @@ endpoints to the server.
 .TP
 \f[I]-P \f[R]
 Specifies the port number of the peer endpoint, overriding the default.
+.TP
 *-s
-.IP \[bu] 2
-: Specifies the address of the local endpoint.
+Specifies the address of the local endpoint.
 .TP
 *-F 
 Specifies the address format.

diff --git a/man/man1/fi_info.1 b/man/man1/fi_info.1
@@ -1,6 +1,20 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
-.TH "fi_info" "1" "2024\-08\-03" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "fi_info" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
 .hy
 .SH NAME
 .PP
@@ -56,7 +70,7 @@ For more information on address formats, see fi_getinfo(3).
 .TP
 \f[I]-p, \[en]provider=<PROV>\f[R]
 Filter fabric interfaces by the provider implementation.
-For a list of providers, see the \f[C]--list\f[R] option.
+For a list of providers, see the \f[V]--list\f[R] option.
 .TP
 \f[I]-d, \[en]domain=<DOMAIN>\f[R]
 Filter interfaces to only those with the given domain name.
@@ -130,7 +144,7 @@ provider: tcp
 \f[R]
 .fi
 .PP
-To see the full fi_info structure, specify the \f[C]-v\f[R] option.
+To see the full fi_info structure, specify the \f[V]-v\f[R] option.
 .IP
 .nf
 \f[C]
@@ -223,7 +237,7 @@ fi_info:
 \f[R]
 .fi
 .PP
-To see libfabric related environment variables \f[C]-e\f[R] option.
+To see libfabric related environment variables \f[V]-e\f[R] option.
 .IP
 .nf
 \f[C]
@@ -243,7 +257,7 @@ $ ./fi_info -e
 .fi
 .PP
 To see libfabric related environment variables with substring use
-\f[C]-g\f[R] option.
+\f[V]-g\f[R] option.
 .IP
 .nf
 \f[C]
@@ -281,6 +295,6 @@ $ ./fi_info -g tcp
 .fi
 .SH SEE ALSO
 .PP
-\f[C]fi_getinfo(3)\f[R], \f[C]fi_endpoint(3)\f[R]
+\f[V]fi_getinfo(3)\f[R], \f[V]fi_endpoint(3)\f[R]
 .SH AUTHORS
 OpenFabrics.
diff --git a/man/man1/fi_pingpong.1 b/man/man1/fi_pingpong.1
@@ -1,6 +1,20 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
-.TH "fi_pingpong" "1" "2024\-04\-04" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "fi_pingpong" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
 .hy
 .SH NAME
 .PP
@@ -21,7 +35,7 @@ fi_pingpong also displays aggregated statistics after each test run, and
 can additionally verify data integrity upon receipt.
 .PP
 By default, the datagram (FI_EP_DGRAM) endpoint is used for the test,
-unless otherwise specified via \f[C]-e\f[R].
+unless otherwise specified via \f[V]-e\f[R].
 .SH HOW TO RUN TESTS
 .PP
 Two copies of the program must be launched: first, one copy must be
@@ -47,15 +61,15 @@ client$ fi_pingpong <server address>
 .PP
 The server and client must be able to communicate properly for the
 fi_pingpong utility to function.
-If any of the \f[C]-e\f[R], \f[C]-I\f[R], \f[C]-S\f[R], or \f[C]-p\f[R]
+If any of the \f[V]-e\f[R], \f[V]-I\f[R], \f[V]-S\f[R], or \f[V]-p\f[R]
 options are used, then they must be specified on the invocation for both
 the server and the client process.
-If the \f[C]-d\f[R] option is specified on the server, then the client
+If the \f[V]-d\f[R] option is specified on the server, then the client
 will select the appropriate domain if no hint is provided on the client
 side.
-If the \f[C]-d\f[R] option is specified on the client, then it must also
+If the \f[V]-d\f[R] option is specified on the client, then it must also
 be specified on the server.
-If both the server and client specify the \f[C]-d\f[R] option and the
+If both the server and client specify the \f[V]-d\f[R] option and the
 given domains cannot communicate, then the application will fail.
 .SS Control Messaging
 .TP
@@ -110,19 +124,19 @@ Activate output debugging (warning: highly verbose)
 Displays help output for the pingpong test.
 .SH USAGE EXAMPLES
 .SS A simple example
-.SS Server: \f[C]fi_pingpong -p <provider_name>\f[R]
+.SS Server: \f[V]fi_pingpong -p <provider_name>\f[R]
 .PP
-\f[C]server$ fi_pingpong -p sockets\f[R]
-.SS Client: \f[C]fi_pingpong -p <provider_name> <server_addr>\f[R]
+\f[V]server$ fi_pingpong -p sockets\f[R]
+.SS Client: \f[V]fi_pingpong -p <provider_name> <server_addr>\f[R]
 .PP
-\f[C]client$ fi_pingpong -p sockets 192.168.0.123\f[R]
+\f[V]client$ fi_pingpong -p sockets 192.168.0.123\f[R]
 .SS An example with various options
 .SS Server:
 .PP
-\f[C]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R]
+\f[V]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R]
 .SS Client:
 .PP
-\f[C]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R]
+\f[V]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R]
 .PP
 Specifically, this will run a pingpong test with:
 .IP \[bu] 2
@@ -136,14 +150,14 @@ server node as 192.168.0.123
 .SS A longer test
 .SS Server:
 .PP
-\f[C]server$ fi_pingpong -p usnic -I 10000 -S all\f[R]
+\f[V]server$ fi_pingpong -p usnic -I 10000 -S all\f[R]
 .SS Client:
 .PP
-\f[C]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R]
+\f[V]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R]
 .SH DEFAULTS
 .PP
 There is no default provider; if a provider is not specified via the
-\f[C]-p\f[R] switch, the test will pick one from the list of available
+\f[V]-p\f[R] switch, the test will pick one from the list of available
 providers (as returned by fi_getinfo(3)).
 .PP
 If no endpoint type is specified, `dgram' is used.
@@ -178,6 +192,6 @@ client
 per second
 .SH SEE ALSO
 .PP
-\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3) \f[C]fabric\f[R](7),
+\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3) \f[V]fabric\f[R](7),
 .SH AUTHORS
 OpenFabrics.
diff --git a/man/man1/fi_strerror.1 b/man/man1/fi_strerror.1
@@ -1,6 +1,20 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
-.TH "fi_strerror" "1" "2022\-12\-09" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "fi_strerror" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
 .hy
 .SH NAME
 .PP
@@ -14,16 +28,16 @@ fi_strerror FI_ERROR_CODE
 .fi
 .SH DESCRIPTION
 .PP
-Display the error string for the given numeric \f[C]FI_ERROR_CODE\f[R].
-\f[C]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal
+Display the error string for the given numeric \f[V]FI_ERROR_CODE\f[R].
+\f[V]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal
 constant.
-Although the \f[C]fi_strerror\f[R](3) library function only accepts
+Although the \f[V]fi_strerror\f[R](3) library function only accepts
 positive error values, for convenience this utility accepts both
 positive and negative error values.
 .PP
 This is primarily a convenience tool for developers.
 .SH SEE ALSO
 .PP
-\f[C]fabric\f[R](7) \f[C]fi_errno\f[R](3)
+\f[V]fabric\f[R](7) \f[V]fi_errno\f[R](3)
 .SH AUTHORS
 OpenFabrics.
diff --git a/man/man3/fi_atomic.3 b/man/man3/fi_atomic.3
@@ -1,6 +1,20 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
-.TH "fi_atomic" "3" "2024\-08\-06" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "fi_atomic" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
 .hy
 .SH NAME
 .PP
@@ -129,7 +143,7 @@ Local data buffer to store initial value of remote buffer
 \f[I]desc / compare_desc / result_desc\f[R]
 Data descriptor associated with the local data buffer, local compare
 buffer, and local result buffer, respectively.
-See \f[C]fi_mr\f[R](3).
+See \f[V]fi_mr\f[R](3).
 .TP
 \f[I]dest_addr\f[R]
 Destination address for connectionless atomic operations.
@@ -693,11 +707,11 @@ parameter specifying the tag.
 .PP
 Returns 0 on success.
 On error, a negative value corresponding to fabric errno is returned.
-Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R].
+Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R].
 .SH ERRORS
 .TP
 \f[I]-FI_EAGAIN\f[R]
-See \f[C]fi_msg\f[R](3) for a detailed description of handling
+See \f[V]fi_msg\f[R](3) for a detailed description of handling
 FI_EAGAIN.
 .TP
 \f[I]-FI_EOPNOTSUPP\f[R]
@@ -741,11 +755,11 @@ assigned to the transmitting and receiving endpoints.
 Both message and data ordering are required if the results of two atomic
 operations to the same memory buffers are to reflect the second
 operation acting on the results of the first.
-See \f[C]fi_endpoint\f[R](3) for further details and message size
+See \f[V]fi_endpoint\f[R](3) for further details and message size
 restrictions.
 .SH SEE ALSO
 .PP
-\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3),
-\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3), \f[C]fi_rma\f[R](3)
+\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3),
+\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3), \f[V]fi_rma\f[R](3)
 .SH AUTHORS
 OpenFabrics.