usr.sbin/trpt/trpt.8

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