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