X-Git-Url: https://git.subgeniuskitty.com/unix-history/.git/blobdiff_plain/24f519df04cd2f5b196a59b232d18a0cca243260..af359dea2e5ab3e937b62107ecd6a51d78189ed7:/usr/src/usr.sbin/trsp/trsp.8 diff --git a/usr/src/usr.sbin/trsp/trsp.8 b/usr/src/usr.sbin/trsp/trsp.8 index d60bc578de..c171616547 100644 --- a/usr/src/usr.sbin/trsp/trsp.8 +++ b/usr/src/usr.sbin/trsp/trsp.8 @@ -1,105 +1,141 @@ -This manual page documents a tool used for debugging failures in -the Xerox NS Sequenced packet protocol layer. It is adapted from -the Internet equivalent trpt(8c). -.\" Copyright (c) 1985 The Regents of the University of California. +.\" Copyright (c) 1985, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" 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. .\" -.\" @(#)trsp.8 6.3 (Berkeley) %G% +.\" 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. .\" -.TH TRSP 8 "" -.UC 5 -.SH NAME -trsp \- transliterate sequenced packet protocol trace -.SH SYNOPSIS -.B trsp -[ -.B \-a -] [ -.B \-s -] [ -.B \-t -] [ -.B \-j -] [ -.B \-p -hex-address ] -[ system [ core ] ] -.SH DESCRIPTION -.I Trpt -interrogates the buffer of SPP trace records created -when a socket is marked for \*(lqdebugging\*(rq (see -.IR setsockopt (2)), +.\" @(#)trsp.8 6.4 (Berkeley) 3/16/91 +.\" +.Dd March 16, 1991 +.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, -.I trsp +.Nm trsp prints all the trace records found in the system -grouped according to SPP connection protocol control -block (PCB). The following options may be used to +grouped according to +.Tn SPP +connection protocol control +block +.Pq Tn PCB . +The following options may be used to alter this behavior. -.TP -.B \-s +.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, -.TP -.B \-t +sequencing information. +.It Fl t in addition to the normal output, print the values for all timers at each point in the trace, -.TP -.B \-j -just give a list of the protocol control block -addresses for which there are trace records, -.TP -.B \-p -show only trace records associated with the protocol -control block who's address follows, -.TP -.B \-a -in addition to the normal output, -print the values of the source and destination -addresses for each packet recorded. -.PP +.El +.Pp The recommended use of -.I trsp +.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 -.B \-A +.Fl A option to -.IR netstat (1). +.Xr netstat 1 . Then run -.I trsp +.Nm trsp with the -.B \-p +.Fl p option, supplying the associated protocol control block addresses. If there are many sockets using the debugging option, the -.B \-j +.Fl j option may be useful in checking to see if any trace records are present for the socket in question. -.PP +.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 -/vmunix -.br -/dev/kmem -.SH "SEE ALSO" -netstat(1), setsockopt(2) -.SH DIAGNOSTICS -``no namelist'' when the system image doesn't +.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 +.Sh BUGS Should also print the data for each input or output, but this is not saved in the race record. -.PP +.Pp The output format is inscrutable and should be described here. +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.3 .