Annotation of embedaddon/iperf/docs/index.rst, revision 1.1
1.1 ! misho 1: .. iperf documentation master file, created by
! 2: sphinx-quickstart on Fri Mar 28 14:58:40 2014.
! 3: You can adapt this file completely to your liking, but it should at least
! 4: contain the root `toctree` directive.
! 5:
! 6: iperf3
! 7: ======
! 8:
! 9: iperf is a tool for active measurements of the maximum achievable
! 10: bandwidth on IP networks. It supports tuning of various parameters
! 11: related to timing, protocols, and buffers. For each test it reports
! 12: the bandwidth, loss, and other parameters.
! 13:
! 14: This version, sometimes referred to as iperf3, is a redesign of an
! 15: original version developed at NLANR / DAST. iperf3 is a new
! 16: implementation from scratch, with the goal of a smaller, simpler code
! 17: base, and a library version of the functionality that can be used in
! 18: other programs. iperf3 also incorporates a number of features found in
! 19: other tools such as nuttcp and netperf, but were missing from the
! 20: original iperf. These include, for example, a zero-copy mode and
! 21: optional JSON output. Note that iperf3 is *not* backwards compatible
! 22: with the original iperf.
! 23:
! 24: Primary development for iperf3 takes place on CentOS 6 Linux, FreeBSD
! 25: 10, and MacOS 10.10. At this time, these are the only officially
! 26: supported platforms, however there have been some reports of success
! 27: with OpenBSD, Android, and other Linux distributions.
! 28:
! 29: iperf3 is principally developed by `ESnet <http://www.es.net/>`_ /
! 30: `Lawrence Berkeley National Laboratory <http://www.lbl.gov/>`_. It
! 31: is released under a three-clause BSD license.
! 32:
! 33: Links for the Impatient
! 34: -----------------------
! 35:
! 36: Project homepage and documentation hosted on GitHub Pages:
! 37: http://software.es.net/iperf/
! 38:
! 39: Project site (source code repository, issue tracker) hosted on GitHub:
! 40: https://github.com/esnet/iperf
! 41:
! 42: Source code downloads:
! 43: http://downloads.es.net/pub/iperf/
! 44:
! 45: Contents
! 46: --------
! 47:
! 48: .. toctree::
! 49: :maxdepth: 2
! 50:
! 51: news
! 52: obtaining
! 53: building
! 54: invoking
! 55: dev
! 56:
! 57: Indices and tables
! 58: ------------------
! 59:
! 60: * :ref:`genindex`
! 61: * :ref:`modindex`
! 62: * :ref:`search`
! 63:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>