c7d221d9ea1be182d09421ab6bad53a9160c46f7
[dahdi/tools.git] / doc / dahdi_span_types.8
1 .TH "SPAN_TYPES" "8" "13 Oct 2013" "" ""
2
3 .SH NAME
4 dahdi_span_types \- set DAHDI spans properties before registration (E1/T1)
5 .SH SYNOPSIS
6
7 .B dahdi_span_types <list|dumpconfig|set> [\fIdevpath \fB[\fIdevpath \fB...]]
8
9 .SH DESCRIPTION
10 The span type (E1/T1/J1) must be set to a span before registering it
11 with DAHDI, as E1 spans use more channels. \fBdahdi_span_types\fR applies the
12 span type configuration to an unregistered span.
13
14 Using it only makes sense when the kernel module parameter
15 \fBdahdi.auto_assign_span\fR is unset, otherwise the DAHDI spans register
16 automatically.
17
18 .SH OPTIONS
19 .B dahdi_span_types
20 takes a command and an optional list of devices. If no device is given,
21 the command is applied to all devices.
22
23 The device is marked as a path in the SysFS tree.
24
25 .B set
26 .RS
27 Reads settings from \fBspan-types.conf\fR and applies them to the
28 device(s) specified in the command line (or all devices, if none
29 specified).
30 .RE
31
32 .B list
33 .RS
34 List types for all spans in the system which may be set with dahdi_span_types
35 (E1/T1/J1 spans).
36 .RE
37
38 .B dumpconfig
39 .RS
40 List types for the spans in a format fit to be used in
41 \fBspan-types.conf\fR. Use this to generate a configuration file after
42 you have (perhaps manually) set all existing spans.
43
44 .B dahdi_genconf spantypes
45 uses this command internally.
46 .RE
47
48 .SH CONFIGURATION
49 .B span-types.conf
50 is a file with lines specifying registration of spans.
51
52 Empty lines or lines beginning with '#' are ignored.
53
54 Each line is in the format of:
55
56 .I ID           spanspec ...
57
58 The \fIID\fR field specifies the DAHDI device and the \fIspanspecs\fR
59 define how to register its spans. A line may have multiple
60 \fIspanspecs\fR in a single line (though dumpconfig generates a
61 configuration with one per line).
62
63 .SS Span Identifier
64 A DAHDI device may be specified either by a hardware identifier (a
65 software readable serial number or whatever) or the location in which
66 it is installed on the system. The former makes it simpler to change
67 connector / slot whereas the latter makes it simpler to replace a unit.
68
69 The value in this field is matched (when the commands \fBadd\fR and
70 \fBremove\fR) are used) to the following values:
71
72  \fIhwid\fR
73  \fB@\fIlocation\fR
74  \fIdevpath\fR
75
76 See above for their descriptions. The value may include shell wildcards:
77 *, ? and [], which are used in the match. The values to be matched are
78 first cleaned up: '!' is replaced with '/' and any character beyond
79 "a-zA-Z0-9/:.-" is removed.
80
81 .SS Span Specification
82
83 Each line should have one or more span specifications: this is the value
84 used to register a span with DAHDI in the SysFS interface. A
85 specification has three colon-separated numbers:
86
87 .I rel_span_no:span_type
88
89 for instance, the following are four span specifications specify ports 1 and 2 as E1 and ports 3 and 4 as T1: [12]:E1 [34]:T1 .
90
91 .B rel_span_no
92 .RS
93 The relative number of the span in the device. E.g.: port number.
94 .RE
95
96 .B span_type
97 .RS
98 E1/T1/J1
99 .RE
100
101
102 .SH ENVIRONMENT
103
104 .B DAHDICONFDIR
105 .RS
106 The directory in which span-types.conf resides. /etc/dahdi if not
107 overridden from the environment.
108 .RE
109
110 .B DAHDISPANTYPESCONF
111 .RS
112 The path to span-types.conf resides. /etc/dahdi/span-types.conf if
113 not overridden from the environment.
114 .RE
115
116
117 .SH FILES
118
119 .B /etc/dahdi/span-types.conf
120 .RS
121 The default location for the configuration file.
122 .RE
123
124 .B /sys/bus/dahdi_devices/devices/\fIdevice\fR
125 .RS
126 SysFS node for the device. In this directory reside the following
127 files, among others:
128
129 .B spantype
130 .RS
131 read/write file. Reading from it returns current configuration for spans
132 of the device. Span-specifications can be written to it to change types
133 (but only for a span that is not registered).
134 .RE
135
136
137 .SH SEE ALSO
138 dahdi_span_assignments(8), dahdi_genconf(8), dahdi_cfg(8)
139
140 .SH AUTHOR
141 dahdi_span_types was written by Oron Peled.  This manual page was
142 written by Tzafrir Cohen. Permission is granted to copy, distribute
143 and/or modify this document under the terms of the GNU General Public
144 License, Version 2 any  later version published by the Free Software
145 Foundation.
146