>Number:         1386
>Category:       bin
>Synopsis:       man pages for reboot(8) are inconsistant
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people (Utility Bug People)
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Aug 20 01:05:02 1995
>Last-Modified:
>Originator:     Luke Mewburn
>Organization:
Werj
>Release:        NetBSD-current 950813
>Environment:
>Description:
	The various manual pages associated with reboot(8),
	boot_*(8), are inconsistant with each other.  boot_i386(8)
	is totally misleading (it doesn't document the behaviour
	of the current boot blocks), and other boot_*(8) pages
	need minor work (e.g, boot_mac68k has a header that is too
	long, boot_sun3 has a synopsis for 'reboot' which is
	unecessary, boot_pmax doesn't show which architecture it's
	for in the header.)

	Also, there is no manual for boot(8). It should be a link
	from the relevant boot_${MACHINE}(8) page.

>How-To-Repeat:
>Fix:
	Apply this patch in /usr/src/sbin/reboot. 
	Please note that whilst my explaination in boot_i386
	may not be perfect, it's much closer to actuality than
	what's currently there...

*** Makefile.orig	Sun Aug 20 11:07:59 1995
--- Makefile	Sun Aug 20 14:15:25 1995
***************
*** 6,12 ****
  LDADD=	-lutil
  MAN=	reboot.8 boot_hp300.8 boot_i386.8 boot_mac68k.8 boot_pmax.8 \
  	boot_sparc.8 boot_sun3.8 boot_tahoe.8 boot_vax.8
! MLINKS=	reboot.8 halt.8
  LINKS=	${BINDIR}/reboot ${BINDIR}/halt
  
  .include <bsd.prog.mk>
--- 6,12 ----
  LDADD=	-lutil
  MAN=	reboot.8 boot_hp300.8 boot_i386.8 boot_mac68k.8 boot_pmax.8 \
  	boot_sparc.8 boot_tahoe.8 boot_vax.8
! MLINKS=	reboot.8 halt.8 boot_${MACHINE}.8 boot.8
  LINKS=	${BINDIR}/reboot ${BINDIR}/halt
  
  .include <bsd.prog.mk>
*** boot_hp300.8.orig	Sun Aug 20 11:11:35 1995
--- boot_hp300.8	Sun Aug 20 11:11:45 1995
***************
*** 38,44 ****
  .\"	@(#)boot_hp300.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt BOOT_HP300 8 hp300
  .Os
  .Sh NAME
  .Nm boot
--- 38,44 ----
  .\"	@(#)boot_hp300.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt BOOT 8 hp300
  .Os
  .Sh NAME
  .Nm boot
*** boot_i386.8.orig	Sun Aug 20 13:52:50 1995
--- boot_i386.8	Sun Aug 20 14:24:35 1995
***************
*** 55,128 ****
  clones attempt to boot the floppy disk drive A (otherwise known as drive
  0) first, and failing that, attempt to boot the hard disk C (otherwise
  known as hard disk controller 1, drive 0).
! The automatic boot will attempt to load
! .Pa netbsd
! from partition A of either the floppy or the hard disk.
! This boot may be aborted by typing any character on the keyboard repeatedly
! (four or five times at least) during the operating system load phase, after
! which the bootstrap will prompt for the file that you wish to load instead.
! .Pp
! One exception to this is the
! .Ql d
! key, which will not abort the load but instead silently force the
! .Dv DEBUG
! boot flags.
! The boot flags for an autoboot are 0, and 3 for the successive boot after
! an aborted autoboot sequence.
! No other provison is made for setting boot flags (yet).
! A specific device or bootstrap file may be used; for example,
! .Pp
! The file specifications used for the boostrap
! when loaded with the
! .Dq askme
! flag
! (e.g. an aborted autoboot)
! are of the form:
! .Pp
! .Dl device unit partition:
! .Pp
! where
! .Ar device
! is the type of the device, assumed to be on the ISA bus, to be searched,
! .Ar unit
! is the unit number of the disk or tape,
! and
! .Ar partition
! is the disk partition or tape file number.
! Normal line editing characters can be used when typing the file specification.
  The following list of supported devices may vary from installation to
  installation:
  .Bd -unfilled -offset indent
! wd	ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
! 	controller
  fd	5 1/4" or 3 1/2" High density floppies
  .Ed
  .Pp
! For example,
! to boot from a file system which starts at cylinder 0
! of unit 0 of an IDE disk, type
! .Dq Li wd0a:netbsd
! to the boot prompt;
! .Dq Li fd0a:netbsd
! would specify a 3 1/2" floppy drive 0 .
  .Pp
  In an emergency, the bootstrap methods described in the paper
  .%T "Installing and Operating 4.3 BSD-Reno UNIX on the AT/386"
  can be used
  to boot from a distribution tape.
  .Sh FILES
! .Bl -tag -width /netbsdxx -compact
  .It Pa /netbsd
  system code
! .It Pa /boot
! system bootstrap
  .El
  .Sh SEE ALSO
  .Xr halt 8 ,
  .Xr reboot 8 ,
  .Xr shutdown 8
- .Sh BUGS
- The disklabel format used by this version of
- .Bx
- is quite
- different from that of other architectures.
--- 55,128 ----
  clones attempt to boot the floppy disk drive A (otherwise known as drive
  0) first, and failing that, attempt to boot the hard disk C (otherwise
  known as hard disk controller 1, drive 0).
