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