summaryrefslogtreecommitdiffstats
path: root/src/iperf3.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 03:27:01 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 03:27:01 +0000
commit6f4c2968d9a035183d937cb055aec739c05280b1 (patch)
tree3e3270402258677b8ceb7f0db4c68e2123371d97 /src/iperf3.1
parentAdding upstream version 3.16. (diff)
downloadiperf3-upstream.tar.xz
iperf3-upstream.zip
Adding upstream version 3.17.1.upstream/3.17.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/iperf3.1')
-rw-r--r--src/iperf3.120
1 files changed, 17 insertions, 3 deletions
diff --git a/src/iperf3.1 b/src/iperf3.1
index 344a762..f8eff48 100644
--- a/src/iperf3.1
+++ b/src/iperf3.1
@@ -1,4 +1,4 @@
-.TH IPERF3 1 "November 2023" ESnet "User Manuals"
+.TH IPERF3 1 "May 2024" ESnet "User Manuals"
.SH NAME
iperf3 \- perform network throughput tests
.SH SYNOPSIS
@@ -96,9 +96,11 @@ test by specifying the --get-server-output flag.
Either the client or the server can produce its output in a JSON
structure, useful for integration with other programs, by passing it
the -J flag.
-Because the contents of the JSON structure are only completely known
+Normally the contents of the JSON structure are only competely known
after the test has finished, no JSON output will be emitted until the
end of the test.
+By enabling line-delimited JSON multiple objects will be emitted to
+provide a real-time parsable JSON output.
.PP
iperf3 has a (overly) large set of command-line options that can be
used to set the parameters of a test.
@@ -157,6 +159,9 @@ give more detailed output
.BR -J ", " --json " "
output in JSON format
.TP
+.BR --json-stream " "
+output in line-delimited JSON format
+.TP
.BR --logfile " \fIfile\fR"
send output to a log file.
.TP
@@ -178,7 +183,7 @@ follow the \fB--timestamps\fR option with no whitespace intervening.
.BR --rcv-timeout " \fI#\fR"
set idle timeout for receiving data during active tests. The receiver
will halt a test if no data is received from the sender for this
-number of ms (default to 12000 ms, or 2 minutes).
+number of ms (default to 120000 ms, or 2 minutes).
.TP
.BR --snd-timeout " \fI#\fR"
set timeout for unacknowledged TCP data (on both test and control
@@ -188,6 +193,15 @@ parameter is specified in ms, and defaults to the system settings.
This functionality depends on the TCP_USER_TIMEOUT socket option, and
will not work on systems that do not support it.
.TP
+.BR --use-pkcs1-padding
+This option is only meaningful when using iperf3's authentication
+features. Versions of iperf3 prior to 3.17 used PCKS1 padding in the
+RSA-encrypted credentials, which was vulnerable to a side-channel
+attack that could reveal a server's private key. Beginning with
+iperf-3.17, OAEP padding is used, however this is a breaking change
+that is not compatible with older iperf3 versions. Use this option to
+preserve the less secure, but more compatible, behavior.
+.TP
.BR -d ", " --debug " "
emit debugging output.
Primarily (perhaps exclusively) of use to developers.