Add man page for pxeboot.
Reviewed By: asmodai
This commit is contained in:
dwhite
parent
f5ba33365e
commit
24add02b86
@ -7,7 +7,8 @@ ORG= 0x7c00
|
||||
LDR= pxeldr
|
||||
BOOT= pxeboot
|
||||
PROG= ${BOOT}
|
||||
NOMAN=
|
||||
MAN8= ${BOOT}.8
|
||||
# NOMAN=
|
||||
STRIP=
|
||||
BINDIR?= /boot
|
||||
|
||||
|
||||
130
sys/boot/i386/pxeldr/pxeboot.8
Normal file
130
sys/boot/i386/pxeldr/pxeboot.8
Normal file
@ -0,0 +1,130 @@
|
||||
.\" Copyright (c) 1999 Doug White
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.\" Note: The date here should be updated whenever a non-trivial
|
||||
.\" change is made to the manual page.
|
||||
.Dd May 1, 2000
|
||||
.Dt PXEBOOT 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm pxeboot
|
||||
.Nd Preboot Execution Environment (PXE) bootloader
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
is a modified version of the system third-stage bootstrap
|
||||
.Xr loader 8
|
||||
configured to run under Intel's Preboot Execution Environment (PXE) system.
|
||||
PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
|
||||
3Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
|
||||
PXE supports DHCP configuration and provides low-level NIC access services.
|
||||
.Nm
|
||||
retrieves the kernel, modules,
|
||||
and other files either via NFS over UDP or by TFTP,
|
||||
selectable through compile-time options.
|
||||
In combination with a memory filesystem image or NFS-mounted root filesystem,
|
||||
.Nm
|
||||
allows for easy,
|
||||
EEPROM-burner free construction of diskless machines.
|
||||
.Pp
|
||||
The
|
||||
.Nm
|
||||
binary is loaded just like any other boot file,
|
||||
by specifying it in the DHCP server's configuration file.
|
||||
PXE, however,
|
||||
requires special
|
||||
DHCP options before it will recognize the server response.
|
||||
Below is a sample configuration for the ISC DHCP v2 server:
|
||||
.Bd -literal -offset indent
|
||||
option domain-name "example.com";
|
||||
option routers 10.0.0.1;
|
||||
option subnet-mask 255.255.255.0;
|
||||
option broadcast-address 10.0.0.255;
|
||||
option domain-name-servers 10.0.0.1;
|
||||
server-name "DHCPserver";
|
||||
server-identifier 10.0.0.1;
|
||||
|
||||
default-lease-time 120;
|
||||
max-lease-time 120;
|
||||
|
||||
option vendor-encapsulated-options 01:04:00:00:00:00:ff;
|
||||
option dhcp-class-identifier "PXEClient";
|
||||
|
||||
subnet 10.0.0.0 netmask 255.255.255.0 {
|
||||
filename "pxeboot";
|
||||
range 10.0.0.10 10.0.0.254;
|
||||
}
|
||||
|
||||
.Ed
|
||||
The
|
||||
.Va vendor-encapsulated-options
|
||||
and
|
||||
.Va dhcp-class-identifier
|
||||
options are important to PXE;
|
||||
it will not recognize the DHCP server response otherwise.
|
||||
.Pp
|
||||
.Nm
|
||||
recognizes
|
||||
.Va next-server
|
||||
and
|
||||
.Va option root-path
|
||||
directives as the server and path to NFS mount for file requests,
|
||||
respectively, or the server to make TFTP requests to.
|
||||
Note that
|
||||
.Nm
|
||||
expects to fetch
|
||||
.Pa /boot/loader.rc
|
||||
from the specified server before loading any other files.
|
||||
.Pp
|
||||
In all other respects,
|
||||
.Nm
|
||||
acts just like
|
||||
.Xr loader 8 .
|
||||
.Pp
|
||||
As PXE is still in it's infancy, some firmware versions may not work
|
||||
properly.
|
||||
.Nm
|
||||
has been extensively tested on version 0.99 of Intel firmware;
|
||||
pre-release versions of the newer 2.0 firmware are known to have
|
||||
problems.
|
||||
Check with the device's manufacturer for their latest stable release.
|
||||
.Pp
|
||||
Further information on Intel's PXE specifications and Wired for
|
||||
Management (WfM) systems, see
|
||||
.Li http://developer.intel.com/ial/wfm/ .
|
||||
.Sh SEE ALSO
|
||||
.Xr loader 8
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
first appeared in
|
||||
.Fx 4.1 .
|
||||
.Sh AUTHOR
|
||||
.Nm
|
||||
was written by
|
||||
.An John Baldwin Aq jhb@freebsd.org
|
||||
and
|
||||
.An Paul Saab Aq ps@freebsd.org .
|
||||
This manual page was written by
|
||||
.An Doug White Aq dwhite@freebsd.org .
|
||||
Loading…
Reference in New Issue
Block a user