! The NetBSD bootblocks are loaded and started either by the BIOS, or by
! a boot selector program (such as OS-BS, BOOTEASY, or the OS/2 Boot Menu)
! .Pp
! Once running, a prompt similar to the following will appear.
! .Bd -unfilled -offset indent
! >> NetBSD BOOT: 637/15360 k [1.27]
! use hd(1,a)/netbsd to boot sd0 when wd0 is also installed
! Boot: [[wd(0,a)]/netbsd][-adrs]] :-
! .Ed
! .Pp
! After a short delay the system image listed will be loaded. (In the
! above example, it will be
! .Dq Li wd(0,a)/netbsd
! which is the file
! .Nm netbsd
! on partition A of the first non-SCSI hard disk)
! .Pp
! The default disk 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. Alternate system images can be loaded by
! just specifying the name of the image.
! .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
! wd	ST506, IDE, ESDI, RLL disks on a WD100[2367] or
! 	lookalike controller
! hd	A hard disk as numbered by the BIOS. Must be used
! 	to boot from the second disk (D:) when it is SCSI
! 	and the first disk (C:) is non SCSI.
  fd	5 1/4" or 3 1/2" High density floppies
  .Ed
  .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 primary swap partition.
! The
! .Op Fl r
! flag 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 8 .
! Other flags are currently ignored.
  .Pp
  In an emergency, the bootstrap methods described in the paper
  .%T "Installing and Operating 4.3 BSD-Reno UNIX on the AT/386"
  can be used
  to boot from a distribution tape.
  .Sh FILES
! .Bl -tag -width /usr/mdec/xxboot -compact
  .It Pa /netbsd
  system code
! .It Pa /usr/mdec/xxboot
! sector-0 boot block, xx is disk type
! .It Pa /usr/mdec/bootxx
! second-stage boot, xx is disk type
  .El
  .Sh SEE ALSO
+ .Xr ddb 8 ,
  .Xr halt 8 ,
  .Xr reboot 8 ,
  .Xr shutdown 8
*** boot_mac68k.8.orig	Sun Aug 20 13:52:58 1995
--- boot_mac68k.8	Sun Aug 20 11:16:56 1995
***************
*** 39,45 ****
  .\"	@(#)boot_hp300.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd July 1, 1995
! .Dt BOOT_MAC68K 8 mac68k
  .Os
  .Sh NAME
  .Nm boot
--- 39,45 ----
  .\"	@(#)boot_hp300.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd July 1, 1995
! .Dt BOOT 8 mac68k
  .Os
  .Sh NAME
  .Nm boot
***************
*** 117,123 ****
  system kernel
  .El
  .Sh SEE ALSO
! .Xr ddb 8
! .Xr savecore 8
! .Xr shutdown 8
  .Xr ttys 5
--- 117,123 ----
  system kernel
  .El
  .Sh SEE ALSO
! .Xr ddb 8 ,
! .Xr savecore 8 ,
! .Xr shutdown 8 ,
  .Xr ttys 5
*** boot_pmax.8.orig	Sun Aug 20 11:12:27 1995
--- boot_pmax.8	Sun Aug 20 11:12:32 1995
***************
*** 36,42 ****
  .\" SUCH DAMAGE.
  .\"
  .Dd July 23, 1991
! .Dt BOOT 8
  .Os
  .Sh NAME
  .Nm boot
--- 36,42 ----
  .\" SUCH DAMAGE.
  .\"
  .Dd July 23, 1991
! .Dt BOOT 8 pmax
  .Os
  .Sh NAME
  .Nm boot
*** boot_sparc.8.orig	Sun Aug 20 11:12:39 1995
--- boot_sparc.8	Sun Aug 20 11:13:52 1995
***************
*** 34,50 ****
  .\"     @(#)boot_sparc.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt REBOOT 8 sparc
  .Os
  .Sh NAME
! .Nm reboot
  .Nd
  .Tn UNIX
  bootstrapping procedures
- .Sh SYNOPSIS
- .Nm reboot
- .Op Fl n
- .Op Fl q
  .Sh DESCRIPTION
  .Sy Power fail and crash recovery.
  Normally, the system will reboot itself at power-up or after crashes.
--- 34,46 ----
  .\"     @(#)boot_sparc.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt BOOT 8 sparc
  .Os
  .Sh NAME
! .Nm boot
  .Nd
  .Tn UNIX
  bootstrapping procedures
  .Sh DESCRIPTION
  .Sy Power fail and crash recovery.
  Normally, the system will reboot itself at power-up or after crashes.
*** boot_sun3.8.orig	Sun Aug 20 13:53:19 1995
--- boot_sun3.8	Sun Aug 20 14:22:33 1995
***************
*** 34,50 ****
  .\"     @(#)boot_sparc.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt REBOOT 8 sun3
  .Os
  .Sh NAME
! .Nm reboot
  .Nd
  .Tn UNIX
  bootstrapping procedures
- .Sh SYNOPSIS
- .Nm reboot
- .Op Fl n
- .Op Fl q
  .Sh DESCRIPTION
  .Sy Power fail and crash recovery.
  Normally, the system will reboot itself at power-up or after crashes.
--- 34,46 ----
  .\"     @(#)boot_sparc.8	8.2 (Berkeley) 4/19/94
  .\"
  .Dd April 19, 1994
! .Dt BOOT 8 sun3
  .Os
  .Sh NAME
! .Nm boot
  .Nd
  .Tn UNIX
  bootstrapping procedures
  .Sh DESCRIPTION
  .Sy Power fail and crash recovery.
  Normally, the system will reboot itself at power-up or after crashes.
***************
*** 65,71 ****
  .Pp
  The
  .Op Fl s
! flag to the boot loader will being the system up in single-user mode.
  The
  .Op Fl a
  flag instructs the system to prompt for the location of the root filesystem
--- 61,67 ----
  .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
>Audit-Trail:
>Unformatted: