xref: /dragonfly/usr.sbin/trpt/trpt.8 (revision 0bb9290e)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)trpt.8	8.2 (Berkeley) 12/11/93
33.\" $FreeBSD: src/usr.sbin/trpt/trpt.8,v 1.8.2.5 2003/03/11 22:31:34 trhodes Exp $
34.\" $DragonFly: src/usr.sbin/trpt/trpt.8,v 1.3 2006/02/17 19:40:28 swildner Exp $
35.\"
36.Dd December 11, 1993
37.Dt TRPT 8
38.Os
39.Sh NAME
40.Nm trpt
41.Nd transliterate protocol trace
42.Sh SYNOPSIS
43.Nm
44.Op Fl a
45.Op Fl f
46.Op Fl j
47.Op Fl p Ar hex-address
48.Op Fl s
49.Op Fl t
50.Oo
51.Ar system Op Ar core
52.Oc
53.Sh DESCRIPTION
54The
55.Nm
56utility interrogates the buffer of
57.Tn TCP
58trace records created
59when a socket is marked for
60.Dq debugging
61(see
62.Xr setsockopt 2 ) ,
63and prints a readable description of these records.
64When no options are supplied,
65.Nm
66prints all the trace records found in the system
67grouped according to
68.Tn TCP
69connection protocol control
70block
71.Pq Tn PCB .
72.Pp
73The following options may be used to
74alter this behavior:
75.Bl -tag -width indent
76.It Fl a
77In addition to the normal output,
78print the values of the source and destination
79addresses for each packet recorded.
80.It Fl f
81Follow the trace as it occurs, waiting a short time for additional records
82each time the end of the log is reached.
83.It Fl j
84Just give a list of the protocol control block
85addresses for which there are trace records.
86.It Fl p
87Show only trace records associated with the protocol
88control block at the given address
89.Ar hex-address .
90.It Fl s
91In addition to the normal output,
92print a detailed description of the packet
93sequencing information.
94.It Fl t
95In addition to the normal output,
96print the values for all timers at each
97point in the trace.
98.El
99.Pp
100The recommended use of
101.Nm
102is as follows.
103Isolate the problem and enable debugging on the
104socket(s) involved in the connection.
105Find the address of the protocol control blocks
106associated with the sockets using the
107.Fl A
108option to
109.Xr netstat 1 .
110Then run
111.Nm
112with the
113.Fl p
114option, supplying the associated
115protocol control block addresses.
116The
117.Fl f
118option can be used to follow the trace log once the trace is located.
119If there are
120many sockets using the debugging option, the
121.Fl j
122option may be useful in checking to see if
123any trace records are present for the socket in
124question.
125.Pp
126If debugging is being performed on a system or
127core file other than the default, the last two
128arguments may be used to supplant the defaults.
129.Sh FILES
130.Bl -tag -width /dev/kmem -compact
131.It Pa /kernel
132.It Pa /dev/kmem
133.El
134.Sh DIAGNOSTICS
135.Bl -diag
136.It no namelist
137When the system image doesn't
138contain the proper symbols to find the trace buffer;
139others which should be self explanatory.
140.El
141.Sh SEE ALSO
142.Xr netstat 1 ,
143.Xr setsockopt 2
144.Sh HISTORY
145The
146.Nm
147utility appeared in
148.Bx 4.2 .
149.Sh BUGS
150Should also print the data for each input or output,
151but this is not saved in the trace record.
152.Pp
153The output format is inscrutable and should be described
154here.
155