Fully synchronize sys/boot from FreeBSD-5.x, but add / to the module path
[dragonfly.git] / sys / boot / i386 / pxeldr / pxeboot.8
CommitLineData
984263bc
MD
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.\"
5ee58eed
MD
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 $
984263bc
MD
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
5ee58eed 37The
984263bc 38.Nm
5ee58eed 39bootloader is a modified version of the system third-stage bootstrap
984263bc
MD
40.Xr loader 8
41configured to run under Intel's Preboot Execution Environment (PXE) system.
42PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
433Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
44PXE supports DHCP configuration and provides low-level NIC access services.
5ee58eed 45The
984263bc 46.Nm
5ee58eed 47bootloader retrieves the kernel, modules,
984263bc
MD
48and other files either via NFS over UDP or by TFTP,
49selectable through compile-time options.
5ee58eed 50In combination with a memory file system image or NFS-mounted root file system,
984263bc
MD
51.Nm
52allows for easy,
53EEPROM-burner free construction of diskless machines.
54.Pp
55The
56.Nm
57binary is loaded just like any other boot file,
58by specifying it in the DHCP server's configuration file.
59Below is a sample configuration for the ISC DHCP v2 server:
60.Bd -literal -offset indent
61option domain-name "example.com";
62option routers 10.0.0.1;
63option subnet-mask 255.255.255.0;
64option broadcast-address 10.0.0.255;
65option domain-name-servers 10.0.0.1;
66server-name "DHCPserver";
67server-identifier 10.0.0.1;
68
69default-lease-time 120;
70max-lease-time 120;
71
72subnet 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
79recognizes
80.Va next-server
81and
82.Va option root-path
83directives as the server and path to NFS mount for file requests,
84respectively, or the server to make TFTP requests to.
85Note that
86.Nm
87expects to fetch
88.Pa /boot/loader.rc
89from the specified server before loading any other files.
90.Pp
91In all other respects,
92.Nm
93acts just like
94.Xr loader 8 .
95.Pp
96As PXE is still in its infancy, some firmware versions may not work
97properly.
5ee58eed 98The
984263bc 99.Nm
5ee58eed 100bootloader has been extensively tested on version 0.99 of Intel firmware;
984263bc
MD
101pre-release versions of the newer 2.0 firmware are known to have
102problems.
103Check with the device's manufacturer for their latest stable release.
104.Pp
105For further information on Intel's PXE specifications and Wired for
106Management (WfM) systems, see
107.Li http://developer.intel.com/ial/wfm/ .
108.Sh SEE ALSO
109.Xr loader 8
110.Sh HISTORY
5ee58eed 111The
984263bc 112.Nm
5ee58eed 113bootloader first appeared in
984263bc
MD
114.Fx 4.1 .
115.Sh AUTHORS
116.An -nosplit
5ee58eed 117The
984263bc 118.Nm
5ee58eed 119bootloader was written by
984263bc
MD
120.An John Baldwin Aq jhb@FreeBSD.org
121and
122.An Paul Saab Aq ps@FreeBSD.org .
123This manual page was written by
124.An Doug White Aq dwhite@FreeBSD.org .