macro and text revision (-mdoc version 3)

[unix-history] / 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 d60bc57..6504b7f 100644 (file)
--- a/usr/src/usr.sbin/trsp/trsp.8
+++ b/usr/src/usr.sbin/trsp/trsp.8
@@ -1,105 +1,118 @@
 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).
 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%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)trsp.8      6.3 (Berkeley) %G%
+.\"     @(#)trsp.8     6.4 (Berkeley) %G%

 .\"
 .\"

-.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)),
+.Dd 
+.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, 
 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
 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.
 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
 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,
 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
 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 
 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 
 option to 

-.IR netstat (1).
+.Xr netstat 1 .

 Then run
 Then run

-.I trsp
+.Nm trsp

 with the
 with the

-.B \-p
+.Fl p

 option, supplying the associated
 protocol control block addresses.  If there are
 many sockets using the debugging option, the
 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.
 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.
 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.
 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.
 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.
 The output format is inscrutable and should be described
 here.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.3 .