* Enable zaptel-perl and use perl utilities for Astribank init (from 1.2 r2710)

* Update README accordingly.
* Continue documenting Zaptel, while we're updating the README.
* Ignore the generated README.html.


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

1 files changed, 43 insertions, 16 deletions

diff --git a/README b/README
index 00dfa31..fbcae3e 100644
--- a/README
+++ b/README
@@ -148,15 +148,16 @@ At this point you should probably reboot to get the new kernel in effect.
 
 Installation
 ------------
-
-  ./configure
-  # optional step: select custom configuration:
-  #make menuconfig
-  # optional step: enable zaptel-perl
-  make
-  make install
-  # To install init scripts and config files:
-  #make config
+----------------------------------
+./configure
+# optional step: select custom configuration:
+#make menuconfig
+# optional step: enable zaptel-perl
+make
+make install
+# To install init scripts and config files:
+#make config
+----------------------------------
 
 
 Zaptel PERL modules
@@ -174,13 +175,6 @@ directly from the zaptel source tree. For example:
 
   ./xpp/utils/zaptel_hardware
 
-The modules and utilities are not installed by default in this version
-of zaptel . In order to get them installed, you need do the following
-before running 'make install': remove the '#' in the line that sets 
-PERLLIBDIR in xpp/utils/Makefile . This can be done by e.g.:
-
-  sed -i -e 's/^#\(PERLLIBDIR\)/\1/' xpp/utils/Makefile
-
 To get usage information on a program, you can also use perldoc
 (sometimes provided in a package separate from perl itself). For
 instance:
@@ -246,6 +240,39 @@ of how close it was. Also try running it with the option -v for a
 verbose output.
 
 
+Spans and Channels
+------------------
+Zaptel provides telephony *channels* to the userspace applications. 
+Those channels are channels are incoreperated into logical units called
+*spans*.
+
+With digital telephony adapters (e.g: E1 or T1), a span normally 
+represents a single port. With analog telephony a span typically
+represents a PCI adapter or a similar logical unit.
+
+Both channels and spans are identified by enumerating numbers (beginning
+with 1). The number of the channel is the lowest unused one when it is
+generated, and ditto for spans.
+
+
+PROCFS Interface: /proc/zap
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A simple way to get the current list of spans and channels each span
+contains is the files under /proc/zaptel . /proc/zaptel is generated by
+zaptel as it loads. As each span registers to Zaptel, a file under
+/proc/zaptel is created for it. The name of that file is the number of
+that span.
+
+Each file has a 1-line title for the span followed by an empty line and
+then a line for each channel of the span. 
+
+The title line shows the number of the span, its name and title, and 
+(potentially) the alarms in which it is.
+
+The channel line for each channel shows its channel number, name and the
+actual signalling assigned to it through ztcfg.
+
+
 What is the license for the zaptel driver?
 ------------------------------------------
 libpri is distributed under the terms of the GNU General Public License,