docs: Update for iperf-3.10 manpage.

docs/invoking.rst

@@ -136,6 +136,10 @@ the executable.
                  pause n seconds between periodic throughput reports; default  is
                  1, use 0 to disable
    
+          -I, --pidfile file
+                 write  a file with the process ID, most useful when running as a
+                 daemon.
+   
           -F, --file name
                  Use a file as the  source  (on  the  sender)  or  sink  (on  the
                  receiver)  of  data,  rather than just generating random data or
@@ -156,9 +160,10 @@ the executable.
                  potentialy multiple CPUs).
    
           -B, --bind host
-                 bind to the specific interface associated with address host.  If
+                 bind  to  the  specific  interface associated with address host.
-                 the  host  has multiple interfaces, it will use the first inter-
+                 --bind-dev dev.ft R bind to  the  specified  network  interface.
-                 face by default.
+                 This  option  uses SO_BINDTODEVICE, and may require root permis-
+                 sions.  (Available on Linux and possibly other systems.)
    
           -V, --verbose
                  give more detailed output
@@ -173,6 +178,19 @@ the executable.
                  force flushing output at every interval.  Used to avoid  buffer-
                  ing when sending output to pipe.
    
+          --timestamps[=format]
+                 prepend  a  timestamp  at  the  start  of  each output line.  By
+                 default,  timestamps  have  the  format  emitted  by   ctime(1).
+                 Optionally,  =  followed by a format specification can be passed
+                 to customize the timestamps, see strftime(3).  If this  optional
+                 format  is given, the = must immediately follow the --timestamps
+                 option with no whitespace intervening.
+   
+          --rcv-timeout #
+                 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).
+   
           -d, --debug
                  emit debugging output.  Primarily (perhaps exclusively)  of  use
                  to developers.
@@ -191,13 +209,19 @@ the executable.
           -D, --daemon
                  run the server in background as a daemon
    
-          -I, --pidfile file
-                 write a file with the process ID, most useful when running as  a
-                 daemon.
-   
           -1, --one-off
                  handle one client connection, then exit.
    
+          --server-bitrate-limit n[KMGT]
+                 set a limit on the server side, which will cause a test to abort
+                 if the client specifies a test of more than n bits  per  second,
+                 or if the average data sent or received by the client (including
+                 all data streams) is  greater  than  n  bits  per  second.   The
+                 default  limit  is  zero,  which implies no limit.  The interval
+                 over which to average the data rate is 5 seconds by default, but
+                 can  be  specified  by  adding a '/' and a number to the bitrate
+                 specifier.
+   
           --rsa-private-key-path file
                  path to the RSA private key  (not  password-protected)  used  to
                  decrypt  authentication  credentials  from  the client (if built
@@ -210,7 +234,7 @@ the executable.
                  hashes;  more  information  on  the structure of the file can be
                  found in the EXAMPLES section.
    
-          --time-skew-threshold seconds
+          --time-skew-thresholdsecond seconds
                  time skew threshold (in seconds) between the server  and  client
                  during the authentication process.
    
@@ -232,7 +256,7 @@ the executable.
                  viding a shorter value may speed up detection of a  down  iperf3
                  server.
    
-          -b, --bitrate n[KM]
+          -b, --bitrate n[KMGT]
                  set  target  bitrate  to n bits/sec (default 1 Mbit/sec for UDP,
                  unlimited for TCP/SCTP).  If  there  are  multiple  streams  (-P
                  flag),  the  throughput  limit  is  applied  separately  to each
@@ -246,7 +270,7 @@ the executable.
                  the  --fq-rate flag.  This option replaces the --bandwidth flag,
                  which is now deprecated but (at least for now) still accepted.
    
-          --pacing-timer n[KMG]
+          --pacing-timer n[KMGT]
                  set  pacing  timer  interval  in  microseconds   (default   1000
                  microseconds,  or 1 ms).  This controls iperf3's internal pacing
                  timer for the -b/--bitrate  option.   The  timer  fires  at  the
@@ -255,7 +279,7 @@ the executable.
                  potentially  at  the  cost  of  performance due to more frequent
                  timer processing.
    
-          --fq-rate n[KM]
+          --fq-rate n[KMGT]
                  Set a rate to be used with fair-queueing based socket-level pac-
                  ing,  in bits per second.  This pacing (if specified) will be in
                  addition to any pacing due to iperf3's internal throughput  pac-
@@ -271,13 +295,13 @@ the executable.
           -t, --time n
                  time in seconds to transmit for (default 10 secs)
    
-          -n, --bytes n[KM]
+          -n, --bytes n[KMGT]
                  number of bytes to transmit (instead of -t)
    
-          -k, --blockcount n[KM]
+          -k, --blockcount n[KMGT]
                  number of blocks (packets) to transmit (instead of -t or -n)
    
-          -l, --length n[KM]
+          -l, --length n[KMGT]
                  length  of  buffer to read or write.  For TCP tests, the default
                  value is 128KB.  In the case of UDP, iperf3 tries to dynamically
                  determine  a  reasonable  sending size based on the path MTU; if
@@ -298,9 +322,10 @@ the executable.
                  to the client
    
           --bidir
-                 bidirectional mode, server and client send and receive data.
+                 test  in  both  directions  (normal  and reverse), with both the
+                 client and server sending and receiving data simultaneously
    
-          -w, --window n[KM]
+          -w, --window n[KMGT]
                  window size / socket buffer size (this gets sent to  the  server
                  and used on that side too)
    
@@ -373,6 +398,13 @@ the executable.
                  --json, the server output is included in a JSON  object;  other-
                  wise  it is appended at the bottom of the human-readable output.
    
+          --udp-counters-64bit
+                 Use 64-bit counters in UDP test packets.  The use of this option
+                 can  help  prevent counter overflows during long or high-bitrate
+                 UDP tests.  Both client and server need to be running  at  least
+                 version  3.1 for this option to work.  It may become the default
+                 behavior at some point in the future.
+   
           --repeating-payload
                  Use repeating pattern in payload, instead of random bytes.   The
                  same  payload  is  used  in iperf2 (ASCII '0..9' repeating).  It
@@ -381,6 +413,10 @@ the executable.
                  iperf2 and iperf3 perform differently,  just  based  on  payload
                  entropy.
    
+          --dont-fragment
+                 Set  the IPv4 Don't Fragment (DF) bit on outgoing packets.  Only
+                 applicable to tests doing UDP over IPv4.
+   
           --username username
                  username to use for authentication to the iperf server (if built
                  with OpenSSL support).  The password will be prompted for inter-
@@ -399,8 +435,11 @@ the executable.
           The authentication feature of iperf3 requires an  RSA  public  keypair.
           The  public  key is used to encrypt the authentication token containing
           the user credentials, while the private key  is  used  to  decrypt  the
-          authentication token.  An example of a set of  UNIX/Linux  commands  to
+          authentication  token.  The private key must be in PEM format and addi-
-          generate correct keypair follows:
+          tionally must not have a password set.  The public key must be  in  PEM
+          format  and  use SubjectPrefixKeyInfo encoding.  An example of a set of
+          UNIX/Linux commands using OpenSSL to generate a  correctly-formed  key-
+          pair follows:
    
                > openssl genrsa -des3 -out private.pem 2048
                > openssl rsa -in private.pem -outform PEM -pubout -out public.pem
@@ -441,7 +480,8 @@ the executable.
    
    
    
-   ESnet                              June 2018                         IPERF3(1)
+   ESnet                            February 2021
+   IPERF3(1)
 
 The iperf3 manual page will typically be installed in manual
 section 1.