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$ 26.\" 27.Dd March 15, 2002 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.Fx 36system and applications are contained in three different directories, 37normally 38.Pa /usr/src , 39.Pa /usr/doc , 40and 41.Pa /usr/ports . 42.Pa /usr/src 43contains the 44.Dq "base system" 45sources, which is loosely defined as the things required to rebuild 46the system to a useful state. 47.Pa /usr/doc 48contains the source for the system documentation, excluding the manual 49pages. 50.Pa /usr/ports 51is a tree that provides a consistent interface for building and 52installing third party applications. 53.Pp 54The 55.Xr make 1 56command is used in each of these directories to build and install the 57things in that directory. 58Issuing the 59.Xr make 1 60command in any directory or 61subdirectory of those directories has the same effect as issuing the 62same command in all subdirectories of that directory. 63With no target specified, the things in that directory are just built. 64The following 65list provides the names and actions for other targets: 66.Bl -tag -width indent-two 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 indent-two 80.It Cm buildworld 81Rebuild everything but the kernel, configure files in 82.Pa /etc , 83and release. 84.It Cm installworld 85Install everything built by 86.Cm buildworld . 87.It Cm world 88.Cm buildworld 89+ 90.Cm installworld . 91.It Cm buildkernel 92Rebuild the kernel and the kernel modules. 93.It Cm installkernel 94Install the kernel and the kernel modules. 95.It Cm reinstallkernel 96Reinstall the kernel and the kernel modules. 97.It Cm most 98Build user commands, no libraries or include files. 99.It Cm installmost 100Install user commands, no libraries or include files. 101.El 102.Pp 103For more information about the ports build process, see 104.Xr ports 7 . 105.Sh ENVIRONMENT 106.Bl -tag -width ".Va TARGET_ARCH" 107.It Va TARGET_ARCH 108The target machine processor architecture. 109This is analogous to the 110.Dq Nm uname Fl p 111output. 112Set this to cross-build for a different architecture. 113.It Va TARGET 114The target hardware platform. 115This is analogous to the 116.Dq Nm uname Fl m 117output. 118This is necessary to cross-build some target architectures. 119For example, cross-building for PC98 machines requires 120.Va TARGET_ARCH Ns = Ns Li i386 121and 122.Va TARGET Ns = Ns Li pc98 . 123.It Va NO_WERROR 124If defined, warnings will not cause the build to halt, even if the 125makefile says otherwise. 126.It Va DESTDIR 127The directory hierarchy where the resulting binaries will be 128installed. 129.El 130.Sh FILES 131.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 132.It Pa /etc/make.conf 133.It Pa /usr/doc/Makefile 134.It Pa /usr/doc/share/mk/doc.project.mk 135.It Pa /usr/ports/Mk/bsd.port.mk 136.It Pa /usr/ports/Mk/bsd.sites.mk 137.It Pa /usr/share/examples/etc/make.conf 138.It Pa /usr/src/Makefile 139.It Pa /usr/src/Makefile.inc1 140.El 141.Sh EXAMPLES 142The 143.Dq approved 144method of updating your system from the latest sources is: 145.Bd -literal -offset indent 146make buildworld 147make buildkernel KERNCONF=FOO 148make installkernel KERNCONF=FOO 149make installworld 150mergemaster 151.Ed 152.Pp 153.Dq Li FOO 154must be replaced with the name of the kernel configuration file from which 155the kernel should be built. 156Alternatively, the 157.Va KERNCONF 158variable in 159.Pa /etc/make.conf 160can be set to the name of the kernel to build; 161in this case the 162.Va KERNCONF Ns = Ns Li FOO 163part of the 164.Cm buildkernel 165and 166.Cm installkernel 167commands can be omitted. 168.Pp 169After running these commands a system reboot is required, 170otherwise many programs which have been rebuilt 171(such as 172.Xr ps 1 , 173.Xr top 1 , 174etc.\&) 175may not work with the old kernel which is still running. 176.Pp 177The following sequence of commands can be used to cross-build the 178system for the Alpha architecture on an i386 host: 179.Bd -literal -offset indent 180cd /usr/src 181make TARGET_ARCH=alpha buildworld 182make TARGET_ARCH=alpha DESTDIR=/clients/axp installworld 183.Ed 184.Sh SEE ALSO 185.Xr cc 1 , 186.Xr install 1 , 187.Xr make 1 , 188.Xr make.conf 5 , 189.Xr ports 7 , 190.Xr release 7 , 191.Xr mergemaster 8 , 192.Xr reboot 8 , 193.Xr shutdown 8 194.Sh AUTHORS 195.An Mike W. Meyer Aq mwm@mired.org . 196