Integrating sample / reference configuration file into the reference

documentation.

Merged revisions 3968 via svnmerge from 
http://svn.digium.com/svn/zaptel/branches/1.2


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

1 files changed, 129 insertions, 87 deletions

diff --git a/zaptel.conf.sample b/zaptel.conf.sample
index 4905337..8244b65 100644
--- a/zaptel.conf.sample
+++ b/zaptel.conf.sample
@@ -3,9 +3,11 @@
 #
 # This file is parsed by the Zaptel Configurator, ztcfg
 #
-#
+# Span Configuration
+# ~~~~~~~~~~~~~~~~~~
 # First come the span definitions, in the format
-# span=<span num>,<timing source>,<line build out (LBO)>,<framing>,<coding>[,yellow]
+# 
+#   span=<span num>,<timing source>,<line build out (LBO)>,<framing>,<coding>[,yellow]
 #
 # All T1/E1 spans generate a clock signal on their transmit side. The
 # <timing source> parameter determines whether the clock signal from the far
@@ -30,14 +32,15 @@
 # faxes, unreliable modem operation, and is a general all round bad thing.
 #
 # The line build-out (or LBO) is an integer, from the following table:
-# 0: 0 db (CSU) / 0-133 feet (DSX-1)
-# 1: 133-266 feet (DSX-1)
-# 2: 266-399 feet (DSX-1)
-# 3: 399-533 feet (DSX-1)
-# 4: 533-655 feet (DSX-1)
-# 5: -7.5db (CSU)
-# 6: -15db (CSU)
-# 7: -22.5db (CSU)
+#
+#  0: 0 db (CSU) / 0-133 feet (DSX-1)
+#  1: 133-266 feet (DSX-1)
+#  2: 266-399 feet (DSX-1)
+#  3: 399-533 feet (DSX-1)
+#  4: 533-655 feet (DSX-1)
+#  5: -7.5db (CSU)
+#  6: -15db (CSU)
+#  7: -22.5db (CSU)
 #
 # The framing is one of "d4" or "esf" for T1 or "cas" or "ccs" for E1
 #
@@ -54,8 +57,11 @@
 #span=2,1,0,esf,b8zs
 #span=3,0,0,ccs,hdb3,crc4
 #
+# Dynamic Spans
+# ~~~~~~~~~~~~~
 # Next come the dynamic span definitions, in the form:
-# dynamic=<driver>,<address>,<numchans>,<timing>
+# 
+#   dynamic=<driver>,<address>,<numchans>,<timing>
 #
 # Where <driver> is the name of the driver (e.g. eth), <address> is the
 # driver specific address (like a MAC for eth), <numchans> is the number
@@ -64,67 +70,92 @@
 # primary, secondard, etc.  Note that you MUST have a REAL zaptel device
 # if you are not using external timing.
 #
-# dynamic=eth,eth0/00:02:b3:35:43:9c,24,0
+#   dynamic=eth,eth0/00:02:b3:35:43:9c,24,0
 #
+# Channel Configuration
+# ~~~~~~~~~~~~~~~~~~~~~
 # Next come the definitions for using the channels.  The format is:
 # <device>=<channel list>
 #
 # Valid devices are:
 #
