README for tracI 0.26


Supported sources:

- ISDN4Linux		(live from procfs)
- mISDN			(live from socket)
- Cisco AS		(file*) 'debug isdn q931'/'debug isdn q921'
- Ascend/Lucent MAX	(file*)
- Asterisk		(file*) 'pri set debug ...'
- Auerswald PBXs	(live via TCP)
- onsoft watchS0	(file*)
- Siemens HiPath	(file) via Manager E call monitor

*: You can do live traces by specifying a serial port connected to the
   device as input file to tracI.
   For live traces from Asterisk/DAHDI, you can use this procedure:
   Enable debug with 'asterisk -x "pri set debug hex span 0"'.
   Create a fifo with 'mkfifo <fifo>' and redirect debug unsing
   'asterisk -x "pri set debug file <fifo>"' and then start tracI with
   'tracI -i <fifo>'.

----------------------------------------------------------------

Installation:

You can get the source tarball from http://www.yeti.dk/lsoft/ or
chekout the latest work in progress from
http://git.yeti.dk/?p=tracI.git;a=summary
('git clone git://git.yeti.dk/tracI')
Pre-built packages for Slackware are available at
http://www.yeti.dk/Slack-Pkgs/


To install tracI, generally just do a 'make' and a 'make install'

mISDN support (Linux only) is enabled automatically if libmisdn.so is
found under /usr/lib/ or /usr/local/lib/. This comes with the
mISDN_user package.


To use tracI with I4L requires the following additional steps:

- Replace the original decoder in the kernel with the provided version
  that just outputs the hex dump of the D-Channel by doing something
  like 'cp q931.c /usr/src/linux/drivers/isdn/hisax' and re-comile and
  install your kernel or just the modules in case hisax was compiled
  as such.

- Compile tracI.

- Enable the output of D-channel data to /dev/isdnctrl* using
  'hisaxctrl HiSax 11 0x800'.
  Replace "HiSax" by the name you chose in case it differs.

Now you can type ./tracI and see what happens

----------------------------------------------------------------

Usage:

You can start tracI with the filename of a configuration file as
command line parameter.
Otherwise it will try to read .tracIrc in the current directory.
For information about the configuration file take a look into the
sample .tracIrc included.

Commandline options:

  -c <filename>	Name of a configuration file instead of ./.tracIrc

  -i <filename>	Name of a file to decode.
		This overrides any ReadFile specified in the
		configuration file.
		Use "-" to read from stdin.

  -m <port>	If compiled with mISDN support (Linux only), specify
		the port number to get a live trace from.
		Find the available ports using 'misdn_info'.

  -a <host>	If compiled with Auerswald support, connect to <host>
		for a live trace.
		<host> can be an IP address or a hostname resolvable
		on your system.

Options -i, -m and -a are mutially exclusive.


If you have any bug fixes or extensions or want to reach me for some
other reason, mail me at wimpy@yeti.dk

----------------------------------------------------------------

tracI is based on the Q.931 decoder from the HiSax Kernel driver.
Please see the sources for information about who started this.

----------------------------------------------------------------

History:

0.26
-Updated README
-Add Support for traces exported from HiPath Manager E
-Finally some basic 1TR6 decoding

0.25
-Some fixes to make tracI compile under MacOS

0.24
-Add support for reading traces produced by onsoft watchS0
 isdn-analyzer

0.23
-add fflush() for mISDN and Auerswald options
-fix some overlooked warnings
-find libmisdn in /usr/local as well
-fixed conditional compiling
-a little more Ackermann Euracom / P4 decoding

0.22
-Fix empty call identity
-Fix missing octett5 in BC
-Some table fixes
-Allow TCP connections to debug Auerswald PBXs
-Try to parse more output formats from Asterisk
-Decode TEI management
-Some minor fixes and internal tidying

0.21
-directly read from mISDN socket
-new commandline options

0.20
-Read traces produced by Asterisk in different formats
-Fixes for channel identification IE
-Add direction and new format for misdn_log output

0.19
-Add suport for reading traces produced by Asterisk pri debug and
 mISDNdebugtool or misdn_log

0.18
-Add support for ExecOnConn and ExecOnDisc

0.17
-Started decoding of facility IEs

0.16
-Convert duplicate calling party numbers (one unscreened and one
 network provided) to redirecting number for netcti
-Add redirection type to log file

0.15
-Fixed bug with logging of calling party sub address.
-Sub address written to phonebook in AutoAdd when first octett is
 0x09 (Siemens Hicom names).

0.14
-Fixed the wrong month in the date when using the 'autoadd' feature.

0.13
-Additionally to the patched HiSax output it now also reads traces
 generated by Ascend/ Lucent MAX series nework access servers.

0.12
-Added option to read from stdin.


-----------------------------------------------

Known issues:
-Will decode, but not respect codeset shifts.
-Still (almost) no decoding of facility IEs.
