XPP documentation fixes.

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

3 files changed, 48 insertions, 34 deletions

diff --git a/xpp/README.Astribank b/xpp/README.Astribank
index 5cf6804..af43eb1 100644
--- a/xpp/README.Astribank
+++ b/xpp/README.Astribank
@@ -1312,21 +1312,22 @@ rx_tasklet (xpp)::
 
 debug (all modules)::
   It will make the driver to print tons of debugging messages. You can 
-  set/unset the parameter at run-time.
-
-  The parameter value is a bitmask of several values. The different bits 
-  meaning as it defined in xpp/zap_debug.h: 
+  set/unset the parameter at run-time. The parameter value is a bitmask 
+  of several values. The different bits  meaning as it defined in 
+  xpp/zap_debug.h: 
 
   * 0  - Disable debug messages
   * 1  - GENERAL - General debug comments.
-  * 2  - PCM - PCM-related messages. Tend to flood logs.
+  * 2  - PCM - PCM-related messages. Tends to flood logs.
   * 4  - LEDS - Anything related to the LEDs status control. The driver
          produces a lot of messages when the option is enabled.
   * 8  - SYNC - Synchronization related messages.
   * 16 - SIGNAL - Zaptel signalling related messages.
-  * 32 - PROC - procfs interface related messages.
-  * 64 - REGS - Reading and writing to chip registers. The driver produces
-         a lot of messages when the option is enabled.
+  * 32 - PROC - Messages related to the procfs interface.
+  * 64 - REGS - Reading and writing to chip registers. Tends to flood
+  	 logs.
+  * 128 - DEVICES - Device instantiation, destruction and such.
+  * 256 - COMMANDS - Protocol commands. Tends to flood logs.
 
   For example,
 
@@ -1344,24 +1345,22 @@ vmwineon (xpd_fxs)::
 
 usb1 (xpp_usb)::
   Enable (1) or disable (0) support of USB1 devices. Disabled by default.
-  +
-  +
+
   USB1 devices are not well-tested. It seems that they don't work at all
   for Astribank BRI. Generally they should work with the current code, but
-  we expect the voice quality issues. Hence we would like to make it very clear that
-  you if you have a USB1 port (rather than a USB2 one, as recommended) you
-  will have to take an action to enable the device.
+  we expect the voice quality issues. Hence we would like to make it
+  very clear that you if you have a USB1 port (rather than a USB2 one, as 
+  recommended) you will have to take an action to enable the device.
 
 poll intervals (various)::
   There are various values which the driver occasionally polls the device
   for. For instance, the parameter poll_battery_interval for xpd_fxo
-  to poll the battery (in order to know if the telco line is actually
-  connected.)
-  +
-  +
-  The value of those parameters is typically a number in milliseconds or 0
-  to disable. Under normal operation there should be no reason to play
-  with those parameters.
+  to poll the battery, in order to know if the telco line is actually
+  connected.
+
+  The value of those parameters is typically a number in milliseconds. 
+  0 is used to disable polling. Under normal operation there should be 
+  no reason to play with those parameters.
 
 dtmf_detection (xpd_fxs)::
   Enable (1) or disable (0) support of hardware DTMF detection by the 
diff --git a/xpp/utils/xpp_blink b/xpp/utils/xpp_blink
index bf68d80..7d0d845 100755
--- a/xpp/utils/xpp_blink
+++ b/xpp/utils/xpp_blink
@@ -112,30 +112,45 @@ Blink all the leds of an XPD.
 
 =head2 Blink mode:
 
-=over 16
+=over
 
-=item on	Turn on constant blink
+=item on
 
-=item off	Turn off blink
+Turn on constant blink
 
-=item bzzt	Blink briefly for 1 second.
+=item off
+
+Turn off blink
+
+=item bzzt
+
+Blink briefly for 1 second.
 
 =back
 
 =head2 Selector:
 
-=over 16
+=over
+
+=item span	
+
+Select by span number. This only work for XPD registered to zaptel.
+		
+will also print the zaptel channels of the span and the xbus/xpd this 
+span represents.
+
+=item chan
+
+Select by channel number. This only work for XPD registered to zaptel.
 
-=item span	Select by span number. This only work for XPD registered to zaptel.
-		will also print the zaptel channels of the span and the
-		xbus/xpd this span represents.
+=item xpd
 
-=item chan	Select by channel number. This only work for XPD registered to zaptel.
+Select by xbus + xpd numbers. If only xbus number is given, all the
+XPDs of the selected xbus (Astribank) are blinked.
 
-=item xpd	Select by xbus + xpd numbers. If only xbus number is given, all the
-		XPDs of the selected xbus (Astribank) are blinked.
+=item label
 
-=item label	Select by xbus label. Affect the whole Astribank.
+Select by xbus label. Affect the whole Astribank.
 
 =back
 
@@ -150,4 +165,4 @@ Blink all the leds of an XPD.
 
   $ xpp_blink off xpd 0
 
-  $ xpp_blink bzzt label 'usb:QA-02'
+  $ xpp_blink bzzt label 'usb:00000238'
diff --git a/xpp/zap_debug.h b/xpp/zap_debug.h
index bc386f9..79aefdf 100644
--- a/xpp/zap_debug.h
+++ b/xpp/zap_debug.h
@@ -86,7 +86,7 @@
 #define	DBG_SIGNAL	BIT(4)
 #define	DBG_PROC	BIT(5)
 #define	DBG_REGS	BIT(6)
-#define	DBG_DEVICES	BIT(7)	/* instanciation/destruction etc. */
+#define	DBG_DEVICES	BIT(7)	/* instantiation/destruction etc. */
 #define	DBG_COMMANDS	BIT(8)	/* All commands */
 #define	DBG_ANY		(~0)