Synchronise shared text between man8/boot.8, man8/man8.i386/boot.8,

man8/man8.i386/dosboot.8, and man8/man8.i386/pxeboot.8.

* In all:
  - First few lines of each man page should be .Dd, .Os, .Dt, .Nm;
  - Use Nx; new sentence, new line; serial comma;
  - Update comments about which files to keep in sync.
* In MI boot(8):
  - add reference to architecture-specific boot(8);
  - add commented-out reference to boot.cfg(5);
  - reinstate BUGS heading that was lost when the MI boot.8 was
    created from i386 boot.8.
* In i386 boot.8:
  - mention -x and -z flags;
  - we can boot from media other than floppy, or from the network;
  - remove first paragraph in BUGS section now that an MI boot(8)
    man page exists.
* In i386 dosboot.8 and pxeboot.8:
  - mention -c, -x, and -z flags.
This commit is contained in:
apb 2007-12-14 12:03:53 +00:00
parent 86e1b8a4aa
commit 4ed89c84f0
4 changed files with 56 additions and 36 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: boot.8,v 1.5 2007/12/04 01:00:54 jmcneill Exp $
.\" $NetBSD: boot.8,v 1.6 2007/12/14 12:03:53 apb Exp $
.\"
.\" Copyright (c) 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -32,9 +32,9 @@
.\"
.\" @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
.\"
.Dd December 3, 2007
.Dt BOOT 8
.Dd December 14, 2007
.Os
.Dt BOOT 8
.Sh NAME
.Nm boot
.Nd
@ -43,11 +43,16 @@ system bootstrapping procedures
This document provides information on using common features in the
.Nx
boot loader.
Additional information may be found in
architecture-specific
.Xr boot 8
manual pages.
.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.
.\" NOTE: much of this text is duplicated in architecture-specific
.\" man pages (man8/man8.*/*boot*.8);
.\" please try to keep all relevant files synchronized.
.Bl -tag -width 04n -offset 04n
.It Xo Ic boot
.Op Va device : Ns
@ -166,6 +171,9 @@ can be used.
.Bl -tag -width /usr/mdec/bootxx_fstype -compact
.It Pa /boot
boot program code loaded by the primary bootstrap
.\" .It Pa /boot.cfg
.\" optional configuration file
.\" (used only on i386 and amd64 architectures)
.It Pa /netbsd
system code
.It Pa /netbsd.gz
@ -180,14 +188,18 @@ partition by
.Xr installboot 8 .
.El
.Sh SEE ALSO
Architecture-specific
.Xr boot 8
manual pages,
.Xr ddb 4 ,
.Xr userconf 4 ,
.\" .Xr boot.cfg 5 ,
.Xr boot_console 8 ,
.Xr halt 8 ,
.Xr installboot 8 ,
.Xr reboot 8 ,
.Xr shutdown 8
.Pp
.Sh BUGS
Any
.Ar filename
specified after the boot options, e.g.:

View File

