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$
  30 .\"
  31 .Dd February 21, 2000
  32 .Dt ISDNDECODE 8
  33 .Os
  34 .Sh NAME
  35 .Nm isdndecode
  36 .Nd isdn4bsd ISDN protocol decode utility
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl a
  40 .Op Fl b
  41 .Op Fl d
  42 .Op Fl f Ar filename
  43 .Op Fl h
  44 .Op Fl i
  45 .Op Fl l
  46 .Op Fl o
  47 .Op Fl p Ar filename
  48 .Op Fl u Ar number
  49 .Op Fl x
  50 .Op Fl B
  51 .Op Fl P
  52 .Op Fl R Ar unit
  53 .Op Fl T Ar unit
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 utility is part of the isdn4bsd package and is used to provide the user with a
  58 detailed mnemonic display of the layers 1, 2 and 3 protocol activities on
  59 the D channel and hex dump of the B channel(s) activities.
  60 .Pp
  61 Together with two passive supported cards and an easy to build cable it can
  62 also be used to monitor the complete traffic on a S0 bus providing S0 bus
  63 analyzer features.
  64 .Pp
  65 The
  66 .Nm
  67 utility is only available for passive supported cards.
  68 .Pp
  69 The following options can be used:
  70 .Bl -tag -width Ds
  71 .It Fl a
  72 Run
  73 .Nm
  74 in analyzer mode by using two passive cards and a custom cable which can
  75 be build as described in the file
  76 .Em cable.txt
  77 in the isdn4bsd source distribution.
  78 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.
  81 Complete traffic monitoring is
  82 possible using this setup.
  83 .It Fl b
  84 switch B channel tracing on (default off).
  85 .It Fl d
  86 switch D channel tracing off (default on).
  87 .It Fl f
  88 Use
  89 .Ar filename
  90 as the name of a file into which to write tracing output (default filename is
  91 isdndecode<n> where n is the number of the unit to decode).
  92 .It Fl h
  93 switch display of header off (default on).
  94 .It Fl i
  95 print layer 1 (I.430) INFO signals to monitor layer 1 activity (default off).
  96 .It Fl l
  97 switch displaying of Layer 2 (Q.921) frames off (default on).
  98 .It Fl o
  99 switch off writing decode output to a file (default on).
 100 .It Fl p
 101 Use
 102 .Ar filename
 103 as the name of a file used for the -B and -P options (default filename
 104 is isdntracebin<n> where n is the number of the unit to decode).
 105 .It Fl u
 106 Use
 107 .Ar number
 108 as the unit number of the controller card to decode (default 0).
 109 .It Fl x
 110 Decode Layer 3 packets with an unknown protocol discriminator.
 111 .It Fl B
 112 Write undecoded binary decode data to a file for later or remote
 113 analyzing (default off).
 114 .It Fl P
 115 Read undecoded binary decode data from file instead from device (default off).
 116 .It Fl R
 117 Use
 118 .Ar unit
 119 as the receiving interface unit number in analyze mode.
 120 .It Fl T
 121 Use
 122 .Ar unit
 123 as the transmitting interface unit number in analyze mode.
 124 .El
 125 .Pp
 126 When the USR1 signal is sent to a
 127 .Nm
 128 process, the currently used logfiles are reopened, so that logfile
 129 rotation becomes possible.
 130 .Pp
 131 The decode output should be obvious.
 132 It is very handy to have the following
 133 standard texts available when tracing ISDN protocols:
 134 .Pp
 135 .Bl -tag -width Ds -compact -offset indent
 136 .It Ar I.430
 137 ISDN BRI layer 1 protocol description.
 138 .It Ar Q.921
 139 ISDN D-channel layer 2 protocol description.
 140 .It Ar Q.931
 141 ISDN D-channel layer 3 protocol description.
 142 .El
 143 .Sh FILES
 144 .Bl -tag -width daddeldi -compact
 145 .It Pa /dev/i4btrc<n>
 146 The devicefile(s) used to get the decode messages for ISDN card unit <n>
 147 out of the kernel.
 148 .El
 149 .Sh EXAMPLES
 150 The command:
 151 .Bd -literal -offset indent
 152 isdndecode -f /var/tmp/isdn.decode
 153 .Ed
 154 .Pp
 155 will start D channel tracing on passive controller 0 with all except B
 156 channel tracing enabled and logs everything into the output file
 157 /var/tmp/isdn.decode.
 158 .Sh SEE ALSO
 159 .Xr isdnd 8
 160 .Sh STANDARDS
 161 ITU Recommendations I.430, Q.920, Q.921, Q.930, Q.931
 162 .Pp
 163 ITU Recommendation Q.932 (03/93), Q.950 (03/93)
 164 .Pp
 165 ETSI Recommendation ETS 300 179 (10/92), ETS 300 180 (10/92)
 166 .Pp
 167 ETSI Recommendation ETS 300 181 (04/93), ETS 300 182 (04/93)
 168 .Pp
 169 ITU Recommendation X.208, X.209
 170 .Sh AUTHORS
 171 The
 172 .Nm
 173 utility and this manual page were written by
 174 .An Hellmuth Michaelis Aq hm@kts.org .
 175 .Sh BUGS
 176 Still one left.