aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Leschnik <jason@leschnik.me>2018-02-22 07:23:36 +1100
committerBruce A. Mah <bmah@kitchenlab.org>2018-02-21 12:23:36 -0800
commita6123ce7fb4dbbcda4adbd868c105e378e87fcf0 (patch)
tree7685e8c1d70152a8262ab14f44a5196ef62ebebb
parent2ac3da6698c85a0c2b23c5d5d3c0759d14d2818d (diff)
downloadiperf3-a6123ce7fb4dbbcda4adbd868c105e378e87fcf0.tar.gz
Change the wording on bind parameter documentation for clarity (#702)
-rw-r--r--docs/invoking.rst5
-rw-r--r--src/iperf3.14
-rw-r--r--src/iperf_locale.c2
3 files changed, 7 insertions, 4 deletions
diff --git a/docs/invoking.rst b/docs/invoking.rst
index fe73690..fdd58a8 100644
--- a/docs/invoking.rst
+++ b/docs/invoking.rst
@@ -156,8 +156,9 @@ the executable.
potentialy multiple CPUs).
-B, --bind host
- bind to a specific interface. If the host has multiple inter-
- faces, it will use the first interface by default.
+ bind to the specific interface associated with address <host>.
+ If the host has multiple interfaces, it will use the first
+ interface by default.
-V, --verbose
give more detailed output
diff --git a/src/iperf3.1 b/src/iperf3.1
index 037e037..176fa2c 100644
--- a/src/iperf3.1
+++ b/src/iperf3.1
@@ -138,7 +138,9 @@ to a single CPU (as opposed to a set containing potentialy multiple
CPUs).
.TP
.BR -B ", " --bind " \fIhost\fR"
-bind to a specific interface. If the host has multiple interfaces, it will use the first interface by default.
+bind to the specific interface associated with address \fIhost\fR.
+If the host has multiple interfaces, it will use the first interface
+by default.
.TP
.BR -V ", " --verbose " "
give more detailed output
diff --git a/src/iperf_locale.c b/src/iperf_locale.c
index 05f6df3..b0d8a96 100644
--- a/src/iperf_locale.c
+++ b/src/iperf_locale.c
@@ -104,7 +104,7 @@ const char usage_longstr[] = "Usage: iperf3 [-s|-c host] [options]\n"
#if defined(HAVE_CPU_AFFINITY)
" -A, --affinity n/n,m set CPU affinity\n"
#endif /* HAVE_CPU_AFFINITY */
- " -B, --bind <host> bind to a specific interface\n"
+ " -B, --bind <host> bind to the interface associated with the address <host>\n"
" -V, --verbose more detailed output\n"
" -J, --json output in JSON format\n"
" --logfile f send output to a log file\n"