@ -1,4 +1,4 @@
.\" $NetBSD: boot.8,v 1.39 2007/11/20 15:37:36 sborrill Exp $
.\" $NetBSD: boot.8,v 1.40 2007/12/14 12:03:53 apb Exp $
.\"
.\" Copyright (c) 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -32,9 +32,9 @@
.\"
.\" @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
.\"
.Dd June 29, 2006
.Dt BOOT 8 i386
.Dd December 14, 2007
.Os
.Dt BOOT 8 i386
.Sh NAME
.Nm boot
.Nd
@ -152,13 +152,14 @@ error messages should be self-explanatory.
.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.
.\" NOTE: much of this text is duplicated in the MI boot.8. Some of it is
.\" also duplicated in the i386-specific dosboot.8 and pxeboot.8;
.\" please try to keep all relevant files synchronized.
.Bl -tag -width 04n -offset 04n
.It Xo Ic boot
.Op Va device : Ns
.Op Va filename
.Op Fl acdqsv
.Op Fl acdqsvxz
.Xc
The default
.Va device
@ -214,12 +215,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.
@ -227,6 +228,10 @@ Boot the system in quiet mode.
Bring the system up in single-user mode.
.It Fl v
Boot the system in verbose mode.
.It Fl x
Boot the system with debug messages enabled.
.It Fl z
Boot the system in silent mode.
.El
.It Ic consdev Va dev
Immediately switch the console to the specified device
@ -246,7 +251,8 @@ 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.
operations.
Without an argument, print the current setting.
.Va device
is of the form specified in
.Cm boot .
@ -255,7 +261,7 @@ 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.
containing inode number, filename, and file type.
.Pa path
can contain a device specification.
.It Ic quit
@ -265,7 +271,8 @@ Reboot the system.
In an emergency, the bootstrap methods described in the
.Nx
installation notes for the i386 architecture
can be used to boot from floppy.
can be used to boot from floppy or other media,
or over the network.
.Sh FILES
.Bl -tag -width /usr/mdec/bootxx_fstype -compact
.It Pa /boot
@ -280,7 +287,9 @@ gzip-compressed system code
master copy of the boot program (copy to /boot)
.It Pa /usr/mdec/bootxx_fstype
primary bootstrap for filesystem type fstype, copied to the start of
the netbsd partition by
the
.Nx
partition by
.Xr installboot 8 .
.El
.Sh SEE ALSO
@ -297,11 +306,6 @@ the netbsd partition by
.Xr shutdown 8 ,
.Xr w95boot 8
.Sh BUGS
This manual page documents the
.Pa boot
interface, which is used by ports other than
.Nx Ns /i386 .
.Pp
Any
.Ar filename
specified after the boot options, e.g.:

View File

@ -1,4 +1,4 @@
.\" $NetBSD: dosboot.8,v 1.15 2003/04/07 06:56:43 wiz Exp $
.\" $NetBSD: dosboot.8,v 1.16 2007/12/14 12:03:53 apb Exp $
.\"
.\" Copyright (c) 1997
.\" Matthias Drochner. All rights reserved.
@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd May 13, 2000
.Dd December 14, 2007
.Os
.Dt DOSBOOT 8 i386
.Sh NAME
@ -100,16 +100,18 @@ Flags passed to the kernel, see
The commands accepted after the
.Fl c
flag or in interactive mode are:
.\" NOTE: much of this text is duplicated in boot.8; please try to
.\" keep both files synchronized.
.\" NOTE: some of this text is duplicated in the MI boot.8
.\" and in other i386-specific *boot.8 files;
.\" please try to keep all relevant files synchronized.
.Bl -tag -width 04n -offset 04n
.It Xo Ic boot
.Op Va device : Ns
.Op Va filename
.Op Fl adqsv
.Op Fl acdqsvxz
.Xc
Boot
.Nx . See
.Nx .
See
.Cm boot
in
.Xr boot 8

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pxeboot.8,v 1.9 2005/11/12 16:43:07 wiz Exp $
.\" $NetBSD: pxeboot.8,v 1.10 2007/12/14 12:03:53 apb Exp $
.\"
.\" Copyright (c) 2003
.\" Matthias Drochner. All rights reserved.
@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd November 12, 2005
.Dd December 14, 2007
.Os
.Dt PXEBOOT 8 i386
.Sh NAME
@ -186,12 +186,14 @@ kernel's behaviour.
.El
.Pp
The commands accepted in interactive mode are:
.\" NOTE: much of this text is duplicated in boot.8; please try to
.\" keep both files synchronized.
.\" NOTE: some of this text is duplicated in the MI boot.8
.\" and in other i386-specific *boot.8 files;
.\" please try to keep all relevant files synchronized.
.Bl -tag -width 04n -offset 04n
.It Xo Ic boot
.Op Va device : Ns
.Op Va filename
.Op Fl adqsv
.Op Fl acdqsvxz
.Xc
Boot
.Nx .