This file and its contents are supplied under the terms of the
Common Development and Distribution License ("CDDL"), version 1.0.
You may only use this file in accordance with the terms of version
1.0 of the CDDL.

A full copy of the text of the CDDL should have accompanied this
source. A copy of the CDDL is also available via the Internet at
http://www.illumos.org/license/CDDL.


Copyright 2016 Toomas Soome <tsoome@me.com>

.Dd February 10, 2016 .Dt INSTALLBOOT 1M .Os .Sh NAME .Nm installboot .Nd install bootloader in a disk partition .Sh SYNOPSIS .Ss SPARC .Nm .Op Fl fn .Op Fl F Sy zfs Ns | Ns Sy ufs Ns | Ns Sy hsfs .Op Fl u Ar verstr .Ar bootblk raw-device .Nm .Op Fl enV .Fl F Sy zfs .Fl i .Ar raw-device .Nm .Op Fl n .Fl F Sy zfs .Fl M .Ar raw-device attach-raw-device .Ss x86 .Nm .Op Fl fFmn .Op Fl u Ar verstr .Ar stage1 stage2 raw-device .Nm .Op Fl enV .Fl i .Ar raw-device .Nm .Op Fl n .Fl M .Ar raw-device attach-raw-device .Sh DESCRIPTION The .Xr boot 1M boot program is loaded from disk and is responsible of loading kernel and its support files from specific file system.

p The SPARC systems have one boot loader program file to be installed on the boot area of a disk slice. As the SPARC zfs boot loader is too large to fit into boot area at the start of the disk slice, .Nm command will split the zfs boot loader between disk slice boot area, and zfs pool boot area.

p The x86 systems have boot loader implemented as three stages: l -tag -width Ds t Sy stage1

a /boot/pmbr is used as master boot record

q MBR and partition boot program. t Sy stage2

a /boot/gptzfsboot is responsible for loading files from file system. The .Sy stage2 on x86 systems is always installed to zfs pool boot area, and therefore only zfs boot is supported. .Nm command will record the location of .Sy stage2 to .Sy stage1 , which is always installed at least on partition

q MBR or GPT boot area, making it possible to boot via chainload from other boot loaders.

p When .Nm command is used with the .Fl m option, .Nm installs the stage1 file on the master boot sector of the disk as well. t Sy stage3

a /boot/zfsloader is read from file system and executed by .Sy stage2 and will provide boot loader user environment and is responsible of loading and starting the operating system kernel.

p In case of GPT partitioning scheme, if the file system to boot from is either UFS or PCFS, there must be .Sy boot partition defined to store stage2 boot program. This is needed because UFS and PCFS do not have sufficient space reserved to store boot programs.

p The boot partition must use following GPT UUID: d -literal -offset indent 6a82cb45-1dd2-11b2-99a6-080020736631 .Ed

p which is provided by .Qq boot tag in .Xr format 1M partition menu. .El .Ss Options The .Nm command accepts the following options: l -tag -width Ds t Fl h Prints short usage message. t Fl m Installs .Sy stage1 on the master boot sector interactively. You must use this option if OS is installed on an extended FDISK or an EFI/GPT partition. t Fl f Suppresses interaction when overwriting the master boot sector on x86. Force update on SPARC. t Fl n Dry run session. Will not write to disk. t Fl F On SPARC, specify file system type. On x86, inhibit version check and enforce boot loader update. t Fl u Ar verstr Specify custom version string. Can be used to add version on non-versioned boot loader or change built in version string. t Fl i Print version string from installed boot loader. t Fl e Print version string from installed boot loader without description. t Fl V Print version string from installed boot loader with full description. t Fl M Mirror boot loader from installed disk partition. .El .Ss Operands The .Nm command accepts the following operands: l -tag -width Ds t Ar bootblk The name of the SPARC boot loader code. t Ar stage1 The name of the loader stage 1 file. t Ar stage2 The name of the loader stage 2 file. t Ar raw-device The name of the device onto which bootloader code is to be installed. It must be a character device that is readable and writable and part of boot pool. .El .Sh FILES l -tag -width Ds t Pa /boot Directory where x86 loader files reside. t Pa /usr/platform/platform name/lib/fs Directory where SPARC boot loader files reside. .El .Sh EXAMPLES l -tag -width Ds t Sy Example 1 No Installing zfs boot loader on SPARC disk slice The following command installs zfs boot loader on SPARC system: d -literal # installboot -F zfs /usr/platform/`uname -i`/lib/fs/zfs/bootblk \e /dev/rdsk/c0t0d0s0 .Ed t Sy Example 2 No Installing boot loader on x86 system The following command installs loader stage files and master boot record: d -literal # installboot -m /boot/pmbr /boot/gptzfsboot /dev/rdsk/c0t0d0s0 .Ed .El .Sh INTERFACE STABILITY .Sy Uncommitted .Sh SEE ALSO .Xr boot 1M , .Xr bootadm 1M , .Xr fdisk 1M , .Xr fmthard 1M , .Xr format 1M , .Xr kernel 1M , .Xr attributes 5 .Sh WARNINGS Installing .Sy stage1 on the master boot sector

o .Fl m option

c overrides any boot loader currently installed on the machine. The system will always boot the current OS partition regardless of which fdisk partition is active.

p If version string indicates the source boot loader might be more recent, .Nm will also verify md5 checksums to determine if update is really necessary. If checksums match, the install will not be performed.