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.7 2005/12/10 00:22:29 swildner Exp $ 27.\" 28.Dd October 8, 2005 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 contained in two different directories, 38normally 39.Pa /usr/src 40and 41.Pa /usr/ports . 42The 43.Pa /usr/src 44directory contains the 45.Dq "base system" 46sources, which is loosely defined as the things required to rebuild 47the system to a useful state. 48It also contains the source for the system documentation, including 49manual pages. 50The 51.Pa /usr/ports 52directory 53is a tree that provides a consistent interface for building and 54installing third party applications. 55.Pp 56The 57.Xr make 1 58command is used in each of these directories to build and install the 59things in that directory. Issuing the 60.Xr make 1 61command in any directory or 62subdirectory of those directories has the same effect as issuing the 63same command in all subdirectories of that directory. With no target 64specified, the things in that directory are just built. The following 65list provides the names and actions for other targets: 66.Bl -tag -width ".Cm install" 67.It Cm clean 68Removes any files created during the build process. 69.It Cm install 70Installs the results of the build for this directory. 71.It Cm update 72Gets updated sources as configured in 73.Pa /etc/make.conf . 74.El 75.Pp 76The other 77.Pa /usr/src 78make targets are: 79.Bl -tag -width ".Cm reinstallkernel" 80.It Cm buildworld 81Rebuild everything but the kernel. 82.It Cm quickworld 83Same as 84.Cm buildworld , 85but skip bootstrap, build and cross-build tool steps. 86This target can be used for incremental upgrades once a full build of the 87world has been done with 88.Cm buildworld . 89.It Cm realquickworld 90Same as 91.Cm quickworld , 92but also skip the depend step. 93.It Cm crossworld 94Just do the bootstrap, build and cross-build steps. 95.It Cm installworld 96Install everything built by 97.Cm buildworld . 98.It Cm world 99.Cm buildworld + 100.Cm installworld . 101.It Cm buildkernel 102Rebuild the kernel and the kernel-modules. 103.It Cm nativekernel 104Rebuild the kernel and the kernel-modules using native tools. 105.It Cm quickkernel 106Same as 107.Cm buildkernel , 108but skip the depend step and do not clean out the 109obj modules. This target can be used for incremental upgrades once a full 110build of the kernel has been done with 111.Cm buildkernel . 112.It Cm installkernel 113Install the kernel and the kernel-modules. 114.It Cm reinstallkernel 115Reinstall the kernel and the kernel-modules. 116.It Cm kernel 117.Cm buildkernel + 118.Cm installkernel . 119.It Cm preupgrade 120Perform certain upgrades that have to be done before 121.Cm installworld . 122.Cm installworld 123will complain if they have not been done. 124.It Cm upgrade 125Upgrade the files in /etc and also setup the rest of the system for 126the version of 127.Dx 128just installed. 129.It Cm most 130Build user commands, no libraries or include files. 131.It Cm installmost 132Install user commands, no libraries or include files. 133.El 134.Pp 135For more information about the ports build process, see 136.Xr ports 7 . 137.Sh ENVIRONMENT 138.Bl -tag -width ".Va TARGET_ARCH" 139.It Va TARGET_ARCH 140The target machine processor architecture. 141This is analogous to the 142.Dq Nm uname Fl p 143output. 144.\"Set this to cross-build for a different architecture. 145.It Va TARGET 146The target hardware platform. 147This is analogous to the 148.Dq Nm uname Fl m 149output. 150.\"This is necessary to cross-build some target architectures. 151.It Va NO_WERROR 152If defined, warnings will not cause the build to halt, even if the 153makefile says otherwise. 154.It Va DESTDIR 155The directory hierarchy where the resulting binaries will be 156installed. 157.El 158.Sh FILES 159.Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact 160.It Pa /etc/make.conf 161.It Pa /etc/defaults/make.conf 162.It Pa /usr/src/share/doc/Makefile 163.It Pa /usr/ports/Mk/bsd.port.mk 164.It Pa /usr/ports/Mk/bsd.sites.mk 165.It Pa /usr/src/Makefile 166.It Pa /usr/src/Makefile.inc1 167.El 168.Sh EXAMPLES 169The 170.Dq approved 171method of updating your system from the latest sources is: 172.Bd -literal -offset indent 173make buildworld 174make buildkernel KERNCONF=FOO 175make installkernel KERNCONF=FOO 176make installworld 177make upgrade 178.Ed 179.Pp 180.Dq FOO 181must be replaced with the name of the kernel configuration file from which 182the kernel should be built. 183Alternatively, the 184.Va KERNCONF 185variable in 186.Pa /etc/make.conf 187can be set to the name of the kernel to build; 188in this case the 189.Dq KERNCONF=FOO 190part of the 191.Cm buildkernel 192and 193.Cm installkernel 194commands can be omitted. 195.Pp 196After running these commands a system reboot is required, 197otherwise many programs which have been rebuilt 198(such as 199.Nm ps , 200.Nm top , 201etc) 202may not work with the old kernel which is still running. 203.Sh SEE ALSO 204.Xr cc 1 , 205.Xr install 1 , 206.Xr make 1 , 207.Xr make.conf 5 , 208.Xr ports 7 , 209.Xr release 7 , 210.Xr config 8 , 211.Xr reboot 8 , 212.Xr shutdown 8 213.Sh AUTHORS 214.An Mike W. Meyer Aq mwm@mired.org . 215