From ff8f331457d228145dd50da5293b7ec449e95463 Mon Sep 17 00:00:00 2001 From: tzafrir Date: Tue, 8 Jan 2008 21:38:53 +0000 Subject: Documentation updates. git-svn-id: http://svn.digium.com/svn/zaptel/branches/1.4@3626 5390a7c7-147a-4af0-8ec9-7488f05a26cb --- doc/patgen.8 | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/pattest.8 | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/ztdiag.8 | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 142 insertions(+) create mode 100644 doc/patgen.8 create mode 100644 doc/pattest.8 create mode 100644 doc/ztdiag.8 (limited to 'doc') diff --git a/doc/patgen.8 b/doc/patgen.8 new file mode 100644 index 0000000..b92bb6e --- /dev/null +++ b/doc/patgen.8 @@ -0,0 +1,42 @@ +.TH patgen 8 "2008-01-08" +.SH NAME +patgen \(em Generates a Pattern for a Zaptel Clear Channel Test +.SH SYNOPSIS +.B patgen +.I zap-device + +.SH DESCRIPTION +.B patgen +Sends test data to a Zaptel channel. The channel should be of CLEAR +signalling (e.g: B channel of a PRI line). pattest(8) is used to test +the data at the other side. See its manual for more information. + +.B patgen +Must be able to write to the channel. Hence this cannot be used for a +channel used by Asterisk. + +.SH OPTIONS +.I zap-device +.RS +A Zaptel device file. +.RE + +.SH EXAMPLE + patgen /dev/zap/5 + +.SH BUGS +Will not work with channels whose number > 249 as they don't have device +files. For a simple workaround, see ztdiag.c . + +.SH SEE ALSO +pattest(8), ztcfg(8), asterisk(8). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/pattest.8 b/doc/pattest.8 new file mode 100644 index 0000000..c0d14bb --- /dev/null +++ b/doc/pattest.8 @@ -0,0 +1,48 @@ +.TH pattest 8 "2008-01-08" +.SH NAME +pattest \(em Tests a Pattern for a Zaptel Clear Channel Test +.SH SYNOPSIS +.B pattest +.I zap-device + +.SH DESCRIPTION +.B pattest +Recieves test data from a Zaptel channel and checks if it matches the +test pattern. The channel should be of CLEAR signalling (e.g: B channel +of a PRI line). patgen(8) is used to generate the data at the other side. + +.B pattest +Must be able to read from the channel. Hence this cannot be used for a +channel used by Asterisk. + +The pattern is a simple series of values from 0 to 255. Hence it takes +at most one sample to get in sync with the other side. If there is no +output, all is well. Output is an error message. + +.SH OPTIONS +.I zap-device +.RS +A Zaptel device file. +.RE + +.SH EXAMPLE + pattest /dev/zap/5 + +.SH BUGS +Will not work with channels whose number > 249 as they don't have device +files. For a simple workaround, see ztdiag.c . + +Gives way too many errors when does not get any input. + +.SH SEE ALSO +patgen(8), ztcfg(8), asterisk(8). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/ztdiag.8 b/doc/ztdiag.8 new file mode 100644 index 0000000..bdcb480 --- /dev/null +++ b/doc/ztdiag.8 @@ -0,0 +1,52 @@ +.TH ztdiag 8 "2008-01-07" +.SH NAME +ztdiag \(em Dump Zaptel channel parameters +.SH SYNOPSIS +.B ztdiag +.I channel + +.SH DESCRIPTION +.B ztdiag +asks the kernel to dump parameters for Zaptel channel no. +.I channel +to the kernel logs. You will be able to see them using, e.g. dmesg(1). + + +.SH OPTIONS +.I channel +.RS +The number of the Zaptel channel whose parammeters should be dumped. +May be any Zaptel channel (even if it is open). +.RE + +.SH EXAMPLE + + # /tmp/ztdiag 5 + # dmesg | tail -n 15 + Dump of Zaptel Channel 5 (XPP_BRI_TE/00/01/1,5,2): + + flags: 501 hex, writechunk: c5190948, readchunk: c5190954 + rxgain: ccad2e80, txgain: ccad2e80, gainalloc: 0 + span: c48a900c, sig: 80 hex, sigcap: 80 hex + inreadbuf: -1, outreadbuf: 0, inwritebuf: 0, outwritebuf: -1 + blocksize: 160, numbufs: 4, txbufpolicy: 0, txbufpolicy: 0 + txdisable: 0, rxdisable: 0, iomask: 0 + curzone: c78e7000, tonezone: 0, curtone: 00000000, tonep: 0 + digitmode: 0, txdialbuf: , dialing: 0, aftdialtimer: 0, cadpos. 0 + confna: 0, confn: 0, confmode: 0, confmute: 0 + ec: 00000000, echocancel: 0, deflaw: 0, xlaw: ccab5e80 + echostate: 00, echotimer: 0, echolastupdate: 0 + itimer: 0, otimer: 0, ringdebtimer: 0 + +.SH SEE ALSO +ztcfg(8), asterisk(8), dmesg(1). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. -- cgit v1.2.3