xref: /openbsd-src/usr.sbin/installboot/installboot.8 (revision 46035553bfdd96e63c94e32da0210227ec2e3cf1)
1.\"	$OpenBSD: installboot.8,v 1.4 2014/01/18 18:14:21 jmc Exp $
2.\"
3.\" Copyright (c) 2013, 2014 Joel Sing
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: January 18 2014 $
18.Dt INSTALLBOOT 8
19.Os
20.Sh NAME
21.Nm installboot
22.Nd install bootstrap on a disk
23.Sh SYNOPSIS
24.Nm installboot
25.Op Fl nv
26.Op Fl r Ar root
27.Ar disk
28.Op Ar stage1 Op Ar stage2
29.Sh DESCRIPTION
30.Nm
31installs bootstrap on the specified disk.
32The exact process used depends on the system architecture, however there is
33generally a primary bootstrap (often known as a boot block) and a
34secondary bootstrap (often known as a boot loader).
35Some architectures only require a single stage bootstrap, which is written to
36the beginning of the disk.
37.Pp
38The options are as follows:
39.Bl -tag -width Ds
40.It Fl n
41Perform a dry run - do not actually write any bootstrap to the disk.
42.It Fl r Ar root
43Specify the mount point of the
44.Ar root
45filesystem to operate on, defaulting to
46.Ar / .
47.It Fl v
48Increase verbosity during operation.
49.It Ar disk
50Specify the
51.Ar disk
52to install the bootstrap on.
53This may be specified using a full pathname, an abbreviated disk form,
54or a disklabel UID.
55.It Ar stage1
56Specify the file to use for the primary bootstrap.
57If not specified, the default for this architecture will be used.
58.It Ar stage2
59Specify the file to use for the secondary bootstrap.
60If not specified, the default for this architecture will be used.
61.El
62.Sh EXAMPLES
63In its most basic form, to install bootstrap on
64.Ar disk
65sd0, using the default primary and secondary bootstrap files:
66.Bd -literal -offset 3n
67# installboot sd0
68.Ed
69.Pp
70To install bootstrap on an
71.Ox
72amd64 machine, using
73.Ar /usr/mdec/biosboot
74as the primary bootstrap and
75.Ar /usr/mdec/boot
76as the secondary bootstrap:
77.Bd -literal -offset 3n
78# installboot -v wd0 /usr/mdec/biosboot /usr/mdec/boot
79.Ed
80.Sh SEE ALSO
81.Xr disklabel 8
82