Skip to content

Commit 0f7cc83

Browse files
ofiwg-botgithub-actions[bot]
ofiwg-bot
authored and
github-actions[bot]
committed
Updated nroff-generated man pages
Signed-off-by: OFIWG Bot <[email protected]>
1 parent e23da5b commit 0f7cc83

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+525
-1262
lines changed

‎fabtests/man/man7/fabtests.7‎

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.3
1+
.\" Automatically generated by Pandoc 2.9.2.1
22
.\"
3-
.\" Define V font for inline verbatim, using C font in formats
4-
.\" that render this, and otherwise B font.
5-
.ie "\f[CB]x\f[]"x" \{\
6-
. ftr V B
7-
. ftr VI BI
8-
. ftr VB B
9-
. ftr VBI BI
10-
.\}
11-
.el \{\
12-
. ftr V CR
13-
. ftr VI CI
14-
. ftr VB CB
15-
. ftr VBI CBI
16-
.\}
17-
.TH "fabtests" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
3+
.TH "fabtests" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
184
.hy
195
.SH NAME
206
.PP
@@ -282,7 +268,7 @@ FI_ENORX) can be read by the application, if RNR happens.
282268
\f[I]fi_efa_rnr_queue_resend\f[R]
283269
This test modifies the RNR retry count (rnr_retry) to 0 via fi_setopt,
284270
and then tests RNR queue/re-send logic for different packet types.
285-
To run the test, one needs to use \f[V]-c\f[R] option to specify the
271+
To run the test, one needs to use \f[C]-c\f[R] option to specify the
286272
category of packet types.
287273
.SS Component tests
288274
.PP
@@ -462,9 +448,9 @@ The default endpoint type is rdm.
462448
Allocate data buffers on the specified device, rather than in host
463449
memory.
464450
Valid options are ze, cuda and synapseai.
465-
.TP
466451
*-a
467-
The name of a shared address vector.
452+
.IP \[bu] 2
453+
: The name of a shared address vector.
468454
This option only applies to tests that support shared address vectors.
469455
.TP
470456
\f[I]-B \f[R]
@@ -476,9 +462,9 @@ endpoints to the server.
476462
.TP
477463
\f[I]-P \f[R]
478464
Specifies the port number of the peer endpoint, overriding the default.
479-
.TP
480465
*-s
481-
Specifies the address of the local endpoint.
466+
.IP \[bu] 2
467+
: Specifies the address of the local endpoint.
482468
.TP
483469
*-F
484470
Specifies the address format.

‎man/man1/fi_info.1‎

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.3
1+
.\" Automatically generated by Pandoc 2.9.2.1
22
.\"
3-
.\" Define V font for inline verbatim, using C font in formats
4-
.\" that render this, and otherwise B font.
5-
.ie "\f[CB]x\f[]"x" \{\
6-
. ftr V B
7-
. ftr VI BI
8-
. ftr VB B
9-
. ftr VBI BI
10-
.\}
11-
.el \{\
12-
. ftr V CR
13-
. ftr VI CI
14-
. ftr VB CB
15-
. ftr VBI CBI
16-
.\}
17-
.TH "fi_info" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
3+
.TH "fi_info" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
184
.hy
195
.SH NAME
206
.PP
@@ -70,7 +56,7 @@ For more information on address formats, see fi_getinfo(3).
7056
.TP
7157
\f[I]-p, \[en]provider=<PROV>\f[R]
7258
Filter fabric interfaces by the provider implementation.
73-
For a list of providers, see the \f[V]--list\f[R] option.
59+
For a list of providers, see the \f[C]--list\f[R] option.
7460
.TP
7561
\f[I]-d, \[en]domain=<DOMAIN>\f[R]
7662
Filter interfaces to only those with the given domain name.
@@ -144,7 +130,7 @@ provider: tcp
144130
\f[R]
145131
.fi
146132
.PP
147-
To see the full fi_info structure, specify the \f[V]-v\f[R] option.
133+
To see the full fi_info structure, specify the \f[C]-v\f[R] option.
148134
.IP
149135
.nf
150136
\f[C]
@@ -237,7 +223,7 @@ fi_info:
237223
\f[R]
238224
.fi
239225
.PP
240-
To see libfabric related environment variables \f[V]-e\f[R] option.
226+
To see libfabric related environment variables \f[C]-e\f[R] option.
241227
.IP
242228
.nf
243229
\f[C]
@@ -257,7 +243,7 @@ $ ./fi_info -e
257243
.fi
258244
.PP
259245
To see libfabric related environment variables with substring use
260-
\f[V]-g\f[R] option.
246+
\f[C]-g\f[R] option.
261247
.IP
262248
.nf
263249
\f[C]
@@ -295,6 +281,6 @@ $ ./fi_info -g tcp
295281
.fi
296282
.SH SEE ALSO
297283
.PP
298-
\f[V]fi_getinfo(3)\f[R], \f[V]fi_endpoint(3)\f[R]
284+
\f[C]fi_getinfo(3)\f[R], \f[C]fi_endpoint(3)\f[R]
299285
.SH AUTHORS
300286
OpenFabrics.

