Some modumentation.

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

1 files changed, 51 insertions, 17 deletions

diff --git a/README b/README
index 3c2ecda..a425137 100644
--- a/README
+++ b/README
@@ -10,13 +10,13 @@ Supported Hardware
 Digital Cards
 ~~~~~~~~~~~~~
 - wct4xxp: 
-  - Digium newer quad-span T1/E1/J1 cards: Wildcard TE420P/TE410P/TE405P 
-  - Digium newer dual-span T1/E1/J1 cards: Wildcard TE220P/TE210P/TE205P 
+  * Digium newer quad-span T1/E1/J1 cards: Wildcard TE420P/TE410P/TE405P 
+  * Digium newer dual-span T1/E1/J1 cards: Wildcard TE220P/TE210P/TE205P 
 - wcte12xp: Digium Wildcard TE120P and the TE122P single-span T1/E1/J1 card
 - wcte11xp: Digium Wildcard TE110P T1/E1/J1
 - wct1xxp: 
-  - Wildcard T100P (old single-span T1)
-  - Wildcard E100P (old single-span E1)
+  * Wildcard T100P (old single-span T1)
+  * Wildcard E100P (old single-span E1)
 - tor2: Tormenta quad-span T1/E1 card from the Zapata Telephony project
 - torisa: The old dual-span ISA T1 card from Zapata Telephony
 
@@ -24,8 +24,8 @@ Digital Cards
 Analog Cards
 ~~~~~~~~~~~~
 - wctdm24xxp: 
-  - Digium TDM2400P card: up to 24 analog ports
-  - Digium TDM800P card: up to 8 analog ports
+  * Digium TDM2400P card: up to 24 analog ports
+  * Digium TDM800P card: up to 8 analog ports
 - wctdm: Digium TDM400P card: up to 4 analog ports
 - xpp: Xorcom Astribank: a USB connected unit of up to 32 ports
   (also BRI)
@@ -227,6 +227,9 @@ attempting to generate device files. In that case, try:
 
   make install DESTDIR=$PWD/target DYNFS=
 
+
+Configuration
+-------------
 zaptel.conf
 ~~~~~~~~~~~
 The main method to configure Zaptel devices is using the utility
@@ -239,6 +242,22 @@ configuration. Alternatively use the script genzaptelconf to generate
 one that should work with your system.
 
 
+sysconfig/default
+~~~~~~~~~~~~~~~~~
+The configuration file of the zaptel init.d script is either
+/etc/default/zaptel (Debian systems) or /etc/sysconfig/zaptel (most
+others). That file is used to override defaults that are set at the
+beginning of the init.d script.
+
+For instance, to define for the init.d script to load the modules wctdm
+and xpp_usb (in that order) add the following line to that file:
+
+  MODULES="wctdm xpp_usb"
+
+Currently that file must set "TELEPHONY=yes" for the zaptel init.d to
+work.
+
+
 Zaptel PERL modules
 -------------------
 The directory xpp/utils has, in addition to helper utilities for the
@@ -262,14 +281,30 @@ To get usage information on a program, you can also use perldoc
 (sometimes provided in a package separate from perl itself). For
 instance:
 
-  perldoc ./xpp/utils/xpp_blink
+  perldoc ./xpp/utils/lszaptel
+
+Some of them are specific for the Xorcom Astribank and described in its
+docuemntation. the others are:
 
-zapconf is currently experimental and intended to eventually replace
-genzaptelconf by a more maintainable code.
+lszaptel:: 
+  A somewhat glorified `cat /proc/zaptel/*`.
+zapconf:: 
+  An currently experimental and intended to eventually replace
+  genzaptelconf by a more maintainable code.
+zaptel_drivers::
+  A two-liner script (not installed by default) that simply returns the
+  modules that should be modprobed on this system.
+zaptel_hardware:: 
+  Uses the information from sysfs and its own knowledge to show
+  what PCI/USB Zaptel hardware is connected and if it is currently used
+  by a driver. Shows also some more information for Astrobanks from
+  /proc/xpp .
 
 
+Internals
+---------
 Zaptel Device Files
--------------------
+~~~~~~~~~~~~~~~~~~~
 Userspace programs will usually interact with Zaptel through device
 files under the /dev/zap directory (pedantically: characted device files 
 with major number 196) . Those device files can be generated statically
@@ -293,7 +328,7 @@ or dynamically through the udev system.
 
 
 Zaptel Timing
--------------
+~~~~~~~~~~~~~
 A PBX system should generally have a single clock. If you are connected
 to a telephony provider via a digital interface (e.g: E1, T1) you should
 also typically use the provider's clock (as you get through the
@@ -333,7 +368,7 @@ description. Or even run:
 
 
 Spans and Channels
-------------------
+~~~~~~~~~~~~~~~~~~
 Zaptel provides telephony *channels* to the userspace applications. 
 Those channels are channels are incoreperated into logical units called
 *spans*.
@@ -383,7 +418,6 @@ see an extra '(In use)':
 
            2 XPP_FXS/0/0/1 FXOLS (In use)
 
-[[ppp]]
 PPP Support
 -----------
 Zaptel digital cards can provide data channels through ppp as
@@ -428,7 +462,7 @@ Yes, the Asterisk Open Source PBX does. http://www.asterisk.org
 
 Links
 -----
-- http://asterisk.org/ - The Asterisk PBX
-- http://voip-info.org/
-- http://voip-info.org/wiki/view/Asterisk+Zaptel+Installation
-- http://www.zapatatelephony.org/ - A historical site.
+- http://asterisk.org/[] - The Asterisk PBX
+- http://voip-info.org/[]
+- http://voip-info.org/wiki/view/Asterisk+Zaptel+Installation[]
+- http://www.zapatatelephony.org/[] - A historical site.