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 August 13, 2004 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 buildkernel 88Rebuild the kernel and the kernel modules. 89.It Cm installkernel 90Install the kernel and the kernel modules. 91.It Cm reinstallkernel 92Reinstall the kernel and the kernel modules. 93.El 94.Pp 95For more information about the ports build process, see 96.Xr ports 7 . 97.Sh ENVIRONMENT 98.Bl -tag -width ".Va TARGET_ARCH" 99.It Va TARGET_ARCH 100The target machine processor architecture. 101This is analogous to the 102.Dq Nm uname Fl p 103output. 104Set this to cross-build for a different architecture. 105.It Va TARGET 106The target hardware platform. 107This is analogous to the 108.Dq Nm uname Fl m 109output. 110This is necessary to cross-build some target architectures. 111For example, cross-building for PC98 machines requires 112.Va TARGET_ARCH Ns = Ns Li i386 113and 114.Va TARGET Ns = Ns Li pc98 . 115.It Va NO_WERROR 116If defined, warnings will not cause the build to halt, even if the 117makefile says otherwise. 118.It Va DESTDIR 119The directory hierarchy where the resulting binaries will be 120installed. 121.El 122.Sh FILES 123.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 124.It Pa /etc/make.conf 125.It Pa /usr/doc/Makefile 126.It Pa /usr/doc/share/mk/doc.project.mk 127.It Pa /usr/ports/Mk/bsd.port.mk 128.It Pa /usr/ports/Mk/bsd.sites.mk 129.It Pa /usr/share/examples/etc/make.conf 130.It Pa /usr/src/Makefile 131.It Pa /usr/src/Makefile.inc1 132.El 133.Sh EXAMPLES 134For an 135.Dq approved 136method of updating your system from the latest sources, 137please see the 138.Sx COMMON ITEMS 139section in 140.Pa src/UPDATING . 141.Pp 142The following sequence of commands can be used to cross-build the 143system for the Alpha architecture on an i386 host: 144.Bd -literal -offset indent 145cd /usr/src 146make TARGET_ARCH=alpha buildworld 147make TARGET_ARCH=alpha DESTDIR=/clients/axp installworld 148.Ed 149.Sh SEE ALSO 150.Xr cc 1 , 151.Xr install 1 , 152.Xr make 1 , 153.Xr make.conf 5 , 154.Xr ports 7 , 155.Xr release 7 , 156.Xr mergemaster 8 , 157.Xr reboot 8 , 158.Xr shutdown 8 159.Sh AUTHORS 160.An Mike W. Meyer Aq mwm@mired.org . 161