* Re-introduce the target install-include .

* programs and install-programs are now for all of userspace.
  Added the target 'utils'  for what 'programs' used to be.
* Document this.
* Document some other variations on 'make' and 'make install'.
* Improve documentation of /proc/zaptel .
* Ignoring some more utilities.


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

1 files changed, 79 insertions, 3 deletions

diff --git a/README b/README
index 50e18f3..c9c04d3 100644
--- a/README
+++ b/README
@@ -167,6 +167,63 @@ make install
 ----------------------------------
 
 
+Build Tweaks
+~~~~~~~~~~~~
+Extra Modules
+^^^^^^^^^^^^^
+To build extra modules / modules directory not included in the Zaptel 
+distribution, use the optional variables MODULES_EXTRA and
+SUBDIRS_EXTRA:
+
+  make MODULES_EXTRA="mod1 mod2 subdir1/ subdir2/"
+
+Note that those names are not guaranteed to continue to work on newer
+versions (in fact, it is slightly different on 1.4). Hopefully there will 
+be no need for such extra configuration.
+
+Partial Build/Install
+^^^^^^^^^^^^^^^~~~~~~
+There are some make targets that are provided to build or install just
+parts of Zaptel:
+
+. Build targets:
+  - make modules: build just the kernel modules.
+  - make programs: Build just the Zaptel userspace programs. partial 
+    targets of it:
+    * make 'utilname': builds 'utilname' alone (e.g: `make ztdiag`)
+    * make utils: Build libtonezone.
+    * make libs: Build libtonezone.
+. Install targets:
+  - make install-modules: install just kernel modules.
+  - make firmware: download and install firmwares for Digium cards
+  - make install-programs: Userspace: Partial targets of it are:
+    * make install-utils: install Zaptel userspace programs and
+      and basic support files.
+    * make install-libs: install libtonezone
+    * make install-include: install zaptel.h
+  - make config: should be run once to configure 
+
+Building to a Subtree
+^^^^^^^^^^^^^^^^^^^^^
+The following may be useful when testing the package or when preparing a
+package for a binary distribution (such as an rpm package) installing
+onto a subtree rather than on th real system. 
+
+  make install DESTDIR=targetdir
+
+This can be useful for any partial install target of the above (e.g:
+install-modules or install-programs).
+
+the targetdir must be an absolute path, at least if you install the
+modules. To install to a relative path you can use something like:
+
+  make install-modules DESTDIR=$PWD/target
+
+The 'install' target might fail if run as a user to a DESTDIR when
+attempting to generate device files. In that case, try:
+
+  make install DESTDIR=$PWD/target DYNFS=
+
 zaptel.conf
 ~~~~~~~~~~~
 The main method to configure Zaptel devices is using the utility
@@ -281,8 +338,8 @@ with 1). The number of the channel is the lowest unused one when it is
 generated, and ditto for spans.
 
 
-PROCFS Interface: /proc/zap
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+PROCFS Interface: /proc/zaptel
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 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
@@ -295,8 +352,27 @@ 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 title shows the span number and name, followed by any allarms the
+span may have: For example, here is the first span in my system (with no
+alarms):
+
+  Span 1: XBUS-00/XPD-00 "Xorcom XPD #0/0: FXS"
+
 The channel line for each channel shows its channel number, name and the
-actual signalling assigned to it through ztcfg.
+actual signalling assigned to it through ztcfg. Before being configured
+by ztcfg: This is Zaptel channel 2, whose name is 'XPP_FXS/0/0/1'.
+
+           2 XPP_FXS/0/0/1
+
+After being configured by ztcfg: the signalling 'FXOLS' was added. FXS
+channels have FXO signalling and vice versa:
+
+           2 XPP_FXS/0/0/1 FXOLS
+
+If the channel is in use (typically opened by Asterisk) then you will
+see an extra '(In use)':
+
+           2 XPP_FXS/0/0/1 FXOLS (In use)
 
 
 What is the license for the zaptel driver?