-# "e&m"     : Channel(s) are signalled using E&M signalling (specific
-#             implementation, such as Immediate, Wink, or Feature Group D
-#             are handled by the userspace library).
-# "fxsls"   : Channel(s) are signalled using FXS Loopstart protocol.
-# "fxsgs"   : Channel(s) are signalled using FXS Groundstart protocol.
-# "fxsks"   : Channel(s) are signalled using FXS Koolstart protocol.
-# "fxols"   : Channel(s) are signalled using FXO Loopstart protocol.
-# "fxogs"   : Channel(s) are signalled using FXO Groundstart protocol.
-# "fxoks"   : Channel(s) are signalled using FXO Koolstart protocol.
-# "sf"	    : Channel(s) are signalled using in-band single freq tone.
-#		Syntax as follows: 
-#		 channel# => sf:<rxfreq>,<rxbw>,<rxflag>,<txfreq>,<txlevel>,<txflag>
-#		rxfreq is rx tone freq in hz, rxbw is rx notch (and decode)
-#		bandwith in hz (typically 10.0), rxflag is either 'normal' or
-#		'inverted', txfreq is tx tone freq in hz, txlevel is tx tone 
-#		level in dbm, txflag is either 'normal' or 'inverted'. Set 
-#		rxfreq or txfreq to 0.0 if that tone is not desired.
-# "unused"  : No signalling is performed, each channel in the list remains idle
-# "clear"   : Channel(s) are bundled into a single span.  No conversion or
-#             signalling is performed, and raw data is available on the master.
-# "indclear": Like "clear" except all channels are treated individually and
-#             are not bundled.  "bchan" is an alias for this.
-# "rawhdlc" : The zaptel driver performs HDLC encoding and decoding on the 
-#             bundle, and the resulting data is communicated via the master
-#             device.
-# "fcshdlc" : The zaptel (software) driver performs HDLC encoding and decoding on the
-#             bundle and also performs incoming and outgoing FCS insertion
-#             and verification.  "dchan" is an alias for this.
-# "hardhdlc" : The hardware driver performs HDLC encoding and decoding on the
-#             bundle and also performs incoming and outgoing FCS insertion
-#             and verification.  Is subject to limitations and support of underlying
-#             hardware.
-# "nethdlc" : The zaptel driver bundles the channels together into an
-#             hdlc network device, which in turn can be configured with
-#             sethdlc (available separately). In 2.6.x kernels you can also optionally
-#             pass the name for the network interface after the channel list.
-#             Syntax:
-#               nethdlc=<channel list>[:interface name]
-#             Use original names, don't use the names which have been already registered 
-#             in system e.g eth.
-#
-# "dacs"    : The zaptel driver cross connects the channels starting at
-#             the channel number listed at the end, after a colon
-# "dacsrbs" : The zaptel driver cross connects the channels starting at
-#             the channel number listed at the end, after a colon and 
-#             also performs the DACSing of RBS bits
+# e&m::
+#   Channel(s) are signalled using E&M signalling (specific
+#   implementation, such as Immediate, Wink, or Feature Group D
+#   are handled by the userspace library).
+# fxsls:: 
+#   Channel(s) are signalled using FXS Loopstart protocol.
+# fxsgs:: 
+#   Channel(s) are signalled using FXS Groundstart protocol.
+# fxsks:: 
+#   Channel(s) are signalled using FXS Koolstart protocol.
+# fxols:: 
+#   Channel(s) are signalled using FXO Loopstart protocol.
+# fxogs:: 
+#   Channel(s) are signalled using FXO Groundstart protocol.
+# fxoks:: 
+#   Channel(s) are signalled using FXO Koolstart protocol.
+# sf:: 
+#   Channel(s) are signalled using in-band single freq tone. 
+#   Syntax as follows: 
+#    
+#     channel# => sf:<rxfreq>,<rxbw>,<rxflag>,<txfreq>,<txlevel>,<txflag>
+#   
+#   rxfreq is rx tone freq in hz, rxbw is rx notch (and decode)
+#   bandwith in hz (typically 10.0), rxflag is either 'normal' or
+#   'inverted', txfreq is tx tone freq in hz, txlevel is tx tone 
+#   level in dbm, txflag is either 'normal' or 'inverted'. Set 
+#   rxfreq or txfreq to 0.0 if that tone is not desired.
+#
+# unused:: 
+#   No signalling is performed, each channel in the list remains idle
+# clear::
+#   Channel(s) are bundled into a single span.  No conversion or
+#   signalling is performed, and raw data is available on the master.
+# bchan:: 
+#   Like 'clear' except all channels are treated individually and
+#   are not bundled.  'inclear' is an alias for this.
+# rawhdlc::
+#   The zaptel driver performs HDLC encoding and decoding on the 
+#   bundle, and the resulting data is communicated via the master
+#   device.
+<<<<<<< .working
+# dchan::
+#   The zapdel driver performs HDLC encoding and decoding on the
+#   bundle and also performs incoming and outgoing FCS insertion
+#   and verification.  'fcshdlc' is an alias for this.
+# hardhdlc::
+#   The hardware driver performs HDLC encoding and decoding on the
+#   bundle and also performs incoming and outgoing FCS insertion
+#   and verification.  Is subject to limitations and support of underlying
+#   hardware.
+# nethdlc::
+#   The zaptel driver bundles the channels together into an
+#   hdlc network device, which in turn can be configured with
+#   sethdlc (available separately). In 2.6.x kernels you can also optionally
+#   pass the name for the network interface after the channel list.
+#   Syntax:
+#   
+#     nethdlc=<channel list>[:interface name]
+#   Use original names, don't use the names which have been already registered 
+#   in system e.g eth.
+#
+# dacs::
+#   The zaptel driver cross connects the channels starting at
+#   the channel number listed at the end, after a colon
+# dacsrbs::
+#   The zaptel driver cross connects the channels starting at
+#   the channel number listed at the end, after a colon and 
+#   also performs the DACSing of RBS bits
 #
 # The channel list is a comma-separated list of channels or ranges, for
 # example:
 #
 #   1,3,5 (channels one, three, and five)
