iPXE - Open Source Boot Firmware

[config] Make PXE stack a compile-time option
[ipxe.git] / README
1 gPXE README File
2
3 gPXE is an implementation of the PXE specification for network
4 booting, with extensions to allow additional features such as booting
5 via HTTP, iSCSI, and AoE.  
6
7 In generally, gPXE is compatible with the industry-standard PXE
8 specification, and also supports Etherboot .nbi file loading and some
9 additional protocols and features.
10
11 For more detailed information about gPXE, please visit our project
12 website at: http://etherboot.org/
13
14 BUILDING gPXE IMAGE FROM SOURCE
15
16 If you don't want to install development tools, and have access to the
17 Web, you can get gPXE and Etherboot ROM images made on demand from
18 http://rom-o-matic.net/
19
20 If you would like to compile gPXE images from source, here are some tips.
21
22 We normally compile gPXE images on x86, 32-bit Linux machines. It is
23 possible to also use x86-64 machines. We use gcc compiler options to
24 create 32-bit output.
25
26 It is important to have the necessary software  packages installed.  A gcc-based
27 toolchain is required.
28
29 The following packages (at least) are required:
30
31   - a gcc tool chain (gcc 3.x or gcc 4.x)
32   - binutils
33   - perl
34   - syslinux
35   - mtools
36   
37 To test your environment, cd to the "src" directory and type:
38
39    make
40
41 You should see a lot of output, and when it stops, the "bin" directory
42 should be populated with gPXE images and object files.
43
44 To learn more about what to build and how to use gPXE, please visit our
45 project website at http://etherboot.org/ , particularly the "howto" section.
46
47 CONTACTING US
48
49 Pointers to our project mailing lists are on http://etherboot.org/
50
51 Real-time help is often available on IRC on the #etherboot channel of
52 irc.freenode.net.
53