xref: /original-bsd/usr.sbin/trpt/trpt.8 (revision 5b874092)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)trpt.8	8.2 (Berkeley) 12/11/93
7.\"
8.Dd
9.Dt TRPT 8
10.Os BSD 4.2
11.Sh NAME
12.Nm trpt
13.Nd transliterate protocol trace
14.Sh SYNOPSIS
15.Nm trpt
16.Op Fl a
17.Op Fl f
18.Op Fl j
19.Op Fl p Ar hex-address
20.Op Fl s
21.Op Fl t
22.Oo
23.Ar system Op Ar core
24.Oc
25.Sh DESCRIPTION
26.Nm Trpt
27interrogates the buffer of
28.Tn TCP
29trace records created
30when a socket is marked for
31.Dq debugging
32(see
33.Xr setsockopt 2 ) ,
34and prints a readable description of these records.
35When no options are supplied,
36.Nm trpt
37prints all the trace records found in the system
38grouped according to
39.Tn TCP
40connection protocol control
41block
42.Pq Tn PCB .
43The following options may be used to
44alter this behavior.
45.Bl -tag -width Ds
46.It Fl a
47In addition to the normal output,
48print the values of the source and destination
49addresses for each packet recorded.
50.It Fl f
51Follow the trace as it occurs, waiting a short time for additional records
52each time the end of the log is reached.
53.It Fl j
54Just give a list of the protocol control block
55addresses for which there are trace records.
56.It Fl p
57Show only trace records associated with the protocol
58control block at the given address
59.Ar hex-address .
60.It Fl s
61In addition to the normal output,
62print a detailed description of the packet
63sequencing information.
64.It Fl t
65in addition to the normal output,
66print the values for all timers at each
67point in the trace.
68.El
69.Pp
70The recommended use of
71.Nm trpt
72is as follows.
73Isolate the problem and enable debugging on the
74socket(s) involved in the connection.
75Find the address of the protocol control blocks
76associated with the sockets using the
77.Fl A
78option to
79.Xr netstat 1 .
80Then run
81.Nm trpt
82with the
83.Fl p
84option, supplying the associated
85protocol control block addresses.
86The
87.Fl f
88option can be used to follow the trace log once the trace is located.
89If there are
90many sockets using the debugging option, the
91.Fl j
92option may be useful in checking to see if
93any trace records are present for the socket in
94question.
95.Pp
96If debugging is being performed on a system or
97core file other than the default, the last two
98arguments may be used to supplant the defaults.
99.Sh FILES
100.Bl -tag -width /dev/kmem -compact
101.It Pa /vmunix
102.It Pa /dev/kmem
103.El
104.Sh SEE ALSO
105.Xr netstat 1 ,
106.Xr setsockopt 2 ,
107.Xr trsp 8
108.Sh DIAGNOSTICS
109.Bl -tag -width Ds
110.It Sy no namelist
111When the system image doesn't
112contain the proper symbols to find the trace buffer;
113others which should be self explanatory.
114.El
115.Sh BUGS
116Should also print the data for each input or output,
117but this is not saved in the race record.
118.Pp
119The output format is inscrutable and should be described
120here.
121.Sh HISTORY
122The
123.Nm
124command appeared in
125.Bx 4.2 .
126