[dahdi-commits] kpfleming: linux/trunk r4724 - /linux/trunk/README

SVN commits to the DAHDI project dahdi-commits at lists.digium.com
Wed Aug 6 17:09:22 CDT 2008 

Author: kpfleming
Date: Wed Aug  6 17:09:22 2008
New Revision: 4724

URL: http://svn.digium.com/view/dahdi?view=rev&rev=4724
Log:
major cleanup, remove userspace tools references

Modified:
    linux/trunk/README

Modified: linux/trunk/README
URL: http://svn.digium.com/view/dahdi/linux/trunk/README?view=diff&rev=4724&r1=4723&r2=4724
==============================================================================
--- linux/trunk/README (original)
+++ linux/trunk/README Wed Aug  6 17:09:22 2008
@@ -27,7 +27,6 @@
   * Digium E100P: PCI single-port E1
 - tor2: Tormenta quad-span T1/E1 card from the Zapata Telephony project
 
-
 Analog Cards
 ~~~~~~~~~~~~
 - wctdm24xxp: 
@@ -40,7 +39,6 @@
   (including the digital BRI and E1/T1 modules)
 - wcfxo: X100P, similar and clones. A simple single-port FXO card
 
-
 Other Drivers
 ~~~~~~~~~~~~~
 - pciradio: Zapata Telephony PCI Quad Radio Interface
@@ -49,79 +47,21 @@
 - dahdi_dynamic_loc: Mirror a local span. Requires dahdi_dynamic
 - dahdi_dummy: A dummy driver that only provides a DAHDI timing source.
 
-
-Build Requirements
-------------------
-This package needs the headers from dahdi-linux. Thus you should install
-dahdi-linux before building dahdi-tools.
-
-The script install_prereq should help you install the
-required packages. To see what it suggests, run:
-
-  ./install_prereq test
-
-You can either copy/paste that code to a terminal to run it, or just
-run:
-
-  ./install_prereq install
-
-
-A Build System
+Build System
 ~~~~~~~~~~~~~~
 gcc and friends. Generally you will need to install the package gcc.
 There may be cases where you will need a specific version of gcc to build
 kernel modules.
 
-
-Extra Libraries
-~~~~~~~~~~~~~~~
-Some libraries are needed for extra utilities that are provided with
-DAHDI.
-
-- libusb is needed for building fpga_load, needed for firmware loading of
-  the Xorcom Astribank.
-- libnewt is needed to build the optional but useful utility dahdi_tool.
-
-
-Distribution-Specific Instructions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-TO BE WRITTEN
-
-
 Installation
-------------
+~~~~~~~~~~~~
 Note: If using `sudo` to build/install, you may need to add /sbin to your PATH.
 ----------------------------------
-./configure
-# optional step: select custom configuration:
-#make menuconfig
-make
-make install
-# To install init scripts and config files:
-#make config
-----------------------------------
-
-
-Build Tweaks
-~~~~~~~~~~~~
-Partial Build/Install
-^^^^^^^^^^^^^^^^^^^^^
-There are some make targets that are provided to build or install just
-parts of DAHDI:
-
-. Build targets:
-  - make: Build DAHDI userspace programs. partial 
-    targets of it:
-    * make 'utilname': builds 'utilname' alone (e.g: `make dahdi_diag`)
-    * make utils: Build libtonezone.
-    * make libs: Build libtonezone.
-. Install targets:
-  - make install: Installs user space tools into /usr/sbin/ (TODO - list
-    partial targets)
-  - make config: should be run once to configure 
+# make
+# make install
 
 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. 
@@ -141,30 +81,8 @@
 
   make install DESTDIR=$PWD/target DYNFS=
 
-
-./configure Options
-^^^^^^^^^^^^^^^^^^^
-The configure script various several tests and based on them generates
-some files ( build_tools/menuselect-deps and makeopts). You can pass it
---with options and variable settings, for instance:
-
-  ./configure --without-ncurses CC="gcc-4.10"
-
-If you just want to recreate the same files without a full detection
-run, use:
-
-  ./config.status
-
-To re-run ./configure with the same parameters it was run with last
-time, use:
-
-  ./ocnfig.status --recheck
-
-TODO: building with a local copy of DAHDI?
-
-
 Configuration
--------------
+~~~~~~~~~~~~~
 Configuration for DAHDI resides under /etc/dahdi . 
 
 /etc/dahdi/system.conf
@@ -179,13 +97,11 @@
 use the script dahdi_genconf to generate one that should work with your 
 system.
 
