[apple/network_cmds.git] / trsp.tproj / trsp.8

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