[src/trunk]: src/share/man/man8/man8.sparc64 Clean up nroff problems. Reword ...

[fair <fair%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/de71ace8753a
branches:  trunk
changeset: 546520:de71ace8753a
user:      fair <fair%NetBSD.org@localhost>
date:      Thu May 01 06:20:19 2003 +0000

description:
Clean up nroff problems. Reword description a little.
Add requirement for SCSI CD-ROMs (should be ID 6, and must
be able to do 512-byte reads). Add STANDARDS section.
This should close PR 21387.

diffstat:

 share/man/man8/man8.sparc64/boot.8 |  125 ++++++++++++++++++++++++++----------
 1 files changed, 88 insertions(+), 37 deletions(-)

diffs (201 lines):

diff -r c0d485af6bd4 -r de71ace8753a share/man/man8/man8.sparc64/boot.8
--- a/share/man/man8/man8.sparc64/boot.8        Thu May 01 02:34:20 2003 +0000
+++ b/share/man/man8/man8.sparc64/boot.8        Thu May 01 06:20:19 2003 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: boot.8,v 1.3 2003/05/01 02:11:01 wiz Exp $
+.\"    $NetBSD: boot.8,v 1.4 2003/05/01 06:20:19 fair Exp $
 .\"
 .\" Copyright (c) 1992, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -47,6 +47,14 @@
 .Aq Ar boot string
 .Oc
 .Sh DESCRIPTION
+.Pp
+.Tn Sun
+systems support booting from locally attached storage media
+.Pq e.g. floppy, hard disk, Tn CD-ROM ,
+and booting over
+.Tn Ethernet
+networks using
+.Tn BOOTP .
 .Ss Power fail and crash recovery
 Normally, the system will reboot itself at power-up or after crashes.
 An automatic consistency check of the file systems will be performed
@@ -55,12 +63,11 @@
 and unless this fails, the system will resume multi-user operations.
 .Ss Cold starts
 The
-.Nx
-boot
-.Pa netbsd
-from the default boot device, configured via OpenFirmware environment
-variables.
-See below for details.
+.Tn Sun
+Open Firmware performs a Power On Self Test
+.Pq Tn POST ,
+and then will boot an operating system according to
+configuration in Open Firmware environment variables.
 .Ss Boot program options
 .Bl -tag -width xxx
 .It Fl a
@@ -84,26 +91,38 @@
 after the -- separator are passed to the boot PROM.
 Other flags are currently ignored.
 .Pp
-At any time you can break back to the ROM by pressing the
+At any time you can halt the running system and get back to the Open Firmware.
+If the console is the
+.Tn Sun
+framebuffer and keyboard,
+press the
 .Sq STOP
-(labeled
-.Sq L1
-on older keyboard types) and
-.Sq a
-keys at the same time (if the console is a serial port the same is
+and
+.Sq A
+keys at the same time on the keyboard.
+On older models of
+.Tn Sun
+keyboards, the
+.Sq STOP
+key is labelled
+.Sq L1 .
+.Pp
+If the console is a serial port the same is
 achieved by sending a
-.Sq break ) .
-If you do this accidentally you can continue whatever was in progress
-by typing
-.Sq go .
+.Sq BREAK .
+.Pp
+If you do this accidentally, you can continue whatever was in progress
+with the
+.Ic go
+command.
 .Sh BOOT DEVICES
-Since machines vary in the way their devices are connected greatly, there
-are aliases defined by the firmware.
-You can either use the full qualified OpenFirmware path of a device node,
-or the alias.
+Since machines vary greatly in the way their devices are connected,
+there are aliases defined by the firmware.
+You can either use the fully qualified
+Open Firmware path of a device node, or the alias.
 .Pp
 A typical list of usable boot devices (extracted from the output of
-the OpenFirmware command
+the Open Firmware command
 .Ic devalias )
 is:
 .Bd -literal -offset indent
@@ -119,18 +138,20 @@
 disk0                    /sbus/SUNW,fas@e,8800000/sd@0,0
 .Ed
 .Pp
-If a device specification includes a partition letter (for example cdrom
-in above list) this partition is used by default, otherwise the first (a)
-partition is used. If booting from the net device, there is no partition
-involved.
+If a device specification includes a partition letter (for example
+.Em cdrom
+in above list), that partition is used by default, otherwise the first (a)
+partition is used.
+If booting from the net device, there is no partition involved.
 .Pp
 The boot device is an optional first part of the boot string, if no device
 is specified the default device is used (see below).
 .Sh FIRMWARE ENVIRONMENT VARIABLES
-All OpenFirmware environment variables can be printed with the
+All Open Firmware environment variables can be printed with the
 .Ic printenv
 command and changed with
-.Ic setenv .
+.Ic setenv
+command.
 The boot process relevant variables and their suggested value for
 booting
 .Nx
@@ -143,8 +164,8 @@
 diag-switch?          false
 .Ed
 .Pp
-Of course you may select any other boot device, if you do not want to boot
-from the device aliased to
+Of course you may select any other boot device,
+if you do not want to boot from the device aliased to
 .Em disk ,
 see the discussion on devices above.
 .Sh FILES
@@ -155,22 +176,48 @@
 system bootstrap
 .El
 .Sh EXAMPLES
+Boot from
+.Tn CD-ROM :
+.Pp
 .Bd -literal -offset indent
 boot cdrom
 .Ed
-Boot from CDROM.
-Note that some multi-arch CDs are not able to use the
-default sparc64 partition for CDROMs (f), so they may require an explicit
-partition letter, for example
+.Pp
+Note that some multi-architecture CDs are not able to use the
+default sparc64 partition for
+.Tn CD-ROMs
+.Pq f ,
+so they may require an explicit partition letter, for example
 .Bd -literal -offset indent
 boot cdrom:c
 .Ed
+.Pp
+When using external
+.Tn SCSI
+.Tn CD-ROM
+drives it is important to know two things: the
+.Tn Sun
+firmware expects the
+.Tn SCSI
+ID to be six, and the drive must support 512-byte block reads,
+in addition to the standard 2048-byte reads.
+.Pp
 Another example:
 .Bd -literal -offset indent
 boot net -sd
 .Ed
+.Pp
 to boot single user from network and break into the kernel debugger as
 soon as possible.
+.Sh FILES
+.Bl -tag -width /netbsdxx -compact
+.It Pa /netbsd
+.Nx 
+kernel
+.It Pa /boot
+.Nx
+secondary bootstrap
+.El
 .Sh SEE ALSO
 .Xr disklabel 8 ,
 .Xr fsck 8 ,
@@ -179,6 +226,10 @@
 .Xr installboot 8 ,
 .Xr rc 8 ,
 .Xr shutdown 8 ,
-.Xr syslogd 8 ,
-.St - IEEE 1275 Open Firmware ,
-.Pa http://playground.sun.com/1275
+.Xr syslogd 8
+.Sh STANDARDS
+.Tn Sun
+developed its firmware and promoted it to become
+.St - IEEE 1275 Open Firmware
+.Pp
+.Pa http://playground.sun.com/1275/