-
 /etc/dahdi/init.conf
 ~~~~~~~~~~~~~~~~~~~~
 The configuration file of the dahdi init.d script is
 /etc/dahdi/init.conf . That file is used to override defaults that are 
 set at the beginning of the init.d script.
-
 
 Module Parameters
 ~~~~~~~~~~~~~~~~~
@@ -271,67 +187,6 @@
 value of the module. You can find a list of useful xpp module parameters
 in README.Astribank .
 
-
-Reference Configuration
------------------------
-Sample system.conf
-~~~~~~~~~~~~~~~~~~
-include::system.conf.asciidoc[]
-
-
-Sample init.conf
-~~~~~~~~~~~~~~~~
-include::init.conf.asciidoc[]
-
-
-Tonezones
-~~~~~~~~~
-The file zonedata.c contains the information about the tone zones used
-in libtonezone (and hence also in ztcfg). Here is a list of those zones:
-
-include::tonezones.txt[]
-
-
-DAHDI PERL modules
--------------------
-The directory xpp has, in addition to helper utilities for the
-Xorcom Astribank, a collection of perl modules to provide information
-related to DAHDI. The perl modules themselves are under xpp/perl_modules/ .
-In xpp/ there are several utilities that use those modules:
-- xpp-specific: dahdi_registration, xpp_sync, xpp_blink .
-- General: lsdahdi, dahdi_genconf, dahdi_hardware, dahdi_drivers
-
-The DAHDI perl modules will currently only be automatically installed if you
-happen to install the xpp directory. Those utilities require the perl modules 
-to be installed, however they will also look for them in the directory 
-perl_modules, and thus can be run directly from the DAHDI source tree. For 
-example:
-
-  ./xpp/dahdi_hardware -v
-
-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/lsdahdi
-
-Some of them are specific for the Xorcom Astribank and described in its
-docuemntation. the others are:
-
-lsdahdi:: 
-  A somewhat glorified `cat /proc/dahdi/*`.
-dahdi_genconf::
-  Generates configuration based on the existing DAHDI channels and on
-  /etc/dahdi/genconf_parameters (replaces genzaptelconf as well).
-dahdi_drivers::
-  A two-liner script (not installed by default) that simply returns the
-  modules that should be modprobed on this system.
-dahdi_hardware:: 
-  Uses the information from sysfs and its own knowledge to show
-  what PCI/USB DAHDI hardware is connected and if it is currently used
-  by a driver. Shows also some more information for Astribanks from
-  /proc/xpp .
-
 Internals
 ---------
 DAHDI Device Files
@@ -357,7 +212,6 @@
   DAHDI recieves no data in it, and only sends garbage data with the
   same timing as the DAHDI timing master device.
 
-
 DAHDI Timing
 ~~~~~~~~~~~~~
 A PBX system should generally have a single clock. If you are connected to a
@@ -394,7 +248,6 @@
 
   strings dahdi.ko | grep source:
 
-
 Spans and Channels
 ~~~~~~~~~~~~~~~~~~
 DAHDI provides telephony *channels* to the userspace applications. 
@@ -408,7 +261,6 @@
 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/dahdi
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -444,7 +296,6 @@
 see an extra '(In use)':
 
            2 XPP_FXS/0/0/1 FXOLS (In use)
-
 
 ABI Compatibility
 ~~~~~~~~~~~~~~~~~
@@ -512,27 +363,6 @@
 slightly confusing in the code, but it is useful for writing code that works
 with all versions of DAHDI. 
 
-
-PPP Support
------------
-DAHDI digital cards can provide data channels through ppp as
-point-to-point connections. This requires a plugin to the ppp daemon
-that is included in the ppp/ subdirectory. To install it:
-
-1. Make sure you have the PPP source / headers installed. On Debian:
-
-   apt-get install ppp-dev
-
-2. Run 'make' on the ppp subdirectory:
-
-   make -C ppp 
-   make -C ppp install
-
-3. Make sure your kernel has support for both PPP (which is common is
-   distribution kernels and for HDLC (much less common) - CONFIG_PPP and
-   CONFIG_HDLC .
-
-
 License
 -------
 This package is distributed under the terms of the GNU General Public License
@@ -545,12 +375,10 @@
 more flexible terms can be readily obtained through Digium, Inc. at reasonable
 cost.
 
-
 Reporting Bugs
 --------------
-Please report bug and patches to the Asterisk.org bug tracker at
+Please report bug and patches to the Asterisk bug tracker at
 http://bugs.digium.com in the "DAHDI" category.
-
 
 Links
 -----

More information about the dahdi-commits mailing list