Skip to content

Commit

Permalink
Updated nroff-generated man pages
Browse files Browse the repository at this point in the history
Signed-off-by: OFIWG Bot <[email protected]>
  • Loading branch information
ofiwg-bot authored and github-actions[bot] committed Dec 17, 2023
1 parent 52be148 commit 1e5fb76
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 27 deletions.
15 changes: 7 additions & 8 deletions man/man1/fi_pingpong.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "fi_pingpong" "1" "2023\-06\-13" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.TH "fi_pingpong" "1" "2023\-12\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -72,8 +72,7 @@ The server ignores this option.
.SS Fabric Filtering
.TP
\f[I]-p <provider_name>\f[R]
The name of the underlying fabric provider (e.g., sockets, psm3, usnic,
etc.).
The name of the underlying fabric provider (e.g., sockets, psm3, etc.).
If a provider is not specified via the -p switch, the test will pick one
from the list of available providers (as returned by fi_getinfo(3)).
.TP
Expand Down Expand Up @@ -115,14 +114,14 @@ Displays help output for the pingpong test.
.SS An example with various options
.SS Server:
.PP
\f[C]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R]
\f[C]server$ fi_pingpong -p tcp -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[C]client$ fi_pingpong -p tcp -I 1000 -S 1024 192.168.0.123\f[R]
.PP
Specifically, this will run a pingpong test with:
.IP \[bu] 2
usNIC provider
tcp provider
.IP \[bu] 2
1000 iterations
.IP \[bu] 2
Expand All @@ -132,10 +131,10 @@ 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[C]server$ fi_pingpong -p tcp -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[C]client$ fi_pingpong -p tcp -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
Expand Down
5 changes: 1 addition & 4 deletions man/man3/fi_endpoint.3
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "fi_endpoint" "3" "2023\-11\-03" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.TH "fi_endpoint" "3" "2023\-12\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -761,9 +761,6 @@ the protocol value set to one.
Proprietary protocol on Elastic Fabric Adapter fabric.
It supports both DGRAM and RDM endpoints.
.TP
\f[I]FI_PROTO_GNI\f[R]
Protocol runs over Cray GNI low-level interface.
.TP
\f[I]FI_PROTO_IB_RDM\f[R]
Reliable-datagram protocol implemented over InfiniBand
reliable-connected queue pairs.
Expand Down
10 changes: 1 addition & 9 deletions man/man3/fi_getinfo.3
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "fi_getinfo" "3" "2023\-10\-31" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.TH "fi_getinfo" "3" "2023\-12\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -689,17 +689,9 @@ In some cases, a selected addressing format may need to be translated or
mapped into an address which is native to the fabric.
See \f[C]fi_av\f[R](3).
.TP
\f[I]FI_ADDR_BGQ\f[R]
Address is an IBM proprietary format that is used with their Blue Gene Q
systems.
.TP
\f[I]FI_ADDR_EFA\f[R]
Address is an Amazon Elastic Fabric Adapter (EFA) proprietary format.
.TP
\f[I]FI_ADDR_GNI\f[R]
Address is a Cray proprietary format that is used with their GNI
protocol.
.TP
\f[I]FI_ADDR_PSMX2\f[R]
Address is an Intel proprietary format used with their Performance
Scaled Messaging protocol version 2.
Expand Down
7 changes: 1 addition & 6 deletions man/man7/fi_provider.7
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "fi_provider" "7" "2023\-11\-18" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.TH "fi_provider" "7" "2023\-12\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -78,11 +78,6 @@ A provider for the Amazon EC2 Elastic Fabric Adapter
hardware interface for inter-instance communication on EC2.
See \f[C]fi_efa\f[R](7) for more information.
.TP
\f[I]GNI\f[R]
A provider for the Aries interconnect in Cray XC(TM) systems utilizing
the user-space \f[I]Generic Networking Interface\f[R].
See \f[C]fi_gni\f[R](7) for more information.
.TP
\f[I]OPX\f[R]
Supports Omni-Path networking from Cornelis Networks.
See \f[C]fi_opx\f[R](7) for more information.
Expand Down

0 comments on commit 1e5fb76

Please sign in to comment.