automake: xpp: man-pages and perl-scripts
[dahdi/tools.git] / system.conf.sample
1 #
2 # DAHDI Configuration File
3 #
4 # This file is parsed by the DAHDI Configurator, dahdi_cfg
5 #
6 # Span Configuration
7 # ++++++++++++++++++
8 # First come the span definitions, in the format
9
10 #   span=<span num>,<timing source>,<line build out (LBO)>,<framing>,<coding>[,yellow]
11 #
12 # All T1/E1/BRI spans generate a clock signal on their transmit side. The
13 # <timing source> parameter determines whether the clock signal from the far
14 # end of the T1/E1/BRI is used as the master source of clock timing. If it is, our
15 # own clock will synchronise to it. T1/E1/BRI connected directly or indirectly to
16 # a PSTN provider (telco) should generally be the first choice to sync to. The
17 # PSTN will never be a slave to you. You must be a slave to it.
18 #
19 # Choose 1 to make the equipment at the far end of the E1/T1/BRI link the preferred
20 # source of the master clock. Choose 2 to make it the second choice for the master
21 # clock, if the first choice port fails (the far end dies, a cable breaks, or
22 # whatever). Choose 3 to make a port the third choice, and so on. If you have, say,
23 # 2 ports connected to the PSTN, mark those as 1 and 2. The number used for each
24 # port should be different.
25 #
26 # If you choose 0, the port will never be used as a source of timing. This is
27 # appropriate when you know the far end should always be a slave to you. If
28 # the port is connected to a channel bank, for example, you should always be
29 # its master. Likewise, BRI TE ports should always be configured as a slave.
30 # Any number of ports can be marked as 0.
31 #
32 # Incorrect timing sync may cause clicks/noise in the audio, poor quality or failed
33 # faxes, unreliable modem operation, and is a general all round bad thing.
34 #
35 # NOTE: The B410P card cannot reliably connect one of its four ports
36 # configured in TE mode to another one configured in NT mode. It will not
37 # reliably sync clock from itself. Please use another physical card and
38 # configure one to provide clock and one to recover clock in any B410P test
39 # environments.
40 #
41 # The line build-out (or LBO) is an integer, from the following table:
42 #
43 #  0: 0 db (CSU) / 0-133 feet (DSX-1)
44 #  1: 133-266 feet (DSX-1)
45 #  2: 266-399 feet (DSX-1)
46 #  3: 399-533 feet (DSX-1)
47 #  4: 533-655 feet (DSX-1)
48 #  5: -7.5db (CSU)
49 #  6: -15db (CSU)
50 #  7: -22.5db (CSU)
51 #
52 # If the span is a BRI port the line build-out is not used and should be set
53 # to 0.
54 #
55 # framing:: 
56 #   one of 'd4' or 'esf' for T1 or 'cas' or 'ccs' for E1. Use 'ccs' for BRI.
57 #  'd4' could be referred to as 'sf' or 'superframe'
58 #
59 # coding:: 
60 #   one of 'ami' or 'b8zs' for T1 or 'ami' or 'hdb3' for E1. Use 'ami' for
61 #   BRI.
62 #
63 #   * For E1 there is the optional keyword 'crc4' to enable CRC4 checking.
64 #   * If the keyword 'yellow' follows, yellow alarm is transmitted when no
65 #     channels are open.
66 #
67 #span=1,0,0,esf,b8zs
68 #span=2,1,0,esf,b8zs
69 #span=3,0,0,ccs,hdb3,crc4
70 #
71 # Dynamic Spans
72 # +++++++++++++
73 # Next come the dynamic span definitions, in the form:
74
75 #   dynamic=<driver>,<address>,<numchans>,<timing>
76 #
77 # Where <driver> is the name of the driver (e.g. eth), <address> is the
78 # driver specific address (like a MAC for eth), <numchans> is the number
79 # of channels, and <timing> is a timing priority, like for a normal span.
80 # use "0" to not use this as a timing source, or prioritize them as
81 # primary, secondard, etc.  Note that you MUST have a REAL DAHDI device
82 # if you are not using external timing.
83 #
84 #   dynamic=eth,eth0/00:02:b3:35:43:9c,24,0
85 #
86 # If a non-zero timing value is used, as above, only the last span should
87 # have the non-zero value. 
88 #
89 # Channel Configuration
90 # +++++++++++++++++++++
91 # Next come the definitions for using the channels.  The format is:
92 # <device>=<channel list>
93 #
94 # Valid devices are:
95 #
96 # e&m::
97 #   Channel(s) are signalled using E&M signalling on a T1 line.
98 #   Specific implementation, such as Immediate, Wink, or Feature
99 #   Group D are handled by the userspace library.
100 # e&me1::
101 #   Channel(s) are signalled using E&M signalling on an E1 line.
102 # fxsls:: 
103 #   Channel(s) are signalled using FXS Loopstart protocol.
104 # fxsgs:: 
105 #   Channel(s) are signalled using FXS Groundstart protocol.
106 # fxsks:: 
107 #   Channel(s) are signalled using FXS Koolstart protocol.
108 # fxols:: 
109 #   Channel(s) are signalled using FXO Loopstart protocol.
110 # fxogs:: 
111 #   Channel(s) are signalled using FXO Groundstart protocol.
112 # fxoks:: 
113 #   Channel(s) are signalled using FXO Koolstart protocol.
114 #
115 # unused:: 
116 #   No signalling is performed, each channel in the list remains idle
117 # clear::
118 #   Channel(s) are bundled into a single span.  No conversion or
119 #   signalling is performed, and raw data is available on the master.
120 # bchan:: 
121 #   Like 'clear' except all channels are treated individually and
122 #   are not bundled.  'inclear' is an alias for this.
123 # rawhdlc::
124 #   The DAHDI driver performs HDLC encoding and decoding on the 
125 #   bundle, and the resulting data is communicated via the master
126 #   device.
127 # dchan::
128 #   The DAHDI driver performs HDLC encoding and decoding on the
129 #   bundle and also performs incoming and outgoing FCS insertion
130 #   and verification.  'fcshdlc' is an alias for this. 
131 # hardhdlc::
132 #   The hardware driver performs HDLC encoding and decoding on the
133 #   bundle and also performs incoming and outgoing FCS insertion
134 #   and verification.  Is subject to limitations and support of underlying
135 #   hardware. BRI spans serviced by the wcb4xxp driver must use hardhdlc
136 #   channels for the signalling channels. 
137 # nethdlc::
138 #   The DAHDI driver bundles the channels together into an
139 #   hdlc network device, which in turn can be configured with
140 #   sethdlc (available separately). In 2.6.x kernels you can also optionally
141 #   pass the name for the network interface after the channel list.
142 #   Syntax:
143 #   
144 #     nethdlc=<channel list>[:interface name]
145 #   Use original names, don't use the names which have been already registered 
146 #   in system e.g eth.
147 #
148 # dacs::
149 #   The DAHDI driver cross connects the channels starting at
150 #   the channel number listed at the end, after a colon
151 # dacsrbs::
152 #   The DAHDI driver cross connects the channels starting at
153 #   the channel number listed at the end, after a colon and 
154 #   also performs the DACSing of RBS bits
155 #
156 # The channel list is a comma-separated list of channels or ranges, for
157 # example:
158 #
159 #   1,3,5 (channels one, three, and five)
160 #   16-23, 29 (channels 16 through 23, as well as channel 29)
161 #
162 # So, some complete examples are:
163 #
164 #   e&m=1-12
165 #   nethdlc=13-24
166 #   fxsls=25,26,27,28
167 #   fxols=29-32
168 #
169 # An example of BRI port:
170
171 #   span=1,1,0,ccs,ami
172 #   bchan=1,2
173 #   hardhdlc=3
174 #
175 # NOTE: When using BRI channels in asterisk, use the bri_cpe, bri_net, or
176 # bri_cpe_ptmp (for point to multipoint mode). libpri does not currently
177 # support point to multipoint when in NT mode. Otherwise, the bearer channel
178 # are configured identically to other DAHDI channels.
179 #
180 #fxoks=1-24
181 #bchan=25-47
182 #dchan=48
183 #fxols=1-12
184 #fxols=13-24
185 #e&m=25-29
186 #nethdlc=30-33
187 #clear=44
188 #clear=45
189 #clear=46
190 #clear=47
191 #fcshdlc=48
192 #dacs=1-24:48
193 #dacsrbs=1-24:48
194 #
195 # Tone Zone Data
196 # ++++++++++++++
197 # Finally, you can preload some tone zones, to prevent them from getting
198 # overwritten by other users (if you allow non-root users to open /dev/dahdi/*
199 # interfaces anyway.  Also this means they won't have to be loaded at runtime.
200 # The format is "loadzone=<zone>" where the zone is a two letter country code.
201
202 # You may also specify a default zone with "defaultzone=<zone>" where zone
203 # is a two letter country code.
204 #
205 # An up-to-date list of the zones can be found in the file zonedata.c
206 #
207 loadzone = us
208 #loadzone = us-old
209 #loadzone=gr
210 #loadzone=it
211 #loadzone=fr
212 #loadzone=de
213 #loadzone=uk
214 #loadzone=fi
215 #loadzone=jp
216 #loadzone=sp
217 #loadzone=no
218 #loadzone=hu
219 #loadzone=lt
220 #loadzone=pl
221 defaultzone=us
222 #
223 # PCI Radio Interface
224 # +++++++++++++++++++
225 # (see http://www.zapatatelephony.org/app_rpt.html)
226 #
227 # The PCI Radio Interface card interfaces up to 4 two-way radios (either
228 # a base/mobile radio or repeater system) to DAHDI channels. The driver
229 # may work either independent of an application, or with it, through
230 # the driver;s ioctl() interface. This file gives you access to specify
231 # load-time parameters for Radio channels, so that the driver may run
232 # by itself, and just act like a generic DAHDI radio interface.
233 #
234 # Unlike the rest of this file, you specify a block of parameters, and
235 # then the channel(s) to which they apply. CTCSS is specified as a frequency
236 # in tenths of hertz, for example 131.8 HZ is specified as 1318. DCS
237 # for receive is specified as the code directly, for example 223. DCS for
238 # transmit is specified as D and then the code, for example D223.
239 #
240 # The hardware supports a "community" CTCSS decoder system that has
241 # arbitrary transmit CTCSS or DCS codes associated with them, unlike
242 # traditional "community" systems that encode the same tone they decode.
243
244 # this example is a single tone DCS transmit and receive
245 #
246 # specify the transmit tone (in DCS mode this stays constant):
247 #tx=D371
248 #
249 # specify the receive DCS code:
250 #dcsrx=223
251 #
252 # this example is a "community" CTCSS (if you only want a single tone, then
253 # only specify 1 in the ctcss list)
254 #
255 # specify the default transmit tone (when not receiving):
256 #tx=1000
257 #
258 # Specify the receive freq, the tag (use 0 if none), and the transmit code.
259 # The tag may be used by applications to determine classification of tones.
260 # The tones are to be specified in order of presedence, most important first.
261 # Currently, 15 tones may be specified..
262 #
263 #ctcss=1318,1,1318
264 #ctcss=1862,1,1862
265 #
266 # The following parameters may be omitted if their default value is acceptible
267 #
268 # Set the receive debounce time in milliseconds:
269 #debouncetime=123
270 #
271 # set the transmit quiet dropoff burst time in milliseconds:
272 #bursttime=234
273 #
274 # set the COR level threshold (specified in tenths of millivolts)
275 # valid values are {3125,6250,9375,12500,15625,18750,21875,25000}
276 #corthresh=12500
277 #
278 # Invert COR signal {y,n}
279 #invertcor=y
280 # Set the external tone mode; yes, no, internal {y,n,i}
281 #exttone=y
282 #
283 # Now apply the configuration to the specified channels:
284 #
285 # We are all done with our channel parameters, so now we specify what
286 # channels they apply to
287 #channels=1-4
288 #
289 # Overiding PCM encoding
290 # ++++++++++++++++++++++
291 # Usually the channel driver sets the encoding of the PCM for the
292 # channel (mulaw / alaw. That is: g711u or g711a). However there are
293 # some cases where you would like to override that. 'mulaw' and 'alaw'
294 # set different such encoding. Use them for channels you have already
295 # defined with e.g. 'bchan' or 'fxoks'.
296 #mulaw=1-4
297 #alaw=1-4
298 #
299 # 'deflaw' is similar, but resets the encoding to the channel driver's
300 # default. It must be useful for something, I guess.
301 #mulaw=1-10
302 #deflaw=5
303 #
304 # Echo Cancellers
305 # +++++++++++++++
306 # DAHDI uses modular echo cancellers that are configured per channel. The echo
307 # cancellers are compiled and installed as part of the dahdi-linux package.
308 # You can specify in this file the echo canceller to be used for each
309 # channel. The default behavior is for there to be NO echo canceller on any
310 # channel, so it is very important that you specify one here.
311 #
312 # Valid echo cancellers are: hwec, mg2, kb1, sec2, and sec.
313 # 'hwec' is a special echo canceller that should be used if hardware echo
314 # cancellation is desired on and available on the specified channels.
315 # If compiled, 'hpec' is also a valid echo canceller.
316
317 # To configure the default echo cancellers, use the format:
318 # echocanceller=<echocanceller name>,<channel(s)>
319 #
320 # Example:
321 # Configure channels 1 through 8 to use the mg2 echo canceller
322 #echocanceller=mg2,1-8 
323 #
324 # And change channel 2 to use the kb1 echo canceller.
325 #echocanceller=kb1,2
326 #