[src/trunk]: src/share/man/man8/man8.i386 Rototill boot.8 and dosboot.8. Fix ...

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

details:   https://anonhg.NetBSD.org/src/rev/15bc4107a383
branches:  trunk
changeset: 486098:15bc4107a383
user:      jhawk <jhawk%NetBSD.org@localhost>
date:      Sat May 13 05:27:21 2000 +0000

description:
Rototill boot.8 and dosboot.8. Fix a pile of mandoc usage, sort
options, sort SEE ALSOs, etc.

Add support for on-the-fly switching of console devices interactively
from biosboot via the "consdev" command.

diffstat:

 share/man/man8/man8.i386/boot.8    |  173 +++++++++++++++++++++++++-----------
 share/man/man8/man8.i386/dosboot.8 |  126 ++++++++++++++++++--------
 2 files changed, 207 insertions(+), 92 deletions(-)

diffs (truncated from 447 to 300 lines):

diff -r 50d9e6e47483 -r 15bc4107a383 share/man/man8/man8.i386/boot.8
--- a/share/man/man8/man8.i386/boot.8   Sat May 13 05:25:58 2000 +0000
+++ b/share/man/man8/man8.i386/boot.8   Sat May 13 05:27:21 2000 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: boot.8,v 1.10 2000/03/06 01:44:29 hubertf Exp $
+.\"    $NetBSD: boot.8,v 1.11 2000/05/13 05:27:21 jhawk Exp $
 .\"
 .\" Copyright (c) 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -36,7 +36,7 @@
 .\"
 .\"     @(#)boot_i386.8        8.2 (Berkeley) 4/19/94
 .\"
-.Dd March 13, 1997
+.Dd May 12, 2000
 .Dt BOOT 8 i386
 .Os
 .Sh NAME
@@ -44,12 +44,12 @@
 .Nd
 system bootstrapping procedures
 .Sh DESCRIPTION
-.Sy Power fail and crash recovery.
+.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,
 and unless this fails, the system will resume multi-user operations.
 .Pp
-.Sy Cold starts.
+.Ss Cold starts
 The 386
 .Tn "PC AT"
 clones attempt to boot the floppy disk drive A (otherwise known as drive
@@ -59,11 +59,13 @@
 .Nx
 bootblocks are loaded and started either by the BIOS, or by
 a boot selector program (such as OS-BS, BOOTEASY, the OS/2 Boot Menu or
-.Nx 's
-boot-selecting master boot record - see
+.Nx No 's
+.No boot-selecting
+master boot record - see
 .Xr mbr 8 ).
 .Pp
-Once running, a prompt similar to the following will appear.
+.Ss Normal Operation
+Once running, a banner similar to the following will appear:
 .Bd -unfilled -offset indent
 >> NetBSD BIOS Boot, revision 2.2
 >> (user@buildhost, builddate)
@@ -73,7 +75,7 @@
 booting wd0a:netbsd - starting in 5
 .Ed
 .Pp
-After a countdown the system image listed will be loaded. (In the
+After a countdown, the system image listed will be loaded. (In the
 above example, it will be
 .Dq Li wd0a:netbsd
 which is the file
@@ -85,53 +87,118 @@
 MBR partition of the first hard disk known to the BIOS [which is
 appearently an IDE or similar device - see the
 .Em BUGS
-section].)
+section].) Pressing a key within the time limit will enter
+interactive mode.
 .Pp
-The default disk will be set to the disk that the boot loader was
+.Ss Interactive mode
+In interactive mode, the boot loader will present a prompt, allowing
+input of these commands:
+.\" NOTE: much of this text is duplicated in dosboot.8; please try to
+.\" keep both files synchronized.
+.Bl -tag -width 04n -offset 04n
+.It Xo Ic boot
+.Op Va device : Ns
+.Op Va filename
+.Op Fl adrs
+.Xc
+The default
+.Va device
+will be set to the disk that the boot loader was
 loaded from.
 To boot from an alternate disk, the full name of the device should
-be given at the prompt.
-.Pp
-The default image is 
-.Dq Li netbsd ;
-if the boot loader fails to successfully
-open that image, it then tries
-.Dq Li netbsd.gz
-(expected to be a kernel image compressed by gzip), followed by
-.Dq Li netbsd.old ,
-.Dq Li netbsd.old.gz ,
-.Dq Li onetbsd ,
-and finally
-.Dq Li onetbsd.gz .
-Alternate system images can be loaded by just specifying the name of the image.
+be given at the prompt).
+.Va device
+is of the form
+.Xo Va xd 
+.Op Va N Ns Op Va x
+.Xc
+where
+.Va xd
+is the device from which to boot,
+.Va N
+is the unit number, and
+.Va x
+is the partition letter.
 .Pp
 The following list of supported devices may vary from installation to
 installation:
