1.\" Copyright (c) 1999 Doug White 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd May 1, 2000 28.Dt PXEBOOT 8 29.Os 30.Sh NAME 31.Nm pxeboot 32.Nd Preboot Execution Environment (PXE) bootloader 33.Sh DESCRIPTION 34The 35.Nm 36bootloader is a modified version of the system third-stage bootstrap 37.Xr loader 8 38configured to run under Intel's Preboot Execution Environment (PXE) system. 39PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and 403Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards. 41PXE supports DHCP configuration and provides low-level NIC access services. 42The 43.Nm 44bootloader retrieves the kernel, modules, 45and other files either via NFS over UDP or by TFTP, 46selectable through compile-time options. 47In combination with a memory file system image or NFS-mounted root file system, 48.Nm 49allows for easy, 50EEPROM-burner free construction of diskless machines. 51.Pp 52The 53.Nm 54binary is loaded just like any other boot file, 55by specifying it in the DHCP server's configuration file. 56Below is a sample configuration for the ISC DHCP v2 server: 57.Bd -literal -offset indent 58option domain-name "example.com"; 59option routers 10.0.0.1; 60option subnet-mask 255.255.255.0; 61option broadcast-address 10.0.0.255; 62option domain-name-servers 10.0.0.1; 63server-name "DHCPserver"; 64server-identifier 10.0.0.1; 65 66default-lease-time 120; 67max-lease-time 120; 68 69subnet 10.0.0.0 netmask 255.255.255.0 { 70 filename "pxeboot"; 71 range 10.0.0.10 10.0.0.254; 72} 73 74.Ed 75.Nm 76recognizes 77.Va next-server 78and 79.Va option root-path 80directives as the server and path to NFS mount for file requests, 81respectively, or the server to make TFTP requests to. 82Note that 83.Nm 84expects to fetch 85.Pa /boot/loader.rc 86from the specified server before loading any other files. 87.Pp 88In all other respects, 89.Nm 90acts just like 91.Xr loader 8 . 92.Pp 93As PXE is still in its infancy, some firmware versions may not work 94properly. 95The 96.Nm 97bootloader has been extensively tested on version 0.99 of Intel firmware; 98pre-release versions of the newer 2.0 firmware are known to have 99problems. 100Check with the device's manufacturer for their latest stable release. 101.Pp 102For further information on Intel's PXE specifications and Wired for 103Management (WfM) systems, see 104.Li http://www.intel.com/design/archives/wfm/ . 105.Sh SEE ALSO 106.Xr loader 8 107.Sh HISTORY 108The 109.Nm 110bootloader first appeared in 111.Fx 4.1 . 112.Sh AUTHORS 113.An -nosplit 114The 115.Nm 116bootloader was written by 117.An John Baldwin Aq jhb@FreeBSD.org 118and 119.An Paul Saab Aq ps@FreeBSD.org . 120This manual page was written by 121.An Doug White Aq dwhite@FreeBSD.org . 122