| .TH IPERF 1 "July 2010" NLANR/DAST "User Manuals" |
| .SH NAME |
| iperf \- perform network throughput tests |
| .SH SYNOPSIS |
| .B iperf -s [ |
| .I options |
| .B ] |
| |
| .B iperf -c |
| .I server |
| .B [ |
| .I options |
| .B ] |
| |
| |
| .SH DESCRIPTION |
| iperf is a tool for performing network throughput measurements. It can test |
| either TCP or UDP throughput. To perform an iperf test the user must |
| establish both a server and a client. |
| |
| |
| .SH "GENERAL OPTIONS" |
| .TP |
| .BR -p ", " --port " \fIn\fR" |
| set server port to listen on/connect to to \fIn\fR (default 5201) |
| .TP |
| .BR -f ", " --format " " |
| [kmKM] format to report: Kbits, Mbits, KBytes, MBytes |
| .TP |
| .BR -i ", " --interval " \fIn\fR" |
| pause \fIn\fR seconds between periodic bandwidth reports |
| .TP |
| .BR -m ", " --print_mss " " |
| print TCP maximum segment size (MTU - TCP/IP header) |
| .TP |
| .BR -h ", " --help " " |
| print a help synopsis |
| .TP |
| .BR -v ", " --version " " |
| print version information and quit |
| |
| |
| .SH "SERVER SPECIFIC OPTIONS" |
| .TP |
| .BR -s ", " --server " " |
| run in server mode |
| |
| |
| .SH "CLIENT SPECIFIC OPTIONS" |
| .TP |
| .BR -c ", " --client " <host>" |
| run in client mode, connecting to <host> |
| .TP |
| .BR -u ", " --udp |
| use UDP rather than TCP |
| .TP |
| .BR -b ", " --bandwidth " \fIn\fR[KM]" |
| set target bandwidth to \fIn\fR bits/sec (default 1 Mbit/sec). Requires UDP mode (-u) |
| .TP |
| .BR -t ", " --time " \fIn\fR" |
| time in seconds to transmit for (default 10 secs) |
| .TP |
| .BR -n ", " --num " \fIn\fR[KM]" |
| number of bytes to transmit (instead of -t) |
| .TP |
| .BR -l ", " --len " \fIn\fR[KM]" |
| set length read/write buffer to \fIn\fR (default 128 KB) |
| .TP |
| .BR -P ", " --parallel " \fIn\fR" |
| number of parallel client streams to run |
| .TP |
| .BR -R ", " --reverse |
| run in reverse mode (server sends, client receives) |
| .TP |
| .BR -w ", " --window " \fIn\fR[KM]" |
| TCP window size (socket buffer size) |
| .TP |
| .BR -M ", " --mss " \fIn\fR" |
| set TCP maximum segment size (MTU - 40 bytes) |
| .TP |
| .BR -N ", " --nodelay " " |
| set TCP no delay, disabling Nagle's Algorithm |
| |
| |
| .SH DIAGNOSTICS |
| This section needs to be filled in. |
| |
| |
| .SH BUGS |
| Exit statuses are inconsistent. |
| Could possibly block indefinitely under some circumstances. |
| |
| |
| .SH AUTHORS |
| Iperf was originally written by Mark Gates and Alex Warshavsky. |
| Man page and maintence by Jon Dugan <jdugan at x1024 dot net>. |
| Other contributions from Ajay Tirumala, Jim Ferguson, |
| Feng Qin, |
| Kevin Gibbs, |
| John Estabrook <jestabro at ncsa.uiuc.edu>, |
| Andrew Gallatin <gallatin at gmail.com>, |
| Stephen Hemminger <shemminger at linux-foundation.org> |
| |
| |
| .SH "SEE ALSO" |
| http://code.google.com/p/iperf/ |