-#   16-23, 29 (channels 16 through 23, as well as channel 29
+#   16-23, 29 (channels 16 through 23, as well as channel 29)
 #
 # So, some complete examples are:
+#
 #   e&m=1-12
 #   nethdlc=13-24
 #   fxsls=25,26,27,28
@@ -145,6 +176,8 @@
 #dacs=1-24:48
 #dacsrbs=1-24:48
 #
+# Tone Zone Data
+# ~~~~~~~~~~~~~~
 # Finally, you can preload some tone zones, to prevent them from getting
 # overwritten by other users (if you allow non-root users to open /dev/zap/*
 # interfaces anyway.  Also this means they won't have to be loaded at runtime.
@@ -171,7 +204,8 @@ loadzone = us
 #loadzone=pl
 defaultzone=us
 #
-# Section for PCI Radio Interface 
+# PCI Radio Interface
+# ~~~~~~~~~~~~~~~~~~~
 # (see http://www.zapatatelephony.org/app_rpt.html)
 #
 # The PCI Radio Interface card interfaces up to 4 two-way radios (either
@@ -193,44 +227,52 @@ defaultzone=us
 # 
 # this example is a single tone DCS transmit and receive
 #
-# # specify the transmit tone (in DCS mode this stays constant)
-# tx=D371
-# # specify the receive DCS code
-# dcsrx=223
+# specify the transmit tone (in DCS mode this stays constant):
+#tx=D371
+#
+# specify the receive DCS code:
+#dcsrx=223
 #
 # this example is a "community" CTCSS (if you only want a single tone, then
 # only specify 1 in the ctcss list)
 #
-# # specify the default transmit tone (when not receiving)
-# tx=1000
-# # Specify the receive freq, the tag (use 0 if none), and the transmit code.
-# # The tag may be used by applications to determine classification of tones.
-# # The tones are to be specified in order of presedence, most important first.
-# # Currently, 15 tones may be specified..
-# ctcss=1318,1,1318
-# ctcss=1862,1,1862
+# specify the default transmit tone (when not receiving):
+#tx=1000
+#
+# Specify the receive freq, the tag (use 0 if none), and the transmit code.
+# The tag may be used by applications to determine classification of tones.
+# The tones are to be specified in order of presedence, most important first.
+# Currently, 15 tones may be specified..
+#
+#ctcss=1318,1,1318
+#ctcss=1862,1,1862
 #
 # The following parameters may be omitted if their default value is acceptible
 #
-# # set the receive debounce time in milliseconds
-# debouncetime=123
-# # set the transmit quiet dropoff burst time in milliseconds
-# bursttime=234
-# # set the COR level threshold (specified in tenths of millivolts)
-# # valid values are {3125,6250,9375,12500,15625,18750,21875,25000}
-# corthresh=12500
-# # Invert COR signal {y,n}
-# invertcor=y
-# # set the external tone mode; yes, no, internal {y,n,i}
-# exttone=y
+# Set the receive debounce time in milliseconds:
+#debouncetime=123
+#
+# set the transmit quiet dropoff burst time in milliseconds:
+#bursttime=234
+#
+# set the COR level threshold (specified in tenths of millivolts)
+# valid values are {3125,6250,9375,12500,15625,18750,21875,25000}
+#corthresh=12500
+#
+# Invert COR signal {y,n}
+#invertcor=y
+#
+# set the external tone mode; yes, no, internal {y,n,i}
+#exttone=y
 #
 # Now apply the configuration to the specified channels:
 #
-# # We are all done with our channel parameters, so now we specify what
-# # channels they apply to
-# channels=1-4
+# We are all done with our channel parameters, so now we specify what
+# channels they apply to
+#channels=1-4
 #
-# Overiding PCM encoding:
+# Overiding PCM encoding
+# ~~~~~~~~~~~~~~~~~~~~~~
 # Usually the channel driver sets the encoding of the PCM for the
 # channel (mulaw / alaw. That is: g711u or g711a). However there are
 # some cases where you would like to override that. 'mulaw' and 'alaw'