Grammar fixes. New sentence, new line. More Xr's.

Punctuation fixes.  Shorten long lines.
This commit is contained in:
wiz 2004-01-07 12:55:42 +00:00
parent ceb721fd0b
commit 3c6a3b6232
1 changed files with 116 additions and 93 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: boot.8,v 1.1 2004/01/07 11:50:02 cdi Exp $
.\" $NetBSD: boot.8,v 1.2 2004/01/07 12:55:42 wiz Exp $
.\"
.\" Copyright (c) 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -32,13 +32,12 @@
.\"
.\" @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
.\"
.Dd January 3, 2004
.Dd January 7, 2004
.Dt BOOT 8 cobalt
.Os
.Sh NAME
.Nm boot
.Nd
system bootstrapping procedures
.Nd system bootstrapping procedures
.Sh DESCRIPTION
.Tn Cobalt
Networks' MIPS-based Microservers
@ -55,27 +54,27 @@ can use any of the following boot procedures:
.It
bootstrap
.Nx
from disk using standard
from disk using the standard
.Tn Cobalt
.Tn Firmware
boot sequence
.It
bootstrap
.Nx
from disk using
from disk using the
.Nx
boot loader
.It
network bootstrap
.Nx
using standard
using the standard
.Tn Cobalt
.Tn Firmware
means from a
.Tn TCP/IP
.Tn LAN
with
.Tn DHCP ,
.Tn DHCP
and
.Tn NFS .
.El
@ -89,26 +88,29 @@ The first program to take a control after reboot or at power-on is the
.Tn Firmware .
The
.Tn Firmware
can load a compressed kernel from disk, subject to a few limitations. The
can load a compressed kernel from disk, subject to a few limitations.
The
.Tn Firmware
expects the disk to contain DOS-style partition information with the first
partition being a boot one which is special in that it should reside close
to the beginning of the disk and must contain
expects the disk to contain DOS-style partition information with
the first partition being a boot one which is special in that it
should reside close to the beginning of the disk and must contain
an
.Tn ext2
file system with
file system with a
.Pa boot
directory which is treated specially by the
.Tn Firmware.
.Tn Firmware .
The default sequence is pretty straightforward, the
.Tn Firmware
finds the boot partition, mounts ext2 file system from it and tries to load
compressed kernel image from
finds the boot partition, mounts the ext2 file system from it and
tries to load a compressed kernel image from the
.Pa boot
directory. The name of the kernel image differs from machine to machine and this
is the reason for having multiple copies of
directory.
The name of the kernel image differs from machine to machine and
this is the reason for having multiple copies of
.Nx
kernel installed under different names. The following kernel image names are
known to be in use by certain
kernel installed under different names.
The following kernel image names are known to be in use by certain
.Tn Cobalt
flavors:
.Bd -unfilled -offset indent
@ -125,22 +127,24 @@ is the directory on the boot partition.
.Pp
The
.Tn Firmware
console provides the means to alter the default boot sequence and/or to
specify boot parameters. Pressing
.Sq Space
button right after the
console provides the means to alter the default boot sequence and/or
to specify boot parameters.
Pressing
.Sq Aq space
right after the
.Tn Firmware
printed its greeting brings the
.Tn Firmware
console prompt and pressing
.Sq \&?
at the prompt prints a help screen with all commands supported by the
.Tn Firmware
For example,
at the prompt prints a help screen with all commands supported by
the
.Tn Firmware .
For example, the
.Sq bfd
command can be used to boot a kernel image:
.Bd -unfilled -offset indent
Cobalt: bfd /boot/<kernel image> [options]
Cobalt: bfd /boot/\*[Lt]kernel image\*[Gt] [options]
.Ed
.Pp
where
@ -149,54 +153,64 @@ are the kernel options.
.Ss Bootstrap from disk using the standard Firmware sequence
The
.Tn Firmware
enters standard boot sequence after reboot or at power-on when no front-panel
buttons are pressed and the
enters the standard boot sequence after reboot or at power-on when
no front-panel buttons are pressed and the
.Tn Firmware
console is not used to change the boot procedure. At the boot time, the
console is not used to change the boot procedure.
At boot time, the
.Tn Firmware
checks the hardware, prints the banner and performs standard
checks the hardware, prints the banner and performs the standard
.Tn Cobalt
boot sequence. There are a few culprits tightly connected to this boot method.
First of all, the kernel must be compressed. Second, the
boot sequence.
There are a few culprits tightly connected to this boot method.
First of all, the kernel must be compressed.
Second, the
.Tn Firmware
enforces a hard restriction on the kernel size
.Po
it cannot exceed approximately 1000000/2500000 bytes compressed/uncompressed
it cannot exceed approximately 1000000/2500000 bytes
compressed/uncompressed
.Pc
resulting in a lock-up should this requirement not be fulfilled. For
.Nx
, another pitfall is that uncompressed kernel shall be copied to the root
directory to make certain system binaries
resulting in a lock-up should this requirement not be fulfilled.
For
.Nx ,
another pitfall is that the uncompressed kernel should be copied to
the root directory to make certain system binaries
.Po
such as e.g. netstat
.Pc
work, and the kernel images under
work, and the kernel images in the
.Pa boot
directory shall always be in sync with the one installed under the root.
.Ss Bootstrap from disk using NetBSD boot loader
directory should always be in sync with the ones installed in the
root directory.
.Ss Bootstrap from disk using the NetBSD boot loader
The
.Nx
boot loader is an attempt to break through the limitations enforced by the
boot loader is an attempt to break through the limitations enforced
by the
.Tn Firmware
loader. The main idea is to make the
loader.
The main idea is to make the
.Tn Firmware
load the
.Nx
boot loader and let the latter take care of loading the
kernel. To achieve this goal, multiple copies of the boot loader are installed
under
boot loader and let the latter take care of loading the kernel.
To achieve this goal, multiple copies of the boot loader are
installed in the
.Pa boot
directory on the boot partition, one copy per each kernel image name the
directory on the boot partition, one copy per each kernel image
name the
.Tn Cobalt
.Tn Firmware
might look for. The
might look for.
The
.Nx
kernel is located in the root directory
.Po
normally
usually
.Pa /dev/wd0a
.Pc
like it is done on other platforms.
like it is on other platforms.
Once running, the boot loader prints a banner similar to the following:
.Bd -unfilled -offset indent
\*[Gt]\*[Gt] NetBSD/cobalt 1.6ZG Bootloader, Revision 0.1 [@0x81000000]
@ -210,7 +224,7 @@ Starting at 0x80001000
.Pp
by default, the boot loader uses
.Dq Li wd0a:netbsd
kernel specification which is the file
as kernel specification which corresponds to the file
.Nm netbsd
on partition
.Dq a
@ -226,20 +240,18 @@ or similar device - see the
.Sx BUGS
section
.Pc .
Shall this fail, the boot loader will try a few alternative kernel image
names and if this also fails the loader will repeat the whole procedure
for all other
In case this fails, the boot loader will try a few alternative
kernel image names and if this also fails the loader will repeat
the whole procedure for all other
.Nx
slices
.Po
if any
.Pc
.Pq if any
and will load the first kernel image found.
.Ss Boot loader Options
It is possible to specify some options to the boot loader by breaking
into the
.Tn Firmware
and using
and using the
.Dq bfd
command:
.Bd -unfilled -offset indent
@ -260,7 +272,7 @@ will be set to
which is the first
.Nx
partition on the first drive, as numbered by the
.Tn Firmware
.Tn Firmware .
To boot from an alternate disk, the full name of the device should
be given at the prompt.
.Va device
@ -279,10 +291,9 @@ installation:
.Pp
.Bl -hang -compact
.It wd
Hard disks as numbered by the BIOS. This includes
ST506, IDE, ESDI, RLL disks on a WD100[2367] or
lookalike controller(s), and SCSI disks
on SCSI controllers recognized by the
Hard disks as numbered by the BIOS. This includes ST506, IDE, ESDI,
RLL disks on a WD100[2367] or lookalike controller(s), and SCSI
disks on SCSI controllers recognized by the
.Tn Firmware .
.El
.Pp
@ -293,7 +304,9 @@ is
if the boot loader fails to successfully
open that image, it then tries
.Pa netbsd.gz
(expected to be a kernel image compressed by gzip), followed by
(expected to be a kernel image compressed by
.Xr gzip 1 ) ,
followed by
.Pa netbsd ,
.Pa netbsd.gz ,
.Pa onetbsd ,
@ -307,7 +320,8 @@ open that image, it then tries
.Pa netbsd.elf ,
and finally
.Pa netbsd.elf.gz .
Alternate system images can be loaded by just specifying the name of the image.
Alternate system images can be loaded by just specifying the name
of the image.
.Pp
Options are:
.Bl -tag -width xxx
@ -316,12 +330,12 @@ Prompt for the root file system device, the system crash dump
device, and the path to
.Xr init 8 .
.It Fl c
Bring the system up into the device configuration manager. From here
the device locators can be tuned to the hardware; see
Bring the system up into the device configuration manager.
From here the device locators can be tuned to the hardware; see
.Xr userconf 4 .
.It Fl d
Bring the system up in debug mode. Here it waits for a kernel
debugger connect; see
Bring the system up in debug mode.
Here it waits for a kernel debugger connect; see
.Xr ddb 4 .
.It Fl q
Boot the system in quiet mode.
@ -332,9 +346,10 @@ Boot the system in verbose mode.
.El
.El
.Pp
It is always a good idea to have a small rescue kernel in
It is always a good idea to have a small rescue kernel in the
.Pa boot
directory. In an emergency case, this will allow to use
directory.
In an emergency case, this will allow you to use the
.Tn Firmware
.Sq bfd
command to boot the rescue image:
@ -345,9 +360,11 @@ Cobalt: bfd /boot/netbsd.gz
The
.Tn Cobalt
.Tn Firmware
allows to boot a kernel over the network, with all the limitations of the
allows to boot a kernel over the network, with all the limitations
of the
.Tn Firmware
loader described above. The simplest method is to break into the
loader described above.
The simplest method is to break into the
.Tn Firmware
prompt and use
.Dq bfd
@ -358,18 +375,20 @@ Cobalt: bfd /netbsd.gz nfsroot=/home/raq/root
.Pp
The
.Tn Firmware
is picky about syntax and in general, so if things fail mysteriously, try to
conform to the conventions described above. For netbooting, you need to
NFS-export the directory given to
is picky about syntax and in general, so if things fail mysteriously,
try to conform to the conventions described above.
For netbooting, you need to NFS-export the directory given to
.Dq nfsroot= ,
and the named kernel
.Po
.Pa netbsd.gz
.Pc
needs to be executable and in that directory. You will also need to setup rarp
and dhcp. Once the kernel is loaded with the command line values, the data
given via DHCP is used to mount the root filesystem. Here is a DHCP entry that
is known working:
.Pq Pa netbsd.gz
needs to be executable and in that directory.
You will also need to setup
.Xr rarpd 8
and
.Xr dhcpd 8 .
Once the kernel is loaded with the command line values, the data
given via DHCP is used to mount the root filesystem.
Here is a known working DHCP entry:
.Bd -unfilled -offset indent
host raq {
hardware ethernet 0:10:e0:0:52:62; # raq MAC
@ -380,13 +399,14 @@ host raq {
}
.Ed
.Pp
Another option is to hold left and right cursor buttons in while powering on
which executes the command
Another option is to hold down the left and right cursor buttons
during power-on which executes the command
.Bd -unfilled -offset indent
bfd /boot/vmlinux.gz root=/dev/nfs nfsroot=/nfsroot,
.Ed
.Pp
resulting in a netboot. On RaQ 1's, the default kernel name is
resulting in a netboot.
On RaQ 1's, the default kernel name is
.Pa vmlinux_RAQ.gz
and on RaQ 2's, it is
.Pa vmlinux_raq-2800.gz .
@ -397,24 +417,27 @@ boot program code loaded by the
.Tn Firmware
loader
.It Pa /boot/netbsd.gz
gzip-compressed rescue system code
.Xr gzip 1 Ns -compressed
rescue system code
.It Pa /netbsd
system code
.It Pa /netbsd.gz
gzip-compressed system code
.Xr gzip 1 Ns -compressed
system code
.El
.Sh SEE ALSO
.Xr ddb 4 ,
.Xr userconf 4 ,
.Xr fdisk 8 ,
.Xr halt 8 ,
.Xr reboot 8 ,
.Xr shutdown 8 ,
.Xr fdisk 8
.Xr shutdown 8
.Sh BUGS
The
.Nx
boot loader supports booting off IDE hard drives only. This is less a bug
of the boot loader code than a shortcoming of the
boot loader supports booting off IDE hard drives only.
This is less a bug of the boot loader code than a shortcoming of
the
.Tn Cobalt
.Tn Firmare
and shall be considered as such.