aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBruce A. Mah <bmah@es.net>2017-04-14 12:36:47 -0700
committerBruce A. Mah <bmah@es.net>2017-04-14 12:36:47 -0700
commitb07ed14dae4ce117c5cc7d455258283db4917f76 (patch)
treed83e332f59adba6cc34c7fbf73c05977294552bd /src
parent08758a16d226f47e772891d27e8cb19c3eed6c87 (diff)
downloadiperf3-b07ed14dae4ce117c5cc7d455258283db4917f76.tar.gz
Be more explicit about the direction of data during tests.
Documentation change only, no functional change. Fixes #384.
Diffstat (limited to 'src')
-rw-r--r--src/iperf3.19
1 files changed, 6 insertions, 3 deletions
diff --git a/src/iperf3.1 b/src/iperf3.1
index 7fc69ab..9d362a5 100644
--- a/src/iperf3.1
+++ b/src/iperf3.1
@@ -1,4 +1,4 @@
-.TH IPERF3 1 "May 2016" ESnet "User Manuals"
+.TH IPERF3 1 "April 2017" ESnet "User Manuals"
.SH NAME
iperf3 \- perform network throughput tests
.SH SYNOPSIS
@@ -89,7 +89,9 @@ handle one client connection, then exit.
.SH "CLIENT SPECIFIC OPTIONS"
.TP
.BR -c ", " --client " \fIhost\fR"
-run in client mode, connecting to the specified server
+run in client mode, connecting to the specified server.
+By default, a test consists of sending data from the client to the
+server, unless the \-R flag is specified.
.TP
.BR --sctp
use SCTP rather than TCP (FreeBSD and Linux)
@@ -150,7 +152,8 @@ default is to use an ephemeral port)
number of parallel client streams to run
.TP
.BR -R ", " --reverse
-run in reverse mode (server sends, client receives)
+reverse the direction of a test, so that the server sends data to the
+client
.TP
.BR -w ", " --window " \fIn\fR[KM]"
window size / socket buffer size (this gets sent to the server and used on that side too)