summaryrefslogtreecommitdiffstats
path: root/docs/building.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/building.rst')
-rw-r--r--docs/building.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/building.rst b/docs/building.rst
new file mode 100644
index 0000000..9494d00
--- /dev/null
+++ b/docs/building.rst
@@ -0,0 +1,26 @@
+Building iperf3
+===============
+
+Building iperf3, as with most tools of this type, is a fairly
+straightforward operation. The instructions in this section assume
+that the source distribution has already been unpacked.
+
+Prerequisites
+-------------
+
+iperf3 requires few (if any) dependencies on common operating
+systems. The only known prerequisites are listed here.
+
+Building
+--------
+
+In many cases, iperf3 can be built and installed as follows:
+
+``./configure && make && make install``
+
+In some cases, configuration might fail. If this happens, it might
+help to run ``./bootstrap.sh`` first from the top-level directory.
+
+By default, the ``libiperf`` library is built in both shared and
+static forms. Either can be suppressed by using the
+``--disabled-shared`` or ``--disable-static`` configure-time options.