1.\" Copyright (c) 2000 2.\" Mike W. Meyer 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: src/share/man/man7/build.7,v 1.19.2.1 2002/03/18 08:33:02 murray Exp $ 26.\" 27.Dd November 23, 2018 28.Dt BUILD 7 29.Os 30.Sh NAME 31.Nm build 32.Nd information on how to build the system 33.Sh DESCRIPTION 34The source for the 35.Dx 36system and applications is located in 37.Pa /usr/src . 38This directory contains the 39.Dq "base system" 40sources, which is loosely defined as the things required to rebuild 41the system to a useful state. 42It also contains the source for the system documentation, including 43manual pages. 44Refer to 45.Xr development 7 46for more information on how to obtain the 47.Dx 48sources. 49.Pp 50Third party applications have to be built using the 51.Xr dports 7 52system. 53The file 54.Pa /usr/Makefile 55has targets for obtaining the dports tree. 56Typing 57.Li make 58in 59.Pa /usr 60gives specifics on how to obtain the tree for building packages. 61.Pp 62The 63.Xr make 1 64command is used in 65.Pa /usr/src 66to build and install the things in that directory. 67Issuing the 68.Xr make 1 69command in any directory or 70subdirectory of those directories has the same effect as issuing the 71same command in all subdirectories of that directory. 72With no target specified, the things in that directory are just built. 73The following list provides the names and actions for other targets: 74.Bl -tag -width ".Cm install" 75.It Cm clean 76Removes any files created during the build process. 77.It Cm install 78Installs the results of the build for this directory. 79.El 80.Pp 81The other 82.Pa /usr/src 83make targets are: 84.Bl -tag -width ".Cm installworld-force" 85.It Cm buildworld 86Rebuild everything but the kernel. 87.It Cm quickworld 88Same as 89.Cm buildworld , 90but skip bootstrap, build and cross-build tool steps. 91This target can be used for incremental upgrades once a full build of the 92world has been done with 93.Cm buildworld . 94.It Cm realquickworld 95Same as 96.Cm quickworld , 97but also skip the depend step. 98.It Cm crossworld 99Just do the bootstrap, build and cross-build steps. 100.It Cm installworld 101Install everything built by 102.Cm buildworld , 103as well as the rescue tools and the initial ramdisk if they do not exist 104yet. 105.It Cm installworld-force 106Force an 107.Cm installworld . 108This will install to a temporary directory, then copy the main binaries 109and libraries with a static 110.Xr cpdup 1 111to 112.Ev DESTDIR 113and finally will issue a normal 114.Cm installworld 115and 116.Cm upgrade . 117It is a special case to be used on older systems as a last resort when 118the normal 119.Cm installworld 120doesn't work. 121.It Cm world 122.Cm buildworld + 123.Cm installworld . 124.It Cm buildkernel 125Rebuild the kernel and the kernel-modules. 126.It Cm nativekernel 127Rebuild the kernel and the kernel-modules using native tools. 128.It Cm quickkernel 129Same as 130.Cm buildkernel , 131but do not clean out the obj modules. 132This target can be used for incremental upgrades once a full 133build of the kernel has been done with 134.Cm buildkernel . 135.It Cm realquickkernel 136Same as 137.Cm quickkernel , 138but also skip the depend step. 139.It Cm installkernel 140Install the kernel and the kernel-modules. 141.It Cm reinstallkernel 142Reinstall the kernel and the kernel-modules. 143.It Cm kernel 144.Cm buildkernel + 145.Cm installkernel . 146.It Cm preupgrade 147Perform certain upgrades that have to be done before 148.Cm installworld , 149such as adding new users and groups. 150.Cm installworld 151will complain if they have not been done. 152.It Cm upgrade 153Upgrade the files in /etc and also setup the rest of the system for 154the version of 155.Dx 156just installed. 157.It Cm initrd 158Install the statically linked rescue tools and the initial ramdisk built by 159.Cm buildworld . 160.It Cm backupworld 161Manually archive binaries from installed world to location specified by 162.Ev WORLD_BACKUP . 163.It Cm backup-clean 164Delete archive created by 165.Cm backupworld . 166.It Cm backup-auto-clean 167Delete archive created automatically during 168.Cm installworld . 169.It Cm restoreworld 170Restore binaries from archive created by 171.Cm backupworld . 172.It Cm restoreworld-auto 173Restore binaries from archive created automatically during 174.Cm installworld . 175The archive location is specified by 176.Ev AUTO_BACKUP . 177.El 178.Sh ENVIRONMENT 179.Bl -tag -width ".Ev MAKEOBJDIRPREFIX" 180.It Ev TARGET_ARCH , TARGET_PLATFORM 181The target machine processor architecture and hardware platform. 182These have to be set for cross-building. 183.Ev TARGET_ARCH 184is analogous to the 185.Dq Nm uname Fl p 186output. 187For the 64 bit 188.Tn AMD 189architecture known as AMD64, x86-64 or Intel 64, use: 190.Bd -literal -offset indent 191TARGET_ARCH=x86_64 192TARGET_PLATFORM=pc64 193.Ed 194.It Ev DESTDIR 195An existing directory to be the root of 196the hierarchy where the resulting binaries will be 197installed (the default is 198.Pa / ) . 199.It Ev MAKEOBJDIRPREFIX 200The directory hierarchy where the object files will be built (the default is 201.Pa /usr/obj ) . 202.It Ev __MAKE_CONF 203Used to override the path of 204.Xr make.conf 5 205(the default is 206.Pa /etc/make.conf ) . 207.It Ev KERNCONF 208The name of one or more kernel configurations from which kernels should 209be built (the default is 210.Li X86_64_GENERIC ) . 211.It Ev KERNCONFDIR 212The directory where the kernel configuration files are kept (the default is 213.Pa /usr/src/sys/config ) . 214.It Ev DESTLABEL 215Common suffix added to kernel and modules directory names, prefixed by 216a single dot. For example, 217.Bd -literal -offset indent 218make DESTLABEL=test installkernel 219.Ed 220.Pp 221installs them as 222.Pa /boot/kernel.test/kernel 223and 224.Pa /boot/kernel.test , 225respectively. 226.It Ev DESTKERNDIR 227Where to install the kernel and the modules (the default is 228.Pa /boot ) , 229in the directory hierarchy specified by the environment variable 230.Ev DESTDIR . 231.It Ev DESTKERNNAME 232The name of the installed kernel file (the default is 233.Pa kernel ) , 234under the directory specified by 235.Ev DESTKERNDIR . 236This overrides the effect of 237.Ev DESTLABEL . 238.It Ev DESTMODULESNAME 239The name of the directory to install the kernel modules (the default is 240.Pa modules ) , 241under the directory specified by 242.Ev DESTKERNDIR . 243This overrides the effect of 244.Ev DESTLABEL . 245.It Ev WORLD_BACKUP 246Directory for manual backup of binaries of installed world (default: 247.Pa /var/backups/world_backup ) . 248.It Ev AUTO_BACKUP 249Directory for automatic backup of binaries of installed world (default: 250.Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) . 251.It Ev NO_BACKUP 252When defined, the automatic backup feature of 253.Cm installworld 254is inhibited. 255.It Ev COPTFLAGS 256Overrides the default optimization flags for kernel and module compiles. 257.It Ev KCFLAGS 258Allows you to add additional compiler flags for kernel and module compiles. 259But use 260.Ev COPTFLAGS 261to specify any optimization overrides, as some modules may have to override 262it to enforce a lower optimization level. 263.El 264.Sh OTHER 265There are two other mechanisms that users should be aware of. First, 266when you issue a 267.Cm installkernel 268.Dx 269will make a backup of the current kernel in 270.Pa /boot/kernel.old . 271Because people often do multiple installkernel operations, this backup 272kernel can also get lost in the noise. 273It is usually prudent to make a backup of the old kernel manually 274every once in a while when you know that it is a good kernel. you can 275do this after issuing the 276.Cm installkernel 277by running the command: 278.Bd -literal -offset indent 279cpdup /boot/kernel.old /boot/kernel.bak 280.Ed 281.Pp 282The advantage of this is that no installation mechanism will overwrite 283your 284.Pa /boot/kernel.bak , 285and in addition to that the loader's boot menu will check for its 286existence and present a menu option 'b' to allow you to boot from it. 287.Pp 288The second mechanism is related to the two-stage root mount. 289When using an encrypted root, the system will actually boot from a 290small initial ramdisk (a.k.a. initrd) image stored as 291.Pa /boot/kernel/initrd.img.gz . 292This image will handle the encrypted configuration, mount, and chroot 293to the real root. 294This image is also used as the rescue ramdisk boot menu option. 295This image is NOT updated automatically by 296.Cm installworld 297or 298.Cm installkernel . 299Instead, updating this image has to be done by running the manual command: 300.Bd -literal -offset indent 301make initrd 302.Ed 303.Pp 304It is usually a good idea to run this command after rebooting into the new 305world that you installed (so you know the world you installed is good). 306This command will update the initrd image in 307.Pa /boot/kernel 308and the rescue tools in 309.Pa /rescue . 310.Sh FILES 311.Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact 312.It Pa /etc/make.conf 313.It Pa /etc/defaults/make.conf 314.It Pa /usr/src/share/doc/Makefile 315.It Pa /usr/src/Makefile 316.It Pa /usr/src/Makefile.inc1 317.It Pa /usr/src/Makefile_upgrade.inc 318.El 319.Sh EXAMPLES 320The 321.Dq approved 322method of updating your system from the latest sources is: 323.Bd -literal -offset indent 324make buildworld 325make buildkernel KERNCONF=FOO 326make installkernel KERNCONF=FOO 327make installworld 328make upgrade 329reboot 330make initrd 331.Ed 332.Pp 333The above mentioned build and install order enforces that the new kernel 334is installed before the new world. 335Sometimes it might be necessary to reboot the system between those two 336steps. 337In this case 338.Dq Nm make Cm installworld 339will tell you to do so. 340.Sh SEE ALSO 341.Xr cc 1 , 342.Xr install 1 , 343.Xr make 1 , 344.Xr wmake 1 , 345.Xr make.conf 5 , 346.Xr development 7 , 347.Xr dports 7 , 348.Xr release 7 , 349.Xr config 8 , 350.Xr reboot 8 , 351.Xr shutdown 8 352.Sh AUTHORS 353.An -nosplit 354.An Mike W. Meyer Aq Mt mwm@mired.org 355and 356.An Sascha Wildner Aq Mt swildner@gmail.com . 357