1*7ab6e6acSAndroid Build Coastguard Worker.. iperf documentation master file, created by 2*7ab6e6acSAndroid Build Coastguard Worker sphinx-quickstart on Fri Mar 28 14:58:40 2014. 3*7ab6e6acSAndroid Build Coastguard Worker You can adapt this file completely to your liking, but it should at least 4*7ab6e6acSAndroid Build Coastguard Worker contain the root `toctree` directive. 5*7ab6e6acSAndroid Build Coastguard Worker 6*7ab6e6acSAndroid Build Coastguard Workeriperf3 7*7ab6e6acSAndroid Build Coastguard Worker====== 8*7ab6e6acSAndroid Build Coastguard Worker 9*7ab6e6acSAndroid Build Coastguard WorkerThe iperf series of tools perform active measurements to determine the 10*7ab6e6acSAndroid Build Coastguard Workermaximum achievable bandwidth on IP networks. It supports tuning of 11*7ab6e6acSAndroid Build Coastguard Workervarious parameters related to timing, protocols, and buffers. For 12*7ab6e6acSAndroid Build Coastguard Workereach test it reports the measured throughput, loss, and other 13*7ab6e6acSAndroid Build Coastguard Workerparameters. 14*7ab6e6acSAndroid Build Coastguard Worker 15*7ab6e6acSAndroid Build Coastguard WorkerThis version, sometimes referred to as iperf3, is a redesign of an 16*7ab6e6acSAndroid Build Coastguard Workeroriginal version developed at NLANR / DAST. iperf3 is a new 17*7ab6e6acSAndroid Build Coastguard Workerimplementation from scratch, with the goal of a smaller, simpler code 18*7ab6e6acSAndroid Build Coastguard Workerbase, and a library version of the functionality that can be used in 19*7ab6e6acSAndroid Build Coastguard Workerother programs. iperf3 also incorporates a number of features found in 20*7ab6e6acSAndroid Build Coastguard Workerother tools such as nuttcp and netperf, but were missing from the 21*7ab6e6acSAndroid Build Coastguard Workeroriginal iperf. These include, for example, a zero-copy mode and 22*7ab6e6acSAndroid Build Coastguard Workeroptional JSON output. Note that iperf3 is *not* backwards compatible 23*7ab6e6acSAndroid Build Coastguard Workerwith the original iperf. 24*7ab6e6acSAndroid Build Coastguard Worker 25*7ab6e6acSAndroid Build Coastguard WorkerPrimary development for iperf3 takes place on CentOS Linux, FreeBSD, 26*7ab6e6acSAndroid Build Coastguard Workerand macOS. At this time, these are the only officially 27*7ab6e6acSAndroid Build Coastguard Workersupported platforms, however there have been some reports of success 28*7ab6e6acSAndroid Build Coastguard Workerwith OpenBSD, Android, and other Linux distributions. 29*7ab6e6acSAndroid Build Coastguard Worker 30*7ab6e6acSAndroid Build Coastguard Workeriperf3 is principally developed by `ESnet <http://www.es.net/>`_ / 31*7ab6e6acSAndroid Build Coastguard Worker`Lawrence Berkeley National Laboratory <http://www.lbl.gov/>`_. It 32*7ab6e6acSAndroid Build Coastguard Workeris released under a three-clause BSD license. 33*7ab6e6acSAndroid Build Coastguard Worker 34*7ab6e6acSAndroid Build Coastguard Workeriperf2 is no longer being developed by its original maintainers. 35*7ab6e6acSAndroid Build Coastguard WorkerHowever, beginning in 2014, another developer began fixing bugs and 36*7ab6e6acSAndroid Build Coastguard Workerenhancing functionality, and generating releases of iperf2. Both 37*7ab6e6acSAndroid Build Coastguard Workerprojects (as of late 2017) are currently being developed actively, but 38*7ab6e6acSAndroid Build Coastguard Workerindependently. More information can be found in the :ref:`faq`. 39*7ab6e6acSAndroid Build Coastguard Worker 40*7ab6e6acSAndroid Build Coastguard WorkerLinks for the Impatient 41*7ab6e6acSAndroid Build Coastguard Worker----------------------- 42*7ab6e6acSAndroid Build Coastguard Worker 43*7ab6e6acSAndroid Build Coastguard WorkerProject homepage and documentation hosted on GitHub Pages: 44*7ab6e6acSAndroid Build Coastguard Workerhttps://software.es.net/iperf/ 45*7ab6e6acSAndroid Build Coastguard Worker 46*7ab6e6acSAndroid Build Coastguard WorkerProject site (source code repository, issue tracker) hosted on GitHub: 47*7ab6e6acSAndroid Build Coastguard Workerhttps://github.com/esnet/iperf 48*7ab6e6acSAndroid Build Coastguard Worker 49*7ab6e6acSAndroid Build Coastguard WorkerSource code downloads: 50*7ab6e6acSAndroid Build Coastguard Workerhttps://downloads.es.net/pub/iperf/ 51*7ab6e6acSAndroid Build Coastguard Worker 52*7ab6e6acSAndroid Build Coastguard WorkerContents 53*7ab6e6acSAndroid Build Coastguard Worker-------- 54*7ab6e6acSAndroid Build Coastguard Worker 55*7ab6e6acSAndroid Build Coastguard Worker.. toctree:: 56*7ab6e6acSAndroid Build Coastguard Worker :maxdepth: 2 57*7ab6e6acSAndroid Build Coastguard Worker 58*7ab6e6acSAndroid Build Coastguard Worker news 59*7ab6e6acSAndroid Build Coastguard Worker obtaining 60*7ab6e6acSAndroid Build Coastguard Worker building 61*7ab6e6acSAndroid Build Coastguard Worker invoking 62*7ab6e6acSAndroid Build Coastguard Worker dev 63*7ab6e6acSAndroid Build Coastguard Worker faq 64*7ab6e6acSAndroid Build Coastguard Worker 65*7ab6e6acSAndroid Build Coastguard WorkerIndices and tables 66*7ab6e6acSAndroid Build Coastguard Worker------------------ 67*7ab6e6acSAndroid Build Coastguard Worker 68*7ab6e6acSAndroid Build Coastguard Worker* :ref:`genindex` 69*7ab6e6acSAndroid Build Coastguard Worker* :ref:`modindex` 70*7ab6e6acSAndroid Build Coastguard Worker* :ref:`search` 71*7ab6e6acSAndroid Build Coastguard Worker 72