Add explicit descriptions of the `filesystem', `primary', and `secondary'

arguments, including a clarification that `secondary' is relative to the root
of the filesystem, not a path name to that file if `filesystem' is mounted.
Resolves PR 20977 from Jim Bernard.
This commit is contained in:
lukem 2003-04-20 00:38:31 +00:00
parent 962f5ffade
commit 2a820a18cf
1 changed files with 53 additions and 24 deletions

View File

@ -1,6 +1,6 @@
.\" $NetBSD: installboot.8,v 1.27 2003/04/16 13:02:45 wiz Exp $
.\" $NetBSD: installboot.8,v 1.28 2003/04/20 00:38:31 lukem Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" Copyright (c) 2002-2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
@ -34,7 +34,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 15, 2003
.Dd April 20, 2003
.Dt INSTALLBOOT 8
.Os
.Sh NAME
@ -108,26 +108,6 @@ bootstrap program, which in turn loads and runs the kernel.
The secondary bootstrap may allow control over various boot parameters
passed to the kernel.
.Pp
Some platform
.Pq Fl m Ar machine
and file system type
.Pq Fl t Ar fstype
combinations require that the name of the secondary bootstrap is
supplied as
.Ar secondary ,
so that information such as the disk block numbers occupied
by the secondary bootstrap can be stored in the primary bootstrap.
These are:
.Bl -column "Platform" "File systems" -offset indent
.It Sy "Platform" Ta Sy "File systems"
.It macppc Ta ffs, raw
.It news68k Ta ffs, raw
.It newsmips Ta ffs, raw
.It sparc Ta ffs, raw
.It sun2 Ta ffs, raw
.It sun3 Ta ffs, raw
.El
.Pp
Perform the following steps to make a file system bootable:
.Bl -enum
.It
@ -159,7 +139,7 @@ and
.Pp
.El
.Pp
The options recognized by
The options and arguments recognized by
.Nm
are as follows:
.
@ -316,6 +296,55 @@ be provided with
.
.It Fl v
Verbose operation.
.
.It Ar filesystem
The path name of the device or file system image that
.Nm
is to operate on.
It is not necessary for
.Ar filesystem
to be a currently mounted file system.
.
.It Ar primary
The path name of the
.Dq primary
boot block to install.
.
.It Ar secondary
The path name of the
.Dq secondary
boot block,
relative to the top of
.Ar filesystem .
Most systems require
.Ar secondary
to be in the
.Dq root
directory of the file system, so the leading
.Dq Pa /
is not necessary on
.Ar secondary .
.Pp
Only certain combinations of
platform
.Pq Fl m Ar machine
and file system type
.Pq Fl t Ar fstype
require that the name of the secondary bootstrap is
supplied as
.Ar secondary ,
so that information such as the disk block numbers occupied
by the secondary bootstrap can be stored in the primary bootstrap.
These are:
.Bl -column "Platform" "File systems" -offset indent
.It Sy "Platform" Ta Sy "File systems"
.It macppc Ta ffs, raw
.It news68k Ta ffs, raw
.It newsmips Ta ffs, raw
.It sparc Ta ffs, raw
.It sun2 Ta ffs, raw
.It sun3 Ta ffs, raw
.El
.El
.Pp
.Nm