====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
doc [2006/08/16 05:34] mdc |
doc [2010/06/09 14:08] (current) kylek not sure if this is proper place for it but what the heck |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Documentation for Etherboot users ===== | + | ====== Documentation for gPXE ====== |
| + | ===== General Documentation ===== | ||
| - | ==== General EtherBoot information==== | + | * [[gpxe_imagetypes|gPXE Image types]]: explanation on types of images cranked out by make or r-o-m |
| - | * [[scenario|Introduction: A typical network boot scenario]], including explanations for new users | + | ===== Source Code Documentation ===== |
| + | Many parts of the gPXE code-base include commenting for use with the Doxygen system. To build this documentation for browsing, go into gPXE src/ directory and do | ||
| + | make doc | ||
| + | You will then have the documentation available in your gpxe/src/bin/doc/ directory. | ||
| + | |||
| + | A sample build is available [[http://etherboot.org/api/modules.html|here]]. | ||
| + | |||
| + | ====== Documentation for Etherboot ====== | ||
| + | |||
| + | ===== General EtherBoot Information===== | ||
| + | * [[scenario|Introduction]]: A typical network boot scenario, including explanations for new users | ||
| * [[troubleshooting|Troubleshooting FAQ]] | * [[troubleshooting|Troubleshooting FAQ]] | ||
| * [[eb_imagetypes|EtherBoot image types explanation]] | * [[eb_imagetypes|EtherBoot image types explanation]] | ||
| - | |||
| * [[filename_specification|How to specify which boot file to load]] | * [[filename_specification|How to specify which boot file to load]] | ||
| + | * [[commandline|gPXE command line reference]] | ||
| - | ==== Putting Etherboot into ROM chips or Motherboard BIOS ==== | + | ===== Putting Etherboot into ROM Chips or Motherboard BIOS ===== |
| * [[burningroms|Burning ROM chips]] | * [[burningroms|Burning ROM chips]] | ||
| Line 16: | Line 27: | ||
| * [[biosmodule|Putting EtherBoot into your BIOS]] | * [[biosmodule|Putting EtherBoot into your BIOS]] | ||
| - | ==== Various Booting Configurations === | + | ===== Various Booting Configurations ===== |
| - | === EtherBoot in virtual machines / EtherBoot in emulators === | + | ==== Linux Related ==== |
| - | == VMWARE == | + | * [[lilowithetherboot|Using LILO with EtherBoot]] |
| + | * [[http://syslinux.zytor.com|PXELINUX]] | ||
| + | |||
| + | ==== Etherboot as a PXE Boot ROM ==== | ||
| + | |||
| + | * [[pxe|Using EtherBoot as a PXE boot rom]] | ||
| + | * [[pxe2ndstage|Using EtherBoot as a PXE 2nd-stage-loader]] | ||
| + | |||
| + | ==== Virtual Machine / Emulator Usage ==== | ||
| * [[vmware|How to use EtherBoot in a VMware virtual machine]] | * [[vmware|How to use EtherBoot in a VMware virtual machine]] | ||
| - | * [[vmwarebios|How to use EtherBoot as ROM in the VMware BIOS / EtherBoot ROM in VMware's and Bochs' network cards]] | + | * [[vmwarebios|How to use EtherBoot as ROM in the VMware BIOS / EtherBoot ROM in VMware and Bochs network cards]] |
| * [[bochs|How to use EtherBoot with Bochs]] | * [[bochs|How to use EtherBoot with Bochs]] | ||
| + | * [[qemu|How to use gPXE with QEMU]] | ||
| - | == MEMDISK == | + | ==== MEMDISK ==== |
| - | * [[bootingmemdisk|Booting Memdisk]] | + | * [[bootingmemdisk|Booting Memdisk]] |
| - | * [[disklessdos|Diskless MS-DOS (and compatibles)]] | + | * [[disklessdos|Diskless MS-DOS (and compatibles)]] |
| - | * [[disklesswin98|Diskless Windows 98]] | + | * [[disklesswin98|Diskless Windows 98]] |
| - | == Windows == | + | ==== Windows Related ==== |
| - | * [[windowsntloader|Loading EtherBoot from a Windows 2000/XP NT loader]] | + | * [[windowsntloader|Loading EtherBoot from a Windows 2000/XP NT loader]] |
| - | * [[msris|Using EtherBoot with Microsofts Remote Installation Services (RIS)]] | + | * [[msris|Using EtherBoot with Microsofts Remote Installation Services (RIS)]] |
| - | * [[lilowithetherboot|Using LILO with EtherBoot]] | + | |
| - | * [[freebsd|Booting FreeBSD]] | + | |
| - | == Etherboot as a PXE Boot ROM == | + | ==== FreeBSD ==== |
| - | * [[pxe|Using EtherBoot as a PXE boot rom]] | + | * [[freebsd|Booting FreeBSD]] |
| - | * [[pxe2ndstage|Using EtherBoot as a PXE 2nd-stage-loader]] | + | |
| - | ==== Miscellaneous Topics ==== | + | |
| + | ===== Miscellaneous Topics ===== | ||
| * [[aoe|ATA-over-Ethernet (experimental)]] | * [[aoe|ATA-over-Ethernet (experimental)]] | ||
| Line 50: | Line 68: | ||
| * [[multicast|Multicast protocol support (slam/tftp-multicast)]] | * [[multicast|Multicast protocol support (slam/tftp-multicast)]] | ||
| * [[safebootmode|Experimental SafeBootMode cryptographic boot image check]] | * [[safebootmode|Experimental SafeBootMode cryptographic boot image check]] | ||
| + | * [[romdumping|Dumping PCI expansion ROMs]] | ||
| + | |||
| + | ==== Using the "mknbi" Utility with Etherboot ==== | ||
| - | == Preparing Etherboot Network Bootable Images with mknbi for Etherboot == | + | Network Bootable Image format (NBI) is a legacy format that wraps operating system images (such as Linux kernels) in a wrapper, which makes it possible for Etherboot to load the images directly. The "mknbi" (make NBI) utility performs the wrapping operation. |
| - | NBI or Network Boot Image format is a legacy format which wraps operating system images (such as Linux Kernels) in a wrapper, which makes it possible for Etherboot ot load the images directly. This is not needed for PXE and PXELINUX booting, and is not recommended for new users. | + | === NBI, Etherboot and Linux 2.6 === |
| + | Unfortunately, mknbi cannot be used to make a NBI of a Linux 2.6 (or newer) kernel image. If you are tied to Etherboot but need to boot a Linux 2.6 or newer kernel, wraplinux must be used to create a working NBI. Follow the link to [[http://www.kernel.org/pub/linux/utils/boot/wraplinux|wraplinux]] on kernel.org to download it. | ||
| - | For new users, we recommend using [[http://syslinux.zytor.com|PXELINUX]] | + | **Note:** This is not needed for PXE and PXELINUX booting, and is not recommended for new users. For new users, we recommend using [[http://syslinux.zytor.com|PXELINUX]] |
| + | For those who need to use the NBI format, please see: | ||
| * [[mknbi|mknbi utility description and manpage]] | * [[mknbi|mknbi utility description and manpage]] | ||
| - | ==== Developer information ==== | ||
| - | * [[dev:todo|ToDo-List]] | + | ===== Developer Information ===== |
| - | * [[dev:devmanual|Developers' manual]] | + | === Driver APIs === |
| + | * [[dev:netdriverapi|gPXE Network Driver API]] | ||
| + | * [[:soc:2008:mdeck:notes:gpxe_driver_api|PCI, network driver, and non-volatile storage APIs]] | ||
| + | === Debugging === | ||
| + | * [[dev:gdbstub|GDB remote debugging]] | ||
| + | * [[dev:prefixdebugging|Prefix debugging]] | ||
| + | * [[dev:fnrec|Function recorder for crash/hang debugging]] | ||
| + | === Old stuff === | ||
| + | * [[dev:devmanual|A somewhat dated Etherboot Developers' manual]] (does not cover recent versions of Etherboot, or gPXE) | ||
| + | * [[dev:todo|A Developer To-Do List]] | ||
