1madWiMAX: INSTALL
2
3These are the essential steps for compiling and installing this
4software.
5
6Prerequisites
7-------------
8
9 * Linux kernel with TUN/TAP support
10 * libusb-1.0 (http://libusb.wiki.sourceforge.net/Libusb1.0)
11 * asciidoc and docbook2x (for man pages)
12 * udev (optionally)
13
14Compiling
15---------
16
17If you are compiling from SCM you have to run
18   autoreconf --install
19first to create the 'configure' script.
20
21To compile the software run:
22   ./configure <options>
23   make
24
25You can get the list of configure options by running
26   ./configure --help
27
28Installing
29----------
30
31make install
32
33Udev rules
34----------
35
36By default, 'make install' puts an udev rules file to /etc/udev/rules.d
37directory if it is present. This file allows the driver to be started
38automatically if the device is plugged in. You can manually disable this
39feature by commenting out the appropriate lines in the rules file. Or even
40by supplying --without-udev option to the 'configure' script.
41
42Event scripts
43-------------
44
45madWiMAX uses user-supplied scripts to configure network. For example, to
46run DHCP client and configure iptables rules. madWiMAX comes with several
47scripts, optimized for some environments. They live in scripts/events. To
48select script event.sh.<name>.in to install pass --with-script=<name>
49option to 'configure' script. If you don't want to install any of the
50bundled scripts, pass --without-script.
51By default, 'generic' script is installed.
52