Added sample rpld.conf file to load gPXE
[rpld.git] / INSTALL
1 ***********************************************************
2 RPLD comes with no warranty not even an implied warranty.
3
4 By using rpld, you agree to the terms and conditions set
5 forth in the LICENCE file which can be found at the top level of
6 the rpld distribution.
7 ***********************************************************
8
9 Compilation:
10         Currently rpld is known to compile on the following platforms
11         
12         Linux 2.0.x (*)
13         Linux 2.1.x (*)
14         Linux 2.2.x
15         Linux 2.3.x
16         Linux 2.4.0-prex
17         NetBSD
18
19 (*)     You will get a console message saying "can't find module net-pf-17"
20         which you can ignore.
21
22         rpld ships by default with a resonably efficent driver for 2.2 and
23         above. It also comes with old drivers for 2.0 and 2.1, and a driver
24         for kernels with native llc support. The non native drivers consist
25         of a nit (which listens for packets on the network) and llc-nit.c
26         which implements an LLC 802.2 layer. If you want to change from the
27         default, you need to edit the makefile an recompile.
28
29         For NetBSD rpld ships with a simple bpf driver which passes every 
30         packed up to llc-nit.c so is fairly inefficient.
31         
32         A native llc support patche for linux 2.2 kernels can be found
33         in kernel, for 2.3 and 2.4 use the linux-sna package available
34         from www.linux-sna.org.
35
36         To compile rpld, you MUST DO "make depend" and then "make".
37         To compile the utilities/patches/fixes for the ever burgeoning list of
38         network cards type "make nics", you will need a recent version of the
39         bin86 package. I suggest you use the one from the ELKS project.
40
41 Installation:
42
43         install rpld in you system binaries directory, and copy 
44         /etc/rpld.conf.sample to /etc/rpld.conf and edit it.
45
46         run rpld somewhere in your init scripts.
47
48 Trouble shooting:
49         
50         You can try running ana (in this directory). The synopis is
51         ana [interface name]
52         even if the output makes no sense to you it will help people
53         who understand more to quickly find the problem.
54
55