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 June 4, 2020 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 build-all 147.Cm buildworld + 148.Cm buildkernel 149.Pp 150The option -j hw.ncpu is added automatically to optimally utilize the system. 151.It Cm install-all 152.Cm installkernel + 153.Cm installworld + 154.Cm upgrade 155.It Cm preupgrade 156Perform certain upgrades that have to be done before 157.Cm installworld , 158such as adding new users and groups. 159.Cm installworld 160will complain if they have not been done. 161.It Cm upgrade 162Upgrade the files in /etc and also setup the rest of the system for 163the version of 164.Dx 165just installed. 166.It Cm initrd 167Install the statically linked rescue tools and the initial ramdisk built by 168.Cm buildworld . 169.It Cm backupworld 170Manually archive binaries from installed world to location specified by 171.Ev WORLD_BACKUP . 172.It Cm backup-clean 173Delete archive created by 174.Cm backupworld . 175.It Cm backup-auto-clean 176Delete archive created automatically during 177.Cm installworld . 178.It Cm restoreworld 179Restore binaries from archive created by 180.Cm backupworld . 181.It Cm restoreworld-auto 182Restore binaries from archive created automatically during 183.Cm installworld . 184The archive location is specified by 185.Ev AUTO_BACKUP . 186.El 187.Sh ENVIRONMENT 188.Bl -tag -width ".Ev MAKEOBJDIRPREFIX" 189.It Ev TARGET_ARCH , TARGET_PLATFORM 190The target machine processor architecture and hardware platform. 191These have to be set for cross-building. 192.Ev TARGET_ARCH 193is analogous to the 194.Dq Nm uname Fl p 195output. 196For the 64 bit 197.Tn AMD 198architecture known as AMD64, x86-64 or Intel 64, use: 199.Bd -literal -offset indent 200TARGET_ARCH=x86_64 201TARGET_PLATFORM=pc64 202.Ed 203.It Ev DESTDIR 204An existing directory to be the root of 205the hierarchy where the resulting binaries will be 206installed (the default is 207.Pa / ) . 208.It Ev MAKEOBJDIRPREFIX 209The directory hierarchy where the object files will be built (the default is 210.Pa /usr/obj ) . 211.It Ev __MAKE_CONF 212Used to override the path of 213.Xr make.conf 5 214(the default is 215.Pa /etc/make.conf ) . 216.It Ev KERNCONF 217The name of one or more kernel configurations from which kernels should 218be built (the default is 219.Li X86_64_GENERIC ) . 220.It Ev KERNCONFDIR 221The directory where the kernel configuration files are kept (the default is 222.Pa /usr/src/sys/config ) . 223.It Ev DESTLABEL 224Common suffix added to kernel and modules directory names, prefixed by 225a single dot. For example, 226.Bd -literal -offset indent 227make DESTLABEL=test installkernel 228.Ed 229.Pp 230installs them as 231.Pa /boot/kernel.test/kernel 232and 233.Pa /boot/kernel.test , 234respectively. 235.It Ev DESTKERNDIR 236Where to install the kernel and the modules (the default is 237.Pa /boot ) , 238in the directory hierarchy specified by the environment variable 239.Ev DESTDIR . 240.It Ev DESTKERNNAME 241The name of the installed kernel file (the default is 242.Pa kernel ) , 243under the directory specified by 244.Ev DESTKERNDIR . 245This overrides the effect of 246.Ev DESTLABEL . 247.It Ev DESTMODULESNAME 248The name of the directory to install the kernel modules (the default is 249.Pa modules ) , 250under the directory specified by 251.Ev DESTKERNDIR . 252This overrides the effect of 253.Ev DESTLABEL . 254.It Ev WORLD_BACKUP 255Directory for manual backup of binaries of installed world (default: 256.Pa /var/backups/world_backup ) . 257.It Ev AUTO_BACKUP 258Directory for automatic backup of binaries of installed world (default: 259.Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) . 260.It Ev NO_BACKUP 261When defined, the automatic backup feature of 262.Cm installworld 263is inhibited. 264.It Ev COPTFLAGS 265Overrides the default optimization flags for kernel and module compiles. 266.It Ev KCFLAGS 267Allows you to add additional compiler flags for kernel and module compiles. 268But use 269.Ev COPTFLAGS 270to specify any optimization overrides, as some modules may have to override 271it to enforce a lower optimization level. 272.El 273.Sh OTHER 274There are two other mechanisms that users should be aware of. First, 275when you issue a 276.Cm installkernel 277.Dx 278will make a backup of the current kernel in 279.Pa /boot/kernel.old . 280Because people often do multiple installkernel operations, this backup 281kernel can also get lost in the noise. 282It is usually prudent to make a backup of the old kernel manually 283every once in a while when you know that it is a good kernel. you can 284do this after issuing the 285.Cm installkernel 286by running the command: 287.Bd -literal -offset indent 288cpdup /boot/kernel.old /boot/kernel.bak 289.Ed 290.Pp 291The advantage of this is that no installation mechanism will overwrite 292your 293.Pa /boot/kernel.bak , 294and in addition to that the loader's boot menu will check for its 295existence and present a menu option 'b' to allow you to boot from it. 296.Pp 297The second mechanism is related to the two-stage root mount. 298When using an encrypted root, the system will actually boot from a 299small initial ramdisk (a.k.a. initrd) image stored as 300.Pa /boot/kernel/initrd.img.gz . 301This image will handle the encrypted configuration, mount, and chroot 302to the real root. 303This image is also used as the rescue ramdisk boot menu option. 304This image is NOT updated automatically by 305.Cm installworld 306or 307.Cm installkernel . 308Instead, updating this image has to be done by running the manual command: 309.Bd -literal -offset indent 310make initrd 311.Ed 312.Pp 313It is usually a good idea to run this command after rebooting into the new 314world that you installed (so you know the world you installed is good). 315This command will update the initrd image in 316.Pa /boot/kernel 317and the rescue tools in 318.Pa /rescue . 319.Sh FILES 320.Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact 321.It Pa /etc/make.conf 322.It Pa /etc/defaults/make.conf 323.It Pa /usr/src/Makefile 324.It Pa /usr/src/Makefile.inc1 325.It Pa /usr/src/Makefile_upgrade.inc 326.El 327.Sh EXAMPLES 328The 329.Dq approved 330method of updating your system from the latest sources is: 331.Bd -literal -offset indent 332make buildworld 333make buildkernel KERNCONF=FOO 334make installkernel KERNCONF=FOO 335make installworld 336make upgrade 337reboot 338make initrd 339.Ed 340.Pp 341The above mentioned build and install order enforces that the new kernel 342is installed before the new world. 343Sometimes it might be necessary to reboot the system between those two 344steps. 345In this case 346.Dq Nm make Cm installworld 347will tell you to do so. 348.Sh SEE ALSO 349.Xr cc 1 , 350.Xr install 1 , 351.Xr make 1 , 352.Xr wmake 1 , 353.Xr make.conf 5 , 354.Xr development 7 , 355.Xr dports 7 , 356.Xr release 7 , 357.Xr config 8 , 358.Xr reboot 8 , 359.Xr shutdown 8 360.Sh AUTHORS 361.An -nosplit 362.An Mike W. Meyer Aq Mt mwm@mired.org 363and 364.An Sascha Wildner Aq Mt swildner@gmail.com . 365