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