add .Mt to man pages in bin/ games/ sys/ tools/
[dragonfly.git] / sys / boot / pc32 / pxeldr / pxeboot.8
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 .\"
27 .Dd October 6, 2010
28 .Dt PXEBOOT 8
29 .Os
30 .Sh NAME
31 .Nm pxeboot
32 .Nd Preboot Execution Environment (PXE) bootloader
33 .Sh DESCRIPTION
34 The
35 .Nm
36 bootloader is a modified version of the system third-stage bootstrap
37 .Xr loader 8
38 configured to run under Intel's Preboot Execution Environment (PXE) system.
39 PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
40 3Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
41 PXE supports DHCP configuration and provides low-level NIC access services.
42 The
43 .Nm
44 bootloader retrieves the kernel, modules,
45 and other files either via NFS over UDP.
46 In combination with a NFS-mounted root file system,
47 .Nm
48 allows for easy,
49 EEPROM-burner free construction of diskless machines.
50 .Pp
51 The
52 .Nm
53 binary is loaded just like any other boot file,
54 by specifying it in the DHCP server's configuration file.
55 Below is a sample configuration for the ISC DHCP v2 server:
56 .Bd -literal -offset indent
57 option domain-name "example.com";
58 option routers 10.0.0.1;
59 option subnet-mask 255.255.255.0;
60 option broadcast-address 10.0.0.255;
61 option domain-name-servers 10.0.0.1;
62 server-name "DHCPserver";
63 server-identifier 10.0.0.1;
64
65 default-lease-time 120;
66 max-lease-time 120;
67
68 subnet 10.0.0.0 netmask 255.255.255.0 {
69        filename "boot/pxeboot";
70        range 10.0.0.10 10.0.0.254;
71        option root-path "10.0.0.1:/netbootroot";
72 }
73
74 .Ed
75 .Nm
76 recognizes
77 .Va next-server
78 and
79 .Va option root-path
80 directives as the server and path to NFS mount for file requests,
81 respectively, or the server to make TFTP requests to.
82 Note that
83 .Nm
84 expects to fetch
85 .Pa /boot/dloader.rc
86 from the specified server before loading any other files.
87 .Pp
88 .Nm
89 uses
90 .Pa /boot/kernel.BOOTP
91 and
92 .Pa /boot/loader-bootp.conf
93 and
94 .Pa nextboot-bootp.conf
95 instead of
96 .Pa /boot/kernel
97 and
98 .Pa /boot/loader.conf .
99 Note that the TFTP version
100 .Xr pxeboot_tftp 8
101 uses the standard boot loader files.
102 The NFS version uses different files to allow BOOTP boots via NFS to
103 be overloaded onto the same directory structure as a normal boot,
104 though many other changes would have to be made to actually make
105 that work.
106 However, this is more for historical reasons.
107 Current day PXE boot code can handle complex root-path specifications
108 allowing the root image to be contained in a sub-directory of the NFS
109 export.
110 .Pp
111 In all other respects,
112 .Nm
113 acts just like
114 .Xr loader 8 .
115 .Pp
116 As PXE is still in its infancy, some firmware versions may not work
117 properly.
118 The
119 .Nm
120 bootloader has been extensively tested on version 0.99 of Intel firmware;
121 pre-release versions of the newer 2.0 firmware are known to have
122 problems.
123 Check with the device's manufacturer for their latest stable release.
124 .Pp
125 For further information on Intel's PXE specifications and Wired for
126 Management (WfM) systems, see
127 .Pa http://developer.intel.com/ial/wfm/ .
128 .Sh FILES
129 .Bl -tag -width ".Pa /boot/defaults/loader-bootp.conf" -compact
130 .It Pa /boot/kernel.BOOTP
131 Default kernel for
132 .Nm .
133 .It Pa /boot/defaults/loader-bootp.conf
134 .Nm
135 configuration file -- do not change this file.
136 .It Pa /boot/loader-bootp.conf
137 .Nm
138 configuration file.
139 .El
140 .Sh SEE ALSO
141 .Xr dhcpd 8 Pq Pa net/isc-dhcp42-server ,
142 .Xr diskless 8 ,
143 .Xr loader 8 ,
144 .Xr nfsd 8 ,
145 .Xr pxeboot_tftp 8 ,
146 .Xr tftpd 8
147 .Sh HISTORY
148 The
149 .Nm
150 bootloader first appeared in
151 .Fx 4.1 .
152 .Sh AUTHORS
153 .An -nosplit
154 The
155 .Nm
156 bootloader was written by
157 .An John Baldwin Aq Mt jhb@FreeBSD.org
158 and
159 .An Paul Saab Aq Mt ps@FreeBSD.org .
160 This manual page was written by
161 .An Doug White Aq Mt dwhite@FreeBSD.org .