Return to index.rst CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / iperf / docs

Annotation of embedaddon/iperf/docs/index.rst, revision 1.1.1.3

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: 
1.1.1.2   misho       9: The iperf series of tools perform active measurements to determine the
                     10: maximum achievable bandwidth on IP networks.  It supports tuning of
                     11: various parameters related to timing, protocols, and buffers.  For
                     12: each test it reports the measured throughput, loss, and other
                     13: parameters.
1.1       misho      14: 
                     15: This version, sometimes referred to as iperf3, is a redesign of an
                     16: original version developed at NLANR / DAST.  iperf3 is a new
                     17: implementation from scratch, with the goal of a smaller, simpler code
                     18: base, and a library version of the functionality that can be used in
                     19: other programs. iperf3 also incorporates a number of features found in
                     20: other tools such as nuttcp and netperf, but were missing from the
                     21: original iperf.  These include, for example, a zero-copy mode and
                     22: optional JSON output.  Note that iperf3 is *not* backwards compatible
                     23: with the original iperf.
                     24: 
1.1.1.2   misho      25: Primary development for iperf3 takes place on CentOS Linux, FreeBSD,
                     26: and macOS.  At this time, these are the only officially
1.1       misho      27: supported platforms, however there have been some reports of success
                     28: with OpenBSD, Android, and other Linux distributions.
                     29: 
                     30: iperf3 is principally developed by `ESnet <http://www.es.net/>`_ /
                     31: `Lawrence Berkeley National Laboratory <http://www.lbl.gov/>`_.  It
                     32: is released under a three-clause BSD license.
                     33: 
1.1.1.2   misho      34: iperf2 is no longer being developed by its original maintainers.
                     35: However, beginning in 2014, another developer began fixing bugs and
                     36: enhancing functionality, and generating releases of iperf2.  Both
                     37: projects (as of late 2017) are currently being developed actively, but
                     38: independently.  More information can be found in the :ref:`faq`.
                     39: 
1.1       misho      40: Links for the Impatient
                     41: -----------------------
                     42: 
                     43: Project homepage and documentation hosted on GitHub Pages:
1.1.1.2   misho      44: https://software.es.net/iperf/
1.1       misho      45: 
                     46: Project site (source code repository, issue tracker) hosted on GitHub:
                     47: https://github.com/esnet/iperf
                     48: 
                     49: Source code downloads:
1.1.1.2   misho      50: https://downloads.es.net/pub/iperf/
1.1       misho      51: 
                     52: Contents
                     53: --------
                     54: 
                     55: .. toctree::
                     56:    :maxdepth: 2
                     57: 
                     58:    news
                     59:    obtaining
                     60:    building
                     61:    invoking
                     62:    dev
1.1.1.2   misho      63:    faq
1.1       misho      64: 
                     65: Indices and tables
                     66: ------------------
                     67: 
                     68: * :ref:`genindex`
                     69: * :ref:`modindex`
                     70: * :ref:`search`