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