Return to tcpbench.1 CVS log

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

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

1.3     ! henning     1: .\" $OpenBSD: tcpbench.1,v 1.2 2008/05/09 09:01:23 jmc Exp $
1.1       djm         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: .\"
1.2       jmc        17: .Dd $Mdocdate: May 9 2008 $
1.1       djm        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
1.2       jmc        28: .Op Fl B Ar buf
1.1       djm        29: .Op Fl k Ar kvars
1.3     ! henning    30: .Op Fl n Ar connections
1.1       djm        31: .Op Fl p Ar port
                     32: .Op Fl r Ar rate
                     33: .Op Fl S Ar space
                     34: .Ar hostname
                     35: .Nm
                     36: .Fl s
                     37: .Op Fl v
1.2       jmc        38: .Op Fl B Ar buf
1.1       djm        39: .Op Fl k Ar kvars
                     40: .Op Fl p Ar port
                     41: .Op Fl r Ar rate
                     42: .Op Fl S Ar space
                     43: .Sh DESCRIPTION
                     44: .Nm
                     45: is a small tool that performs throughput benchmarking and concurrent
                     46: sampling of kernel network variables.
                     47: .Pp
                     48: .Nm
                     49: is run as a client/server pair.
                     50: The server must be invoked with the
                     51: .Fl s
                     52: flag, which will cause it to listen for incoming connections.
                     53: The client must be invoked with the
                     54: .Ar hostname
                     55: of a listening server to connect to.
                     56: .Pp
                     57: Once connected, the client will send TCP traffic as fast as possible to
                     58: the server.
                     59: Both the client and server will periodically display throughput
                     60: statistics along with any kernel variables the user has selected to
                     61: sample (using the
                     62: .Fl k
                     63: option).
                     64: A list of available kernel variables may be obtained using the
                     65: .Fl l
                     66: option.
                     67: .Pp
                     68: The options are as follows:
                     69: .Bl -tag -width Ds
1.2       jmc        70: .It Fl B Ar buf
1.1       djm        71: Specify the size of the internal write buffer used by
                     72: .Nm .
                     73: .It Fl k Ar kvars
1.2       jmc        74: Specify one or more kernel variables to monitor; multiple variables must be
1.1       djm        75: separated with commas.
                     76: The default is not to monitor any variables.
1.2       jmc        77: .It Fl l
                     78: List the name of kernel variables available for monitoring and exit.
1.3     ! henning    79: .It Fl n Ar connections
        !            80: Use given number of tcp connections (default: 1).
1.1       djm        81: .It Fl p Ar port
                     82: Specify the port used for the TCP test stream (default: 12345).
1.2       jmc        83: .It Fl r Ar rate
                     84: Specify the statistics reporting rate in milliseconds (default: 1000).
                     85: .It Fl S Ar space
                     86: Set the size of the socket buffer used for the TCP test stream.
                     87: On the client this option will resize the send buffer;
                     88: on the server it will resize the receive buffer.
1.1       djm        89: .It Fl s
                     90: Place
                     91: .Nm
                     92: in server mode, where it will listen on all interfaces for incoming
                     93: connections.
                     94: .It Fl v
                     95: Display verbose output.
                     96: If specified more than once, increase the detail of information displayed.
                     97: .El
                     98: .Sh SEE ALSO
1.2       jmc        99: .Xr netstat 1 ,
1.1       djm       100: .Xr pstat 8