A man page for ztscan.

git-svn-id: http://svn.digium.com/svn/zaptel/branches/1.4@4016 5390a7c7-147a-4af0-8ec9-7488f05a26cb

1 files changed, 98 insertions, 0 deletions

diff --git a/doc/ztscan.8 b/doc/ztscan.8
new file mode 100644
index 0000000..ffc3b61
--- /dev/null
+++ b/doc/ztscan.8
@@ -0,0 +1,98 @@
+.TH ztscan 8 "2008-03-18" 
+.SH NAME 
+ztscan \(em Print Configuration of Zaptel Spans
+.SH SYNOPSIS 
+.B ztscan
+.I [spans]
+
+.SH DESCRIPTION 
+.B ztscan
+prints information about zaptel spans in the system. For analog spans it
+also provides a list of channels.
+
+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.
+
+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 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 
+ztcfg(8), asterisk(8). 
+
+.SH AUTHOR 
+
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+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.