1.\" 2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3.\" 4.\" Copyright (c) 2018 Mateusz Piotrowski <0mp@FreeBSD.org> 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" $FreeBSD$ 28.Dd August 20, 2018 29.Dt BEINSTALL.SH 1 30.Os 31.Sh NAME 32.Nm beinstall.sh 33.Nd "install a boot environment using the current FreeBSD source tree" 34.Sh SYNOPSIS 35.Nm 36.Op Ar options Ar ... 37.Sh DESCRIPTION 38.Nm 39installs a boot environment using the current 40.Fx 41source tree. 42.Nm 43also automatically performs 44.Pa /etc 45updates 46(using either 47.Xr etcupdate 8 48or 49.Xr mergemaster 8 ) 50and 51package updates using 52.Xr pkg-upgrade 8 53automatically in the new boot environment sandbox. 54.Pp 55Upon successful completion, the system will be ready to boot into the new boot 56environment. 57Upon failure, the target boot environment will be destroyed. 58In all cases, the running system is left untouched 59and a reboot into a partially updated system 60(due to install or hardware failure) cannot happen. 61Additionally, the full installation process requires 62only one reboot as it is performed 63in a new boot environment. 64.Pp 65.Nm 66requires a fully built world and kernel. 67It also requires 68.Xr beadm 1 69and 70.Xr pkg 8 , 71which are not present in the base system and have to be installed manually. 72.Pp 73The 74.Ar options 75provided to 76.Nm 77are world and kernel flags like 78.Ev KERNCONF 79as described in 80.Xr build 7 . 81.Sh ENVIRONMENT 82User modifiable variables. 83Set these in the environment if desired: 84.Bl -tag -width indent 85.It Ev CONFIG_UPDATER Pq default: Dq Li "etcupdate" 86Config updater: 87.Xr etcupdate 8 88and 89.Xr mergemaster 8 90are supported. 91Set to an empty string to skip. 92.It Ev ETCUPDATE_FLAGS Pq default: Dq Li "-F" 93Flags for 94.Xr etcupdate 8 95if used. 96.It Ev MERGEMASTER_FLAGS Pq default: Dq Li "-iFU" 97Flags for 98.Xr mergemaster 8 99if used. 100.It Ev NO_PKG_UPGRADE Pq default: Dq Li "" 101If not empty, 102.Dq Li pkg upgrade 103will be skipped. 104.El 105.Sh FILES 106.Bl -tag -width indent 107.It Sy src/ Ns Pa tools/build/beinstall.sh 108Place where 109.Nm 110lives in the src tree. 111.El 112.Sh SEE ALSO 113.Xr beadm 1 , 114.Xr build 7 , 115.Xr development 7 , 116.Xr etcupdate 8 , 117.Xr mergemaster 8 , 118.Xr pkg 8 119.Sh HISTORY 120.Nm 121is inspired by and similar in function to 122Solaris/illumos-style upgrades. 123.Pp 124The 125.Nm 126manual page first appeared in 127.Fx 12.0 . 128.Sh AUTHORS 129The 130.Nm 131script was implemented by 132.An Will Andrews Aq Mt will@FreeBSD.org . 133This manual page was written by 134.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org . 135