Return to tcpbench.1 CVS log

Up to [local] / src / usr.bin / tcpbench

Annotation of src/usr.bin/tcpbench/tcpbench.1, Revision 1.1.1.1

1.1       djm         1: .\" $OpenBSD$
                      2: .\"
                      3: .\" Copyright (c) 2008 Damien Miller <djm@mindrot.org>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
                     17: .Dd $Mdocdate$
                     18: .Os
                     19: .Dt TCPBENCH 1
                     20: .Sh NAME
                     21: .Nm tcpbench
                     22: .Nd TCP benchmarking and measurement tool
                     23: .Sh SYNOPSIS
                     24: .Nm
                     25: .Fl l
                     26: .Nm
                     27: .Op Fl v
                     28: .Op Fl k Ar kvars
                     29: .Op Fl p Ar port
                     30: .Op Fl r Ar rate
                     31: .Op Fl B Ar buf
                     32: .Op Fl S Ar space
                     33: .Ar hostname
                     34: .Nm
                     35: .Fl s
                     36: .Op Fl v
                     37: .Op Fl k Ar kvars
                     38: .Op Fl p Ar port
                     39: .Op Fl r Ar rate
                     40: .Op Fl B Ar buf
                     41: .Op Fl S Ar space
                     42: .Sh DESCRIPTION
                     43: .Nm
                     44: is a small tool that performs throughput benchmarking and concurrent
                     45: sampling of kernel network variables.
                     46: .Pp
                     47: .Nm
                     48: is run as a client/server pair.
                     49: The server must be invoked with the
                     50: .Fl s
                     51: flag, which will cause it to listen for incoming connections.
                     52: The client must be invoked with the
                     53: .Ar hostname
                     54: of a listening server to connect to.
                     55: .Pp
                     56: Once connected, the client will send TCP traffic as fast as possible to
                     57: the server.
                     58: Both the client and server will periodically display throughput
                     59: statistics along with any kernel variables the user has selected to
                     60: sample (using the
                     61: .Fl k
                     62: option).
                     63: A list of available kernel variables may be obtained using the
                     64: .Fl l
                     65: option.
                     66: .Pp
                     67: The options are as follows:
                     68: .Bl -tag -width Ds
                     69: .It Fl B
                     70: Specify the size of the internal write buffer used by
                     71: .Nm .
                     72: .It Fl l
                     73: List the name of kernel variables available for monitoring and exit.
                     74: .It Fl k Ar kvars
                     75: Specify one or more kernel variables to monitor; multiple variables must be
                     76: separated with commas.
                     77: The default is not to monitor any variables.
                     78: .It Fl p Ar port
                     79: Specify the port used for the TCP test stream (default: 12345).
                     80: .It Fl s
                     81: Place
                     82: .Nm
                     83: in server mode, where it will listen on all interfaces for incoming
                     84: connections.
                     85: .It Fl r Ar rate
                     86: Specify the statistics reporting rate in milliseconds (default: 1000).
                     87: .It Fl S Ar space
                     88: Set the size of the socket buffer used for the TCP test stream.
                     89: On the client this option will resize the send buffer, on the server
                     90: it will resize the receive buffer.
                     91: .It Fl v
                     92: Display verbose output.
                     93: If specified more than once, increase the detail of information displayed.
                     94: .El
                     95: .Sh SEE ALSO
                     96: .Xr netstat 1
                     97: .Xr pstat 8