| 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: src/sys/boot/i386/pxeldr/pxeboot.8,v 1.7 2002/12/12 17:25:59 ru Exp $ |
| 26 | .\" $DragonFly: src/sys/boot/i386/pxeldr/Attic/pxeboot.8,v 1.3 2003/11/10 06:08:37 dillon Exp $ |
| 27 | .\" |
| 28 | .\" Note: The date here should be updated whenever a non-trivial |
| 29 | .\" change is made to the manual page. |
| 30 | .Dd May 1, 2000 |
| 31 | .Dt PXEBOOT 8 |
| 32 | .Os |
| 33 | .Sh NAME |
| 34 | .Nm pxeboot |
| 35 | .Nd Preboot Execution Environment (PXE) bootloader |
| 36 | .Sh DESCRIPTION |
| 37 | The |
| 38 | .Nm |
| 39 | bootloader is a modified version of the system third-stage bootstrap |
| 40 | .Xr loader 8 |
| 41 | configured to run under Intel's Preboot Execution Environment (PXE) system. |
| 42 | PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and |
| 43 | 3Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards. |
| 44 | PXE supports DHCP configuration and provides low-level NIC access services. |
| 45 | The |
| 46 | .Nm |
| 47 | bootloader retrieves the kernel, modules, |
| 48 | and other files either via NFS over UDP or by TFTP, |
| 49 | selectable through compile-time options. |
| 50 | In combination with a memory file system image or NFS-mounted root file system, |
| 51 | .Nm |
| 52 | allows for easy, |
| 53 | EEPROM-burner free construction of diskless machines. |
| 54 | .Pp |
| 55 | The |
| 56 | .Nm |
| 57 | binary is loaded just like any other boot file, |
| 58 | by specifying it in the DHCP server's configuration file. |
| 59 | Below is a sample configuration for the ISC DHCP v2 server: |
| 60 | .Bd -literal -offset indent |
| 61 | option domain-name "example.com"; |
| 62 | option routers 10.0.0.1; |
| 63 | option subnet-mask 255.255.255.0; |
| 64 | option broadcast-address 10.0.0.255; |
| 65 | option domain-name-servers 10.0.0.1; |
| 66 | server-name "DHCPserver"; |
| 67 | server-identifier 10.0.0.1; |
| 68 | |
| 69 | default-lease-time 120; |
| 70 | max-lease-time 120; |
| 71 | |
| 72 | subnet 10.0.0.0 netmask 255.255.255.0 { |
| 73 | filename "pxeboot"; |
| 74 | range 10.0.0.10 10.0.0.254; |
| 75 | } |
| 76 | |
| 77 | .Ed |
| 78 | .Nm |
| 79 | recognizes |
| 80 | .Va next-server |
| 81 | and |
| 82 | .Va option root-path |
| 83 | directives as the server and path to NFS mount for file requests, |
| 84 | respectively, or the server to make TFTP requests to. |
| 85 | Note that |
| 86 | .Nm |
| 87 | expects to fetch |
| 88 | .Pa /boot/loader.rc |
| 89 | from the specified server before loading any other files. |
| 90 | .Pp |
| 91 | In all other respects, |
| 92 | .Nm |
| 93 | acts just like |
| 94 | .Xr loader 8 . |
| 95 | .Pp |
| 96 | As PXE is still in its infancy, some firmware versions may not work |
| 97 | properly. |
| 98 | The |
| 99 | .Nm |
| 100 | bootloader has been extensively tested on version 0.99 of Intel firmware; |
| 101 | pre-release versions of the newer 2.0 firmware are known to have |
| 102 | problems. |
| 103 | Check with the device's manufacturer for their latest stable release. |
| 104 | .Pp |
| 105 | For further information on Intel's PXE specifications and Wired for |
| 106 | Management (WfM) systems, see |
| 107 | .Li http://developer.intel.com/ial/wfm/ . |
| 108 | .Sh SEE ALSO |
| 109 | .Xr loader 8 |
| 110 | .Sh HISTORY |
| 111 | The |
| 112 | .Nm |
| 113 | bootloader first appeared in |
| 114 | .Fx 4.1 . |
| 115 | .Sh AUTHORS |
| 116 | .An -nosplit |
| 117 | The |
| 118 | .Nm |
| 119 | bootloader was written by |
| 120 | .An John Baldwin Aq jhb@FreeBSD.org |
| 121 | and |
| 122 | .An Paul Saab Aq ps@FreeBSD.org . |
| 123 | This manual page was written by |
| 124 | .An Doug White Aq dwhite@FreeBSD.org . |