[svn-inject] Applying Debian modifications (1:0.9.4+r4100.20090929-0.1) to trunk
[debian/madwifi.git] / debian / madwifi-source.README.debian
1 madwifi for Debian
2 ==================
3
4 This package provides the madwifi source code and binaries that can be used to
5 build modules that work with your custom built linux kernel. The source files 
6 are located in /usr/src/madwifi.tar.bz2; unpacking that file in /usr/src will
7 produce a build tree in /usr/src/modules/madwifi/ (The tar file can also be 
8 unpacked elsewhere).
9
10 For users of the madwifi debian packages from http://debian.marlow.dk/, there
11 is no guarentee that the upgrade process will be smooth. Please purge all
12 pre-existing madwifi packages from your system before attempting to build and
13 install your own modules with madwifi-source.
14
15
16 Building madwifi kernel modules with module-assistant
17 =====================================================
18
19 Please install the module-assistant package and issue the following commands:-
20
21   $ m-a prepare
22   $ m-a a-i madwifi
23
24 The above commands will prepare, compile, package and install a set of madwifi
25 modules for your kernel.
26
27 m-a is short for module-assistant, and a-i is short for auto-install. Please
28 see the module-assistant documentation for further details.
29
30
31 Building madwifi kernel modules with kernel-package
32 ===================================================
33
34 If necessary, prepare the kernel source tree for the target kernel. If you are 
35 using a self compiled kernel than you have an easy task! 
36
37   $ cd /usr/src 
38   $ tar jxvf madwifi.tar.bz2
39   $ cd linux-$KVERS
40   $ make-kpkg --added-modules madwifi modules
41
42 Where $KVERS is the exact version string of the kernel you want to build madwifi
43 for. A madwifi-modules package will be built against the kernel source version
44 specified. Look at the output for where the madwifi-modules package is located. 
45 Then use dpkg to install the module package by hand, eg:-
46
47   $ dpkg -i /usr/src/madwifi-modules-$KVERS.deb
48
49
50 MadWifi Documentation
51 =====================
52
53 The madwifi developers maintain an excellent resource:
54
55         http://madwifi.org/
56
57 The Hardware Compatibility List (HCL) may be of interest:
58
59         http://madwifi.org/wiki/Compatibility