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 October 26, 2014 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 backup-auto-clean" 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 world 104.Cm buildworld + 105.Cm installworld . 106.It Cm buildkernel 107Rebuild the kernel and the kernel-modules. 108.It Cm nativekernel 109Rebuild the kernel and the kernel-modules using native tools. 110.It Cm quickkernel 111Same as 112.Cm buildkernel , 113but skip the depend step and do not clean out the 114obj modules. 115This target can be used for incremental upgrades once a full 116build of the kernel has been done with 117.Cm buildkernel . 118.It Cm installkernel 119Install the kernel and the kernel-modules. 120.It Cm reinstallkernel 121Reinstall the kernel and the kernel-modules. 122.It Cm kernel 123.Cm buildkernel + 124.Cm installkernel . 125.It Cm preupgrade 126Perform certain upgrades that have to be done before 127.Cm installworld . 128.Cm installworld 129will complain if they have not been done. 130.It Cm upgrade 131Upgrade the files in /etc and also setup the rest of the system for 132the version of 133.Dx 134just installed. 135.It Cm rescue 136Create a rescue initrd. 137.It Cm most 138Build user commands, no libraries or include files. 139.It Cm installmost 140Install user commands, no libraries or include files. 141.It Cm backupworld 142Manually archive binaries from installed world to location specified by 143.Ev WORLD_BACKUP . 144.It Cm backup-clean 145Delete archive created by 146.Cm backupworld . 147.It Cm backup-auto-clean 148Delete archive created automatically during 149.Cm installworld . 150.It Cm restoreworld 151Restore binaries from archive created by 152.Cm backupworld . 153.It Cm restoreworld-auto 154Restore binaries from archive created automatically during 155.Cm installworld . 156The archive location is specified by 157.Ev AUTO_BACKUP . 158.El 159.Sh ENVIRONMENT 160.Bl -tag -width ".Ev MAKEOBJDIRPREFIX" 161.It Ev TARGET_ARCH , TARGET_PLATFORM 162The target machine processor architecture and hardware platform. 163These have to be set for cross-building. 164.Ev TARGET_ARCH 165is analogous to the 166.Dq Nm uname Fl p 167output. 168To build for the 32 bit 169.Tn Intel 170architecture known as IA-32, x86 or x86-32, use: 171.Bd -literal -offset indent 172TARGET_ARCH=i386 173TARGET_PLATFORM=pc32 174.Ed 175.Pp 176For the 64 bit 177.Tn AMD 178architecture known as AMD64, x86-64 or Intel 64, use: 179.Bd -literal -offset indent 180TARGET_ARCH=x86_64 181TARGET_PLATFORM=pc64 182.Ed 183.It Ev DESTDIR 184An existing directory to be the root of 185the hierarchy where the resulting binaries will be 186installed (the default is 187.Pa / ) . 188.It Ev MAKEOBJDIRPREFIX 189The directory hierarchy where the object files will be built (the default is 190.Pa /usr/obj ) . 191.It Ev __MAKE_CONF 192Used to override the path of 193.Xr make.conf 5 194(the default is 195.Pa /etc/make.conf ) . 196.It Ev KERNCONF 197The name of the kernel configuration file from which the kernel should 198be built (the default is 199.Li GENERIC ) . 200.It Ev KERNCONFDIR 201The directory where the kernel configuration files are kept (the default is 202.Pa /usr/src/sys/config ) . 203.It Ev DESTLABEL 204Common suffix added to kernel and modules directory names, prefixed by 205a single dot. For example, 206.Bd -literal -offset indent 207make DESTLABEL=test installkernel 208.Ed 209.Pp 210installs them as 211.Pa /boot/kernel.test 212and 213.Pa /boot/modules.test , 214respectively. 215.It Ev DESTKERNDIR 216Where to install the kernel and the modules (the default is 217.Pa /boot ) , 218in the directory hierarchy specified by the environment variable 219.Ev DESTDIR . 220.It Ev DESTKERNNAME 221The name of the installed kernel file (the default is 222.Pa kernel ) , 223under the directory specified by 224.Ev DESTKERNDIR . 225This overrides the effect of 226.Ev DESTLABEL . 227.It Ev DESTMODULESNAME 228The name of the directory to install the kernel modules (the default is 229.Pa modules ) , 230under the directory specified by 231.Ev DESTKERNDIR . 232This overrides the effect of 233.Ev DESTLABEL . 234.It Ev WORLD_BACKUP 235Directory for manual backup of binaries of installed world (default: 236.Pa /var/backups/world_backup ) . 237.It Ev AUTO_BACKUP 238Directory for automatic backup of binaries of installed world (default: 239.Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) . 240.It Ev NO_BACKUP 241When defined, the automatic backup feature of 242.Cm installworld 243is inhibited. 244.El 245.Sh FILES 246.Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact 247.It Pa /etc/make.conf 248.It Pa /etc/defaults/make.conf 249.It Pa /usr/src/share/doc/Makefile 250.It Pa /usr/src/Makefile 251.It Pa /usr/src/Makefile.inc1 252.It Pa /usr/src/Makefile_upgrade.inc 253.El 254.Sh EXAMPLES 255The 256.Dq approved 257method of updating your system from the latest sources is: 258.Bd -literal -offset indent 259make buildworld 260make buildkernel KERNCONF=FOO 261make installkernel KERNCONF=FOO 262make installworld 263make upgrade 264.Ed 265.Pp 266After running these commands a system reboot is required, 267otherwise many programs which have been rebuilt (such as 268.Xr ps 1 , 269.Xr top 1 , 270etc.) may not work with the old kernel which is still running. 271.Sh CAVEATS 272The build and install order in the 273.Sx EXAMPLES 274section enforces that the new kernel is installed before the new 275world. 276Sometimes it might be necessary to reboot the system between those two 277steps. 278In this case 279.Dq Nm make Cm installworld 280will tell you to do so. 281.Sh SEE ALSO 282.Xr cc 1 , 283.Xr install 1 , 284.Xr make 1 , 285.Xr wmake 1 , 286.Xr make.conf 5 , 287.Xr development 7 , 288.Xr dports 7 , 289.Xr release 7 , 290.Xr config 8 , 291.Xr reboot 8 , 292.Xr shutdown 8 293.Sh AUTHORS 294.An -nosplit 295.An Mike W. Meyer Aq Mt mwm@mired.org 296and 297.An Sascha Wildner Aq Mt swildner@gmail.com . 298