[zaptel-commits] tzafrir: branch 1.4 r4016 - /branches/1.4/doc/ztscan.8

[SVN commits to the Zaptel project]

Author: tzafrir
Date: Tue Mar 18 21:11:29 2008
New Revision: 4016

URL: http://svn.digium.com/view/zaptel?view=rev&rev=4016
Log:
A man page for ztscan.

Added:
    branches/1.4/doc/ztscan.8
      - copied, changed from r4012, branches/1.4/doc/patgen.8

Copied: branches/1.4/doc/ztscan.8 (from r4012, branches/1.4/doc/patgen.8)
URL: http://svn.digium.com/view/zaptel/branches/1.4/doc/ztscan.8?view=diff&rev=4016&p1=branches/1.4/doc/patgen.8&r1=4012&p2=branches/1.4/doc/ztscan.8&r2=4016
==============================================================================
--- branches/1.4/doc/patgen.8 (original)
+++ branches/1.4/doc/ztscan.8 Tue Mar 18 21:11:29 2008
@@ -1,35 +1,91 @@
-.TH patgen 8 "2008-01-08" 
+.TH ztscan 8 "2008-03-18" 
 .SH NAME 
-patgen \(em Generates a Pattern for a Zaptel Clear Channel Test
+ztscan \(em Print Configuration of Zaptel Spans
 .SH SYNOPSIS 
-.B patgen 
-.I zap-device
+.B ztscan
+.I [spans]
 
 .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 ztscan
+prints information about zaptel spans in the system. For analog spans it
+also provides a list of channels.
 
-.B patgen
-Must be able to write to the channel. Hence this cannot be used for a
-channel used by Asterisk.
+By default it prints information about all the spans in the system.
+However if parameters are provided, they will be considered to be a list
+of span numbers and information will be printed for them.
 
-.SH OPTIONS
-.I zap-device
-.RS
-A Zaptel device file.
-.RE
+Output is printed to the standard output. The format is that of an
+Asterisk configuration file (similar to a "ini" configuration file),
+where the name of the section is the number of the span. Note that the
+specifically for analog spans some keys may appear more than once, and
+hence you can not use a parser for an "ini" format and assume you have a
+dictionary.
 
-.SH EXAMPLE
-  patgen /dev/zap/5
+.SH EXAMPLES
+Printing information for spans 1, 2 and 4:
+
+  ztspan 1 2 4
+
+And to print all the spans:
+
+  ztspan
+
+Information about a certain analog span:
+
+  [5]
+  active=yes
+  alarms=OK
+  description=Xorcom XPD #00/10: FXS
+  name=XBUS-00/XPD-10
+  manufacturer=Xorcom Inc.
+  devicetype=Astribank: Unit 1 Subunit 0: FXS
+  location=usb-0000:00:03.3-4
+  basechan=125
+  totchans=8
+  irq=0
+  type=analog
+  port=125,FXS
+  port=126,FXS
+  port=127,FXS
+  port=128,FXS
+  port=129,FXS
+  port=130,FXS
+  port=131,FXS
+  port=132,FXS
+
+And an example of a digital span:
+
+  [1]
+  active=yes
+  alarms=RED
+  description=T2XXP (PCI) Card 0 Span 1
+  name=TE2/0/1
+  manufacturer=Digium
+  devicetype=Wildcard TE205P (4th Gen)
+  location=Board ID Switch 0
+  basechan=1
+  totchans=24
+  irq=193
+  type=digital-T1
+  syncsrc=0
+  lbo=0 db (CSU)/0-133 feet (DSX-1)
+  coding_opts=B8ZS,AMI
+  framing_opts=ESF,D4
+  coding=B8ZS
+  framing=ESF
+
+The "type" field may contain: "analog", "digital-T1", "digital-E1",
+"digital-J1" or "digital-BRI".
+
+.SH FILES
+Requires read access to /dev/zap/ctl .
 
 .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). 
+ztcfg(8), asterisk(8). 
 
 .SH AUTHOR