dahdi_cfg: add '-S <spanno>' and '-C <chan-ranges>'
[dahdi/tools.git] / doc / dahdi_scan.8
1 .TH dahdi_scan 8 "2008-03-18" 
2 .SH NAME 
3 dahdi_scan \(em Print Configuration of DAHDI Spans
4 .SH SYNOPSIS 
5 .B dahdi_scan
6 .I [spans]
7
8 .SH DESCRIPTION 
9 .B dahdi_scan
10 prints information about DAHDI spans in the system. For analog spans it
11 also provides a list of channels.
12
13 By default it prints information about all the spans in the system.
14 However if parameters are provided, they will be considered to be a list
15 of span numbers and information will be printed for them.
16
17 Output is printed to the standard output. The format is that of an
18 Asterisk configuration file (similar to a "ini" configuration file),
19 where the name of the section is the number of the span. Note that the
20 specifically for analog spans some keys may appear more than once, and
21 hence you can not use a parser for an "ini" format and assume you have a
22 dictionary.
23
24 .SH EXAMPLES
25 Printing information for spans 1, 2 and 4:
26
27   dahdi_scan 1 2 4
28
29 And to print all the spans:
30
31   dahdi_scan
32
33 Information about a certain analog span:
34
35   [5]
36   active=yes
37   alarms=OK
38   description=Xorcom XPD #00/10: FXS
39   name=XBUS\-00/XPD\-10
40   manufacturer=Xorcom Inc.
41   devicetype=Astribank: Unit 1 Subunit 0: FXS
42   location=usb\-0000:00:03.3\-4
43   basechan=125
44   totchans=8
45   irq=0
46   type=analog
47   port=125,FXS
48   port=126,FXS
49   port=127,FXS
50   port=128,FXS
51   port=129,FXS
52   port=130,FXS
53   port=131,FXS
54   port=132,FXS
55
56 And an example of a digital span:
57
58   [1]
59   active=yes
60   alarms=RED
61   description=T2XXP (PCI) Card 0 Span 1
62   name=TE2/0/1
63   manufacturer=Digium
64   devicetype=Wildcard TE205P (4th Gen)
65   location=Board ID Switch 0
66   basechan=1
67   totchans=24
68   irq=193
69   type=digital\-T1
70   syncsrc=0
71   lbo=0 db (CSU)/0\-133 feet (DSX\-1)
72   coding_opts=B8ZS,AMI
73   framing_opts=ESF,D4
74   coding=B8ZS
75   framing=ESF
76
77 The "type" field may contain: "analog", "digital\-T1", "digital\-E1",
78 "digital\-J1" or "digital\-BRI".
79
80 .SH FILES
81 Requires read access to /dev/dahdi/ctl .
82
83 .SH SEE ALSO 
84 dahdi_cfg(8), asterisk(8). 
85
86 .SH BUGS
87 The program still does not do everything described in the man page.
88
89 It also assumes that spans don't skip channel numbers, and that their 
90 channel numbers are "running". This is anyway almost always the case. 
91 And always the case in a normal boot process.
92
93 .SH AUTHOR 
94
95 This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
96 Permission is granted to copy, distribute and/or modify this document under 
97 the terms of the GNU General Public License, Version 2 any  
98 later version published by the Free Software Foundation. 
99  
100 On Debian systems, the complete text of the GNU General Public 
101 License can be found in /usr/share/common\-licenses/GPL.