‎man/man1/fi_pingpong.1‎

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.3
1+
.\" Automatically generated by Pandoc 2.9.2.1
22
.\"
3-
.\" Define V font for inline verbatim, using C font in formats
4-
.\" that render this, and otherwise B font.
5-
.ie "\f[CB]x\f[]"x" \{\
6-
. ftr V B
7-
. ftr VI BI
8-
. ftr VB B
9-
. ftr VBI BI
10-
.\}
11-
.el \{\
12-
. ftr V CR
13-
. ftr VI CI
14-
. ftr VB CB
15-
. ftr VBI CBI
16-
.\}
17-
.TH "fi_pingpong" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
3+
.TH "fi_pingpong" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
184
.hy
195
.SH NAME
206
.PP
@@ -35,7 +21,7 @@ fi_pingpong also displays aggregated statistics after each test run, and
3521
can additionally verify data integrity upon receipt.
3622
.PP
3723
By default, the datagram (FI_EP_DGRAM) endpoint is used for the test,
38-
unless otherwise specified via \f[V]-e\f[R].
24+
unless otherwise specified via \f[C]-e\f[R].
3925
.SH HOW TO RUN TESTS
4026
.PP
4127
Two copies of the program must be launched: first, one copy must be
@@ -61,15 +47,15 @@ client$ fi_pingpong <server address>
6147
.PP
6248
The server and client must be able to communicate properly for the
6349
fi_pingpong utility to function.
64-
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]
50+
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]
6551
options are used, then they must be specified on the invocation for both
6652
the server and the client process.
67-
If the \f[V]-d\f[R] option is specified on the server, then the client
53+
If the \f[C]-d\f[R] option is specified on the server, then the client
6854
will select the appropriate domain if no hint is provided on the client
6955
side.
70-
If the \f[V]-d\f[R] option is specified on the client, then it must also
56+
If the \f[C]-d\f[R] option is specified on the client, then it must also
7157
be specified on the server.
72-
If both the server and client specify the \f[V]-d\f[R] option and the
58+
If both the server and client specify the \f[C]-d\f[R] option and the
7359
given domains cannot communicate, then the application will fail.
7460
.SS Control Messaging
7561
.TP
@@ -124,19 +110,19 @@ Activate output debugging (warning: highly verbose)
124110
Displays help output for the pingpong test.
125111
.SH USAGE EXAMPLES
126112
.SS A simple example
127-
.SS Server: \f[V]fi_pingpong -p <provider_name>\f[R]
113+
.SS Server: \f[C]fi_pingpong -p <provider_name>\f[R]
128114
.PP
129-
\f[V]server$ fi_pingpong -p sockets\f[R]
130-
.SS Client: \f[V]fi_pingpong -p <provider_name> <server_addr>\f[R]
115+
\f[C]server$ fi_pingpong -p sockets\f[R]
116+
.SS Client: \f[C]fi_pingpong -p <provider_name> <server_addr>\f[R]
131117
.PP
132-
\f[V]client$ fi_pingpong -p sockets 192.168.0.123\f[R]
118+
\f[C]client$ fi_pingpong -p sockets 192.168.0.123\f[R]
133119
.SS An example with various options
134120
.SS Server:
135121
.PP
136-
\f[V]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R]
122+
\f[C]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R]
137123
.SS Client:
138124
.PP
139-
\f[V]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R]
125+
\f[C]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R]
140126
.PP
141127
Specifically, this will run a pingpong test with:
142128
.IP \[bu] 2
@@ -150,14 +136,14 @@ server node as 192.168.0.123
150136
.SS A longer test
151137
.SS Server:
152138
.PP
153-
\f[V]server$ fi_pingpong -p usnic -I 10000 -S all\f[R]
139+
\f[C]server$ fi_pingpong -p usnic -I 10000 -S all\f[R]
154140
.SS Client:
155141
.PP
156-
\f[V]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R]
142+
\f[C]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R]
157143
.SH DEFAULTS
158144
.PP
159145
There is no default provider; if a provider is not specified via the
160-
\f[V]-p\f[R] switch, the test will pick one from the list of available
146+
\f[C]-p\f[R] switch, the test will pick one from the list of available
161147
providers (as returned by fi_getinfo(3)).
162148
.PP
163149
If no endpoint type is specified, `dgram' is used.
@@ -192,6 +178,6 @@ client
192178
per second
193179
.SH SEE ALSO
194180
.PP
195-
\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3) \f[V]fabric\f[R](7),
181+
\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3) \f[C]fabric\f[R](7),
196182
.SH AUTHORS
197183
OpenFabrics.

‎man/man1/fi_strerror.1‎

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.3
1+
.\" Automatically generated by Pandoc 2.9.2.1
22
.\"
3-
.\" Define V font for inline verbatim, using C font in formats
4-
.\" that render this, and otherwise B font.
5-
.ie "\f[CB]x\f[]"x" \{\
6-
. ftr V B
7-
. ftr VI BI
8-
. ftr VB B
9-
. ftr VBI BI
10-
.\}
11-
.el \{\
12-
. ftr V CR
13-
. ftr VI CI
14-
. ftr VB CB
15-
. ftr VBI CBI
16-
.\}
17-
.TH "fi_strerror" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
3+
.TH "fi_strerror" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
184
.hy
195
.SH NAME
206
.PP
@@ -28,16 +14,16 @@ fi_strerror FI_ERROR_CODE
2814
.fi
2915
.SH DESCRIPTION
3016
.PP
31-
Display the error string for the given numeric \f[V]FI_ERROR_CODE\f[R].
32-
\f[V]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal
17+
Display the error string for the given numeric \f[C]FI_ERROR_CODE\f[R].
18+
\f[C]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal
3319
constant.
34-
Although the \f[V]fi_strerror\f[R](3) library function only accepts
20+
Although the \f[C]fi_strerror\f[R](3) library function only accepts
3521
positive error values, for convenience this utility accepts both
3622
positive and negative error values.
3723
.PP
3824
This is primarily a convenience tool for developers.
3925
.SH SEE ALSO
4026
.PP
41-
\f[V]fabric\f[R](7) \f[V]fi_errno\f[R](3)
27+
\f[C]fabric\f[R](7) \f[C]fi_errno\f[R](3)
4228
.SH AUTHORS
4329
OpenFabrics.

‎man/man3/fi_atomic.3‎

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.1.3
1+
.\" Automatically generated by Pandoc 2.9.2.1
22
.\"
3-
.\" Define V font for inline verbatim, using C font in formats
4-
.\" that render this, and otherwise B font.
5-
.ie "\f[CB]x\f[]"x" \{\
6-
. ftr V B
7-
. ftr VI BI
8-
. ftr VB B
9-
. ftr VBI BI
10-
.\}
11-
.el \{\
12-
. ftr V CR
13-
. ftr VI CI
14-
. ftr VB CB
15-
. ftr VBI CBI
16-
.\}
17-
.TH "fi_atomic" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
3+
.TH "fi_atomic" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
184
.hy
195
.SH NAME
206
.PP
@@ -143,7 +129,7 @@ Local data buffer to store initial value of remote buffer
143129
\f[I]desc / compare_desc / result_desc\f[R]
144130
Data descriptor associated with the local data buffer, local compare
145131
buffer, and local result buffer, respectively.
146-
See \f[V]fi_mr\f[R](3).
132+
See \f[C]fi_mr\f[R](3).
147133
.TP
148134
\f[I]dest_addr\f[R]
149135
Destination address for connectionless atomic operations.
@@ -707,11 +693,11 @@ parameter specifying the tag.
707693
.PP
708694
Returns 0 on success.
709695
On error, a negative value corresponding to fabric errno is returned.
710-
Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R].
696+
Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R].
711697
.SH ERRORS
712698
.TP
713699
\f[I]-FI_EAGAIN\f[R]
714-
See \f[V]fi_msg\f[R](3) for a detailed description of handling
700+
See \f[C]fi_msg\f[R](3) for a detailed description of handling
715701
FI_EAGAIN.
716702
.TP
717703
\f[I]-FI_EOPNOTSUPP\f[R]
@@ -755,11 +741,11 @@ assigned to the transmitting and receiving endpoints.
755741
Both message and data ordering are required if the results of two atomic
756742
operations to the same memory buffers are to reflect the second
757743
operation acting on the results of the first.
758-
See \f[V]fi_endpoint\f[R](3) for further details and message size
744+
See \f[C]fi_endpoint\f[R](3) for further details and message size
759745
restrictions.
760746
.SH SEE ALSO
761747
.PP
762-
\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3),
763-
\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3), \f[V]fi_rma\f[R](3)
748+
\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3),
749+
\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3), \f[C]fi_rma\f[R](3)
764750
.SH AUTHORS
765751
OpenFabrics.

0 commit comments

Comments
 (0)