hyphen/minus fixes in man pages
[dahdi/tools.git] / doc / dahdi_span_types.8
1 .TH "DAHDI_SPAN_TYPES" "8" "23 Jan 2014" "" ""
2
3 .SH NAME
4 dahdi_span_types \- set line modes of DAHDI spans before assignment
5 .SH SYNOPSIS
6
7 .B dahdi_span_types [\fIoptions\fB] <list|dumpconfig|set> \fB[\fIdevpath \fB...]
8
9 .SH DESCRIPTION
10 The span type (the line mode: E1/T1/J1) must be set to a span before
11 DAHDI assigns it a span number, as E1 spans use more channels.
12 \fBdahdi_span_types\fR applies the span type configuration to an
13 un-assigned span.
14
15 Using it only makes sense when the kernel module parameter
16 \fBdahdi.auto_assign_span\fR is unset, otherwise DAHDI automatically
17 assign span numbers during device registration.
18
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 .SH OPTIONS
26
27 .B \-h|\-\-help
28 .RS
29 Output usage message and exit
30 .RE
31
32 .B \-n|\-\-dry\-run
33 .RS
34 During \fB"set"\fR operation, only show what would be done, without actually
35 changing anything.
36 .RE
37
38 .B \-v|\-\-verbose
39 .RS
40 During \fB"set"\fR operation, show the actions that are being performed.
41 .RE
42
43 .BI \-\-line\-mode= <E1|T1|J1>
44 .RS
45 During \fB"dumpconfig"\fR operation, force special generation mode:
46 .IP \(bu 3
47 First, generates a "wildcard" entry with the fiven \fBline\-mode\fR.
48 .IP \(bu 3
49 Comment out all span entries. Each of them may be manually un-commented
50 to override the "wildcard".
51 .RE
52
53 .SH SUB-COMMANDS
54 .B set
55 .RS
56 Reads settings from \fBspan\-types.conf\fR and applies them to the
57 device(s) specified in the command line (or all devices, if none
58 specified).
59 .RE
60
61 .B list
62 .RS
63 List line modes for all spans in the system which may be set with
64 dahdi_span_types (E1/T1/J1 spans).
65 .RE
66
67 .B dumpconfig
68 .RS
69 List types for the spans in a format fit to be used in
70 \fBspan\-types.conf\fR. Use this to generate a configuration file after
71 you have (perhaps manually) set all existing spans.
72
73 .B dahdi_genconf spantypes
74 uses this command internally.
75 .RE
76
77 .SH CONFIGURATION
78 .SS General structure
79 .B span\-types.conf
80 is a file with lines specifying line modes of spans.
81
82 Empty lines or lines beginning with '#' are ignored.
83
84 Each line is in the format of:
85
86 .I ID           spanspec ...
87
88 The \fIID\fR field specifies the DAHDI device and the \fIspanspecs\fR
89 define the line modes of its spans. A line may have multiple
90 \fIspanspecs\fR in a single line (though dumpconfig generates a
91 configuration with one per line).
92
93 .SS Span Identifier
94 A DAHDI device may be specified either by a hardware identifier (a
95 software readable serial number or whatever) or the location in which
96 it is installed on the system. The former makes it simpler to change
97 connector / slot whereas the latter makes it simpler to replace a unit.
98
99 The value in this field is matched (when the command \fBset\fR is
100 used) to the following values:
101
102  \fIhwid\fR
103  \fB@\fIlocation\fR
104  \fIdevpath\fR
105
106 See above for their descriptions. The value may include shell wildcards:
107 *, ? and [], which are used in the match. The values to be matched are
108 first cleaned up: '!' is replaced with '/' and any character not in
109 "a\-zA\-Z0\-9/:.\-" is replaced by "_".
110
111 Note that while span\-types.conf allows an arbitrarily-complex
112 combination of E1, J1 and T1 ports, it would normally have just a single
113 wildcard line setting the line mode (the first line in the example below).
114
115 .SS Span Specification
116
117 Each line should have one or more span specifications: this is the value
118 used to set span type with DAHDI in the SysFS interface. A
119 specification has two colon-separated fields:
120
121 .I rel_span_no:span_type
122
123 for instance, the following are four span specifications specify ports 1
124 and 2 as E1 and ports 3 and 4 as T1: [12]:E1 [34]:T1 .
125
126 .B rel_span_no
127 .RS
128 The relative number of the span in the device. E.g.: port number.
129 This field may contain shell wildcards (*, ? and [])
130 .RE
131
132 .B span_type
133 .RS
134 E1/T1/J1
135 .RE
136
137 .SS Multiple matches
138 During \fBset\fR operation, the \fBdahdi_span_types\fR applies all
139 matching settings to a span. This is done in the order of lines in the
140 configuration files.
141
142 Thus, if there are multiple matches to a span -- the last match
143 will \fIwin\fR (all will be applied to the kernel in order. The last
144 one in the file will be applied last).
145
146 Example:
147 .EX
148 *             *:T1      # All spans on all devices will be T1
149 usb:X1234567  [34]:E1   # Except spans 3,4 on the device which will be E1
150 .EE
151
152
153 .SH ENVIRONMENT
154
155 .B DAHDICONFDIR
156 .RS
157 The directory in which span\-types.conf resides. /etc/dahdi if not
158 overridden from the environment.
159 .RE
160
161 .B DAHDISPANTYPESCONF
162 .RS
163 The path to span\-types.conf resides. /etc/dahdi/span\-types.conf if
164 not overridden from the environment.
165 .RE
166
167
168 .SH FILES
169
170 .B /etc/dahdi/span\-types.conf
171 .RS
172 The default location for the configuration file.
173 .RE
174
175 .B /sys/bus/dahdi_devices/devices/\fIdevice\fR
176 .RS
177 SysFS node for the device. In this directory reside the following
178 files, among others:
179
180 .B spantype
181 .RS
182 read/write file. Reading from it returns current configuration for spans
183 of the device. Span-specifications can be written to it to change line
184 modes (but only for a span that is not assigned yet).
185 .RE
186
187
188 .SH SEE ALSO
189 dahdi_span_assignments(8), dahdi_genconf(8), dahdi_cfg(8)
190
191 .SH AUTHOR
192 dahdi_span_types was written by Oron Peled.  This manual page was
193 written by Tzafrir Cohen. Permission is granted to copy, distribute
194 and/or modify this document under the terms of the GNU General Public
195 License, Version 2 any  later version published by the Free Software
196 Foundation.
197