usr.sbin/i4b/isdndecode/isdndecode.8

   1 .\"
   2 .\" Copyright (c) 1998, 2000 Hellmuth Michaelis. 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\"     $Id: isdndecode.8,v 1.9 2000/02/21 15:17:17 hm Exp $
  26 .\"
  27 .\"     last edit-date: [Mon Feb 21 16:15:09 2000]
  28 .\"
  29 .\" $FreeBSD: src/usr.sbin/i4b/isdndecode/isdndecode.8,v 1.9.2.5 2003/03/11 21:13:49 trhodes Exp $
  30 .\" $DragonFly: src/usr.sbin/i4b/isdndecode/isdndecode.8,v 1.3 2006/02/17 19:40:15 swildner Exp $
  31 .\"
  32 .Dd February 21, 2000
  33 .Dt ISDNDECODE 8
  34 .Os
  35 .Sh NAME
  36 .Nm isdndecode
  37 .Nd isdn4bsd ISDN protocol decode utility
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl a
  41 .Op Fl b
  42 .Op Fl d
  43 .Op Fl f Ar filename
  44 .Op Fl h
  45 .Op Fl i
  46 .Op Fl l
  47 .Op Fl o
  48 .Op Fl p Ar filename
  49 .Op Fl u Ar number
  50 .Op Fl x
  51 .Op Fl B
  52 .Op Fl P
  53 .Op Fl R Ar unit
  54 .Op Fl T Ar unit
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility is part of the isdn4bsd package and is used to provide the user with a
  59 detailed mnemonic display of the layers 1, 2 and 3 protocol activities on
  60 the D channel and hex dump of the B channel(s) activities.
  61 .Pp
  62 Together with two passive supported cards and an easy to build cable it can
  63 also be used to monitor the complete traffic on a S0 bus providing S0 bus
  64 analyzer features.
  65 .Pp
  66 The
  67 .Nm
  68 utility is only available for passive supported cards.
  69 .Pp
  70 The following options can be used:
  71 .Bl -tag -width Ds
  72 .It Fl a
  73 Run
  74 .Nm
  75 in analyzer mode by using two passive cards and a custom cable which can
  76 be build as described in the file
  77 .Em cable.txt
  78 in the isdn4bsd source distribution. One card acts as a receiver for the
  79 transmitting direction on the S0 bus while the other card acts as a receiver
  80 for the receiving direction on the S0 bus. Complete traffic monitoring is
  81 possible using this setup.
  82 .It Fl b
  83 switch B channel tracing on (default off).
  84 .It Fl d
  85 switch D channel tracing off (default on).
  86 .It Fl f
  87 Use
  88 .Ar filename
  89 as the name of a file into which to write tracing output (default filename is
  90 isdndecode<n> where n is the number of the unit to decode).
  91 .It Fl h
  92 switch display of header off (default on).
  93 .It Fl i
  94 print layer 1 (I.430) INFO signals to monitor layer 1 activity (default off).
  95 .It Fl l
  96 switch displaying of Layer 2 (Q.921) frames off (default on).
  97 .It Fl o
  98 switch off writing decode output to a file (default on).
  99 .It Fl p
 100 Use
 101 .Ar filename
 102 as the name of a file used for the -B and -P options (default filename
 103 is isdntracebin<n> where n is the number of the unit to decode).
 104 .It Fl u
 105 Use
 106 .Ar number
 107 as the unit number of the controller card to decode (default 0).
 108 .It Fl x
 109 Decode Layer 3 packets with an unknown protocol discriminator.
 110 .It Fl B
 111 Write undecoded binary decode data to a file for later or remote
 112 analyzing (default off).
 113 .It Fl P
 114 Read undecoded binary decode data from file instead from device (default off).
 115 .It Fl R
 116 Use
 117 .Ar unit
 118 as the receiving interface unit number in analyze mode.
 119 .It Fl T
 120 Use
 121 .Ar unit
 122 as the transmitting interface unit number in analyze mode.
 123 .El
 124 .Pp
 125 When the USR1 signal is sent to a
 126 .Nm
 127 process, the currently used logfiles are reopened, so that logfile
 128 rotation becomes possible.
 129 .Pp
 130 The decode output should be obvious. It is very handy to have the following
 131 standard texts available when tracing ISDN protocols:
 132 .Pp
 133 .Bl -tag -width Ds -compact -offset indent
 134 .It Ar I.430
 135 ISDN BRI layer 1 protocol description.
 136 .It Ar Q.921
 137 ISDN D-channel layer 2 protocol description.
 138 .It Ar Q.931
 139 ISDN D-channel layer 3 protocol description.
 140 .El
 141 .Sh FILES
 142 .Bl -tag -width daddeldi -compact
 143 .It Pa /dev/i4btrc<n>
 144 The devicefile(s) used to get the decode messages for ISDN card unit <n>
 145 out of the kernel.
 146 .El
 147 .Sh EXAMPLES
 148 The command:
 149 .Bd -literal -offset indent
 150 isdndecode -f /var/tmp/isdn.decode
 151 .Ed
 152 .Pp
 153 will start D channel tracing on passive controller 0 with all except B
 154 channel tracing enabled and logs everything into the output file
 155 /var/tmp/isdn.decode.
 156 .Sh SEE ALSO
 157 .Xr isdnd 8
 158 .Sh STANDARDS
 159 ITU Recommendations I.430, Q.920, Q.921, Q.930, Q.931
 160 .Pp
 161 ITU Recommendation Q.932 (03/93), Q.950 (03/93)
 162 .Pp
 163 ETSI Recommendation ETS 300 179 (10/92), ETS 300 180 (10/92)
 164 .Pp
 165 ETSI Recommendation ETS 300 181 (04/93), ETS 300 182 (04/93)
 166 .Pp
 167 ITU Recommendation X.208, X.209
 168 .Sh AUTHORS
 169 The
 170 .Nm
 171 utility and this manual page were written by
 172 .An Hellmuth Michaelis Aq hm@kts.org .
 173 .Sh BUGS
 174 Still one left.