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