Update netboot manual page.

Submitted by:	Luigi Rizzo <luigi@iet.unipi.it>
This commit is contained in:
Tor Egge 1997-05-15 19:04:33 +00:00
parent 20aaa0e700
commit b262c3b12b
2 changed files with 64 additions and 53 deletions

View File

@ -42,7 +42,7 @@ CLEANFILES+= netboot.com
CLEANFILES+= makerom start2.ro 3c509.o ns8390.o
LDFLAGS+= -N -T ${RELOCADDR} -e _start -nostdlib
NOSHARED= YES
NOMAN=
MAN8= netboot.8
STRIP=
ROMSIZE=16384

View File

@ -1,5 +1,5 @@
.\" $Id:$
.Dd May 5, 1997
.\" $Id: netboot.8,v 1.1 1997/05/14 02:44:26 tegge Exp $
.Dd May 15, 1997
.Dt NETBOOT 8
.\".Os BSD 4
.Sh NAME
@ -7,17 +7,16 @@
.Nd Allows remote booting of the operating system
.Sh SYNOPSIS
.Nm
.It Fl b
.Bl -tag -width Ds
is used for booting the operating system over a network card. The
program is either loaded into a ROM, or run from DOS.
.Pp
.Sh DESCRIPTION
.Nm
loads parameters such as IP addresses, kernel name and filesystem
names from a bootp server, tries to mount the specified root and swap
filesystems,
loads the specified kernel from the root filesystem using NFSv2, and
then gives control to the kernel.
names from a bootp server, tries to mount the specified root and
swap filesystems, loads the specified kernel from the root filesystem
using NFSv2, and then gives control to the kernel.
.Pp
The bootp server must be configured appropriately. An example
configuration for /etc/bootptab is the following:
@ -25,16 +24,16 @@ configuration for /etc/bootptab is the following:
.default:\\
:sm=255.255.255.0:\\
:gw=your.gateway.ip:\\
:ds=your.nameserver.ip:\\
:hn:ht=1:vm=rfc1048:\\
:sw=server.ip:\\
:hn:ht=ether:vm=rfc1048:\\
:rp="rootfs.ip:/rootfs/path":\\
:T128="swapfs.ip:/swapfs/path":\\
:T129=swapsize:\\
:T130="root,mount,options":\\
:T131="swap,mount,options":
.client01:bf="kernel.300":ha=00400530d6d9:tc=.default:
.client02:bf="kernel.280":ha=00400530d6d3:tc=.default:
:T131="swap,mount,options":\\
:ra=255.255.255.255:
client01:bf="kernel.300":ha=00400530d6d9:tc=.default:
client02:bf="kernel.280":ha=00400530d6d3:tc=.default:
...
.Ed
.Pp
For a precise description of the bootptab parameters, see
@ -43,48 +42,60 @@ bootptab (5) .
The
.Nm
code uses options as follows.
.Pp
sm indicates the subnet mask.
.Pp
gw is the ip address of the gateway.
.Pp
ds is the ip address of the name server.
.Pp
hn instructs the bootp server to send the hostname in the reply.
.Pp
ht=1 indicates that the hardware is ethernet.
.Pp
vm=rfc1048 indicates the use of rfc1048 extensions.
.Pp
sw indicates the ip address of the NFS server, and is used for both
the root filesystem and the swap filesystem server. It is optional in
that it can be overridden from what is specified in the "rp" and "T128"
options.
.Pp
rp specifies the path to the root partition. Optionally, the IP
address of the server can be specified, followed by a :
.Pp
T128 specifies the path to the swap partition. Optionally, the IP
address of the server can be specified, followed by a : . The
actual swapfile is a file named swap.X.Y.Z.T where X.Y.Z.T is the
IP address of the client. In both "rp" and "T128" options
the sequence %I can be used which is replaced with the IP address of
the client. The swap partition is optional. If specified, the swap
file must exist and have at least the size specified with T129.
.Pp
T129 specifies the size of the swap file, in KB. Must be specified as
a hexadecimal number. This argument is optional.
.Pp
T130 specified root mount options (e.g. soft,intr,tcp, ...).
.Pp
T131 specified swap mount options.
.Pp
bf is the name of the kernel. If not specified, it defaults to
.Bl -tag -width indent
.It Cm sm
indicates the subnet mask.
.It Cm gw
is the ip address of the gateway.
.It Cm hn
instructs the bootp server to send the hostname in the reply.
.It Cm ht= Ns Ar ether
.\.It ht=ether
indicates that the hardware is ethernet.
.It Cm vm= Ns Ar rfc1048
indicates the use of rfc1048 extensions.
.It Cm rp
specifies where the directory mounted as the root filesystem is located.
The IP address of the server must be specified, followed by a : and the
directory pathname.
.It Cm T128
specifies where the directory containing the swap file is located.
The IP address of the server must be specified, followed by a : and the
directory pathname.
The actual swapfile is a file named swap.X.Y.Z.T where X.Y.Z.T is the
IP address of the client. If this argument is given, the swap file must exist.
.It Cm T129
specifies the size of the swap file, in KB. Must be specified as
a 8 digits long hexadecimal number. 16 MB swap thus becomes
T129=00004000. This argument is optional; if missing, the size of the
swap file is read from the server.
.It Cm T130
specifies root mount options, such as soft, intr, tcp, etc.
This argument is optional. The default is to use UDP.
.It Cm T131
specifies swap mount options.
This argument is optional.
.It Cm bf
is the name of the kernel. If not specified, it defaults to
"kernel".
.It Cm ra
is used to override the reply address.
.Sh FILES
.Bl -tag -width /usr/mdec/nb3c509.rom -compact
.It Pa /usr/mdec/nb8390.rom
rom image for NE1000/NE2000 cards
.It Pa /usr/mdec/nb8390.com
DOS executable for NE1000/NE2000 cards
.It Pa /usr/mdec/nb3c509.rom
rom image for 3C509 cards
.It Pa /usr/mdec/nb3c509.com
DOS executable for 3C509 cards
.Sh SEE ALSO
.Xr bootd 8 ,
.Xr bootptab 5
.Sh BUGS
The T130 and T131 options are still unsupported.
.Sh BUGS
To use netboot with Western Digital/SMC cards or 3C503 cards, a recompile
is needed after a little Makefile tweaking.