sys/boot/i386/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$
  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
  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 or by TFTP,
  46 selectable through compile-time options.
  47 In combination with a memory file system image or NFS-mounted root file system,
  48 .Nm
  49 allows for easy,
  50 EEPROM-burner free construction of diskless machines.
  51 .Pp
  52 The
  53 .Nm
  54 binary is loaded just like any other boot file,
  55 by specifying it in the DHCP server's configuration file.
  56 Below is a sample configuration for the ISC DHCP v2 server:
  57 .Bd -literal -offset indent
  58 option domain-name "example.com";
  59 option routers 10.0.0.1;
  60 option subnet-mask 255.255.255.0;
  61 option broadcast-address 10.0.0.255;
  62 option domain-name-servers 10.0.0.1;
  63 server-name "DHCPserver";
  64 server-identifier 10.0.0.1;
  65
  66 default-lease-time 120;
  67 max-lease-time 120;
  68
  69 subnet 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
  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/loader.rc
  86 from the specified server before loading any other files.
  87 .Pp
  88 .Nm
  89 defaults to a conservative 1024 byte NFS data packet size.
  90 This may be changed by setting the
  91 .Va nfs.read_size
  92 variable in
  93 .Pa /boot/loader.conf .
  94 Valid values range from 1024 to 4096 bytes.
  95 .Pp
  96 In all other respects,
  97 .Nm
  98 acts just like
  99 .Xr loader 8 .
 100 .Pp
 101 As PXE is still in its infancy, some firmware versions may not work
 102 properly.
 103 The
 104 .Nm
 105 bootloader has been extensively tested on version 0.99 of Intel firmware;
 106 pre-release versions of the newer 2.0 firmware are known to have
 107 problems.
 108 Check with the device's manufacturer for their latest stable release.
 109 .Pp
 110 For further information on Intel's PXE specifications and Wired for
 111 Management (WfM) systems, see
 112 .Li http://www.intel.com/design/archives/wfm/ .
 113 .Sh SEE ALSO
 114 .Xr loader 8
 115 .Sh HISTORY
 116 The
 117 .Nm
 118 bootloader first appeared in
 119 .Fx 4.1 .
 120 .Sh AUTHORS
 121 .An -nosplit
 122 The
 123 .Nm
 124 bootloader was written by
 125 .An John Baldwin Aq jhb@FreeBSD.org
 126 and
 127 .An Paul Saab Aq ps@FreeBSD.org .
 128 This manual page was written by
 129 .An Doug White Aq dwhite@FreeBSD.org .