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.\" $DragonFly: src/share/man/man7/build.7,v 1.18 2008/11/14 15:04:42 swildner Exp $ 27.\" 28.Dd December 1, 2008 29.Dt BUILD 7 30.Os 31.Sh NAME 32.Nm build 33.Nd information on how to build the system 34.Sh DESCRIPTION 35The source for the 36.Dx 37system and applications is located in 38.Pa /usr/src . 39This directory contains the 40.Dq "base system" 41sources, which is loosely defined as the things required to rebuild 42the system to a useful state. 43It also contains the source for the system documentation, including 44manual pages. 45Third party applications have to be built using the 46.Xr pkgsrc 7 47system. 48The file 49.Pa /usr/src/UPDATING 50gives specifics on how to obtain the tree for building packages. 51.Pp 52The 53.Xr make 1 54command is used in 55.Pa /usr/src 56to build and install the things in that directory. 57Issuing the 58.Xr make 1 59command in any directory or 60subdirectory of those directories has the same effect as issuing the 61same command in all subdirectories of that directory. 62With no target specified, the things in that directory are just built. 63The following list provides the names and actions for other targets: 64.Bl -tag -width ".Cm install" 65.It Cm clean 66Removes any files created during the build process. 67.It Cm install 68Installs the results of the build for this directory. 69.El 70.Pp 71The other 72.Pa /usr/src 73make targets are: 74.Bl -tag -width ".Cm reinstallkernel" 75.It Cm buildworld 76Rebuild everything but the kernel. 77.It Cm quickworld 78Same as 79.Cm buildworld , 80but skip bootstrap, build and cross-build tool steps. 81This target can be used for incremental upgrades once a full build of the 82world has been done with 83.Cm buildworld . 84.It Cm realquickworld 85Same as 86.Cm quickworld , 87but also skip the depend step. 88.It Cm crossworld 89Just do the bootstrap, build and cross-build steps. 90.It Cm installworld 91Install everything built by 92.Cm buildworld . 93.It Cm world 94.Cm buildworld + 95.Cm installworld . 96.It Cm buildkernel 97Rebuild the kernel and the kernel-modules. 98.It Cm nativekernel 99Rebuild the kernel and the kernel-modules using native tools. 100.It Cm quickkernel 101Same as 102.Cm buildkernel , 103but skip the depend step and do not clean out the 104obj modules. 105This target can be used for incremental upgrades once a full 106build of the kernel has been done with 107.Cm buildkernel . 108.It Cm installkernel 109Install the kernel and the kernel-modules. 110.It Cm reinstallkernel 111Reinstall the kernel and the kernel-modules. 112.It Cm kernel 113.Cm buildkernel + 114.Cm installkernel . 115.It Cm preupgrade 116Perform certain upgrades that have to be done before 117.Cm installworld . 118.Cm installworld 119will complain if they have not been done. 120.It Cm upgrade 121Upgrade the files in /etc and also setup the rest of the system for 122the version of 123.Dx 124just installed. 125.It Cm most 126Build user commands, no libraries or include files. 127.It Cm installmost 128Install user commands, no libraries or include files. 129.El 130.Sh ENVIRONMENT 131.Bl -tag -width ".Ev TARGET_ARCH" 132.It Ev TARGET_ARCH 133The target machine processor architecture. 134This is analogous to the 135.Dq Nm uname Fl p 136output. 137.\"Set this to cross-build for a different architecture. 138.It Ev TARGET 139The target hardware platform. 140This is analogous to the 141.Dq Nm uname Fl m 142output. 143.\"This is necessary to cross-build some target architectures. 144.\".It Ev NO_WERROR 145.\"If defined, warnings will not cause the build to halt, even if the 146.\"makefile says otherwise. 147.It Ev DESTDIR 148An existing directory to be the root of 149the hierarchy where the resulting binaries will be 150installed (the default is 151.Pa / ) . 152.It Ev MAKEOBJDIRPREFIX 153The directory hierarchy where the object files will be built (the default is 154.Pa /usr/obj ) . 155.It Ev __MAKE_CONF 156Used to override the path of 157.Xr make.conf 5 158(the default is 159.Pa /etc/make.conf ) . 160.It Ev KERNCONF 161The name of the kernel configuration file from which the kernel should 162be built (the default is 163.Li GENERIC ) . 164.It Ev KERNCONFDIR 165The directory where the kernel configuration files are kept (the default is 166.Pa /usr/src/sys/config ) . 167.It Ev DESTLABEL 168Common suffix added to kernel and modules directory names, prefixed by 169a single dot. For example, 170.Bd -literal -offset indent 171make DESTLABEL=test installkernel 172.Ed 173.Pp 174installs them as 175.Pa /boot/kernel.test 176and 177.Pa /boot/modules.test , 178respectively. 179.It Ev DESTKERNDIR 180Where to install the kernel and the modules (the default is 181.Pa /boot ) , 182in the directory hierarchy specified by the environment variable 183.Ev DESTDIR . 184.It Ev DESTKERNNAME 185The name of the installed kernel file (the default is 186.Pa kernel ) , 187under the directory specified by 188.Ev DESTKERNDIR . 189This overrides the effect of 190.Ev DESTLABEL . 191.It Ev DESTMODULESNAME 192The name of the directory to install the kernel modules (the default is 193.Pa modules ) , 194under the directory specified by 195.Ev DESTKERNDIR . 196This overrides the effect of 197.Ev DESTLABEL . 198.El 199.Sh FILES 200.Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact 201.It Pa /etc/make.conf 202.It Pa /etc/defaults/make.conf 203.It Pa /usr/src/share/doc/Makefile 204.It Pa /usr/src/Makefile 205.It Pa /usr/src/Makefile.inc1 206.El 207.Sh EXAMPLES 208The 209.Dq approved 210method of updating your system from the latest sources is: 211.Bd -literal -offset indent 212make buildworld 213make buildkernel KERNCONF=FOO 214make installkernel KERNCONF=FOO 215make installworld 216make upgrade 217.Ed 218.Pp 219After running these commands a system reboot is required, 220otherwise many programs which have been rebuilt (such as 221.Xr ps 1 , 222.Xr top 1 , 223etc.) may not work with the old kernel which is still running. 224.Sh CAVEATS 225The build and install order in the 226.Sx EXAMPLES 227section enforces that the new kernel is installed before the new 228world. 229Sometimes it might be necessary to reboot the system between those two 230steps. 231In this case 232.Dq Nm make Cm installworld 233will tell you to do so. 234.Sh SEE ALSO 235.Xr cc 1 , 236.Xr install 1 , 237.Xr make 1 , 238.Xr wmake 1 , 239.Xr make.conf 5 , 240.Xr development 7 , 241.Xr pkgsrc 7 , 242.Xr release 7 , 243.Xr config 8 , 244.Xr reboot 8 , 245.Xr shutdown 8 246.Sh AUTHORS 247.An -nosplit 248.An Mike W. Meyer Aq mwm@mired.org 249and 250.An Sascha Wildner Aq swildner@gmail.com . 251