-.Bd -unfilled -offset indent
-sd     SCSI disks on a controller recognized by the BIOS. The unit
-       number is the BIOS device number.
-wd     ST506, IDE, ESDI, RLL disks on a WD100[2367] or
-       lookalike controller(s), as numbered by the BIOS.
-hd     Hard disks as numbered by the BIOS.
-fd     Floppy drives as numbered by the BIOS.
-.Ed
+.Pp
+.Bl -hang -compact
+.It sd
+SCSI disks on a controller recognized by the BIOS. The 
+unit number is the BIOS device number.
+.It wd
+ST506, IDE, ESDI, RLL disks on a WD100[2367] or
+lookalike controller(s), as numbered by the BIOS.
+.It hd
+Hard disks as numbered by the BIOS.
+.It fd
+Floppy drives as numbered by the BIOS.
+.El
+.Pp
+The default 
+.Va filename
+is 
+.Pa netbsd ;
+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
+.Pa netbsd.old ,
+.Pa netbsd.old.gz ,
+.Pa onetbsd ,
+and finally
+.Pa onetbsd.gz .
+Alternate system images can be loaded by just specifying the name of the image.
 .Pp
-The
-.Op Fl s
-flag to the boot loader will bring the system up in single-user mode.
-The
-.Op Fl a
-flag instructs the system to prompt for the location of the root filesystem
-and the system crash dump device.
-The
-.Op Fl r
-flag instructs the system to use the compiled in value for the root
+Options are:
+.Bl -tag -width xxx
+.It Fl a
+Prompt for the location of the root filesystem and the system crash
+dump device.
+.It Fl d
+Bring the system up in debug mode.  Here it waits for a kernel
+debugger connect; see
+.Xr ddb 4 .
+.It Fl r
+Instructs the system to use the compiled in value for the root
 device, not the device the system image was loaded from.
-The
-.Op Fl d
-flag to the boot loader will bring the system up in debug mode.
-Here it waits for a kernel debugger connect; see
-.Xr ddb 4 .
+.It Fl s
+Bring the system up in single-user mode.
+.El
+.It Ic consdev Va dev
+Immediately switch the console to the specified device
+.Va dev
+and reprint the banner.
+.Va dev
+must be one of
+.\" .Bl -item -width com[0123]kbd -offset indent -compact
+.Ar pc , com0 , com1 , com2 ,
+.Ar com3 , com0kbd , com1kbd , com2kbd ,
+.Ar com3kbd ,
+or
+.Ar auto .
+See
+.Sx Console Selection Policy
+in
+.Xr boot_console 8 .
+.It Ic dev Op Va device
+Set the default drive and partition for subsequent filesystem
+operations. Without an argument, print the current setting.
+.Va device
+is of the form specified in
+.Cm boot .
+.It Ic help
+Print an overview about commands and arguments.
+.It Ic ls Op Pa path
+Print a directory listing of
+.Pa path ,
+containing inode number, filename and file type.
+.Pa path
+can contain a device specification.
+.It Ic quit
+Reboot the system.
+.El
 .Pp
 In an emergency, the bootstrap methods described in the
 .Nx
@@ -144,25 +211,25 @@
 .It Pa /netbsd.gz
 gzip-compressed system code
 .It Pa /usr/mdec/biosboot.sym
-boot block (not installed)
+boot block (read by installboot)
 .It Pa /boot
-boot block (installed).
+boot block (written by installboot).
 .El
 .Sh SEE ALSO
 .Xr boot_console 8 ,
 .Xr ddb 4 ,
+.Xr dosboot 8 ,
 .Xr halt 8 ,
 .Xr installboot 8 ,
+.Xr mbr 8
 .Xr reboot 8 ,
 .Xr shutdown 8 ,
-.Xr dosboot 8 ,
-.Xr mbr 8
 .Sh BUGS
 Hard disks are always accessed by BIOS functions. Unit numbers are
 BIOS device numbers which might differ from numbering in the
 .Nx
-kernel or physical parameters (eg SCSI slave numbers). The distiction
-into
+kernel or physical parameters (eg SCSI slave numbers). The distinction
+between
 .Dq sd
 and
 .Dq wd
diff -r 50d9e6e47483 -r 15bc4107a383 share/man/man8/man8.i386/dosboot.8
--- a/share/man/man8/man8.i386/dosboot.8        Sat May 13 05:25:58 2000 +0000
+++ b/share/man/man8/man8.i386/dosboot.8        Sat May 13 05:27:21 2000 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: dosboot.8,v 1.7 2000/03/05 23:55:56 nathanw Exp $
+.\"    $NetBSD: dosboot.8,v 1.8 2000/05/13 05:27:21 jhawk Exp $
 .Dd June 20, 1997
 .Os
 .Dt DOSBOOT 8 i386
@@ -8,40 +8,58 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl u
-.Op Fl c Ar <command>
+.Op Fl c Ar command
 .Op Fl i
-.Op Ar path Op Fl bootopts
+.Op Ar path Op Fl adrs
 .Sh DESCRIPTION
 .Nm
-is an MS-DOS program.  It is a boot loader for the i386 version of
-.Nx
+is an 
+.Tn MS-DOS
+program.  It is a boot loader for
+.Nx Ns Tn /i386
 designed to permit
 .Nx
-to be booted directly from MS-DOS. Per default, it boots a file with
+to be booted directly from 
+.Tn MS-DOS .
+By default, it boots a file with
 name
 .Pa NETBSD
-in the current MS-DOS directory.
+in the current 
+.Tn MS-DOS
+directory.
+.Nm
+shares common code with the standard boot loader,
+.Xr boot 8 .
 .Pp
-The recognized options are
-.Bl -tag -width bootopts
+The recognized options are:
+.Bl -tag -width -adrs
 .It Fl u
-Boot from an UFS filesystem instead of an MS-DOS filesystem.
+Boot from a UFS filesystem instead of an 
+.Tn MS-DOS
+filesystem.