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 3, 2005 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 kernel-toolchain 88Rebuild the tools needed for kernel compilation. 89Use this if you did not do a buildworld first. 90.It Cm buildkernel 91Rebuild the kernel and the kernel modules. 92.It Cm installkernel 93Install the kernel and the kernel modules. 94.It Cm reinstallkernel . 95Reinstall the kernel and the kernel modules. 96.It Cm kernel 97Equivalent to 98.Cm buildkernel 99followed by 100.Cm installkernel 101.It Cm delete-old 102Delete obsolete base system files and directories interactively. 103When -DBATCH_DELETE_OLD_FILES is specified at the command line, 104the delete operation will be non-interactive. 105The variables 106.Va DESTDIR , TARGET_ARCH 107and 108.Va TARGET 109should be set as with 110.Dq Li "make installworld" . 111.It Cm delete-old-libs 112Delete obsolete base system libraries interactively. 113This should only be used if no 3rd party software uses the libraries anymore. 114When -DBATCH_DELETE_OLD_FILES is specified at the command line, 115the delete operation will be non-interactive. 116The variables 117.Va DESTDIR , TARGET_ARCH 118and 119.Va TARGET 120should be set as with 121.Dq Li "make installworld" . 122.El 123.Pp 124For more information about the ports build process, see 125.Xr ports 7 . 126.Sh ENVIRONMENT 127.Bl -tag -width ".Va TARGET_ARCH" 128.It Va TARGET_ARCH 129The target machine processor architecture. 130This is analogous to the 131.Dq Nm uname Fl p 132output. 133Set this to cross-build for a different architecture. 134.It Va TARGET 135The target hardware platform. 136This is analogous to the 137.Dq Nm uname Fl m 138output. 139This is necessary to cross-build some target architectures. 140For example, cross-building for PC98 machines requires 141.Va TARGET_ARCH Ns = Ns Li i386 142and 143.Va TARGET Ns = Ns Li pc98 . 144.It Va NO_WERROR 145If defined, warnings will not cause the build to halt, even if the 146makefile says otherwise. 147.It Va DESTDIR 148The directory hierarchy where the resulting binaries will be 149installed. 150.El 151.Sh FILES 152.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 153.It Pa /etc/make.conf 154.It Pa /usr/doc/Makefile 155.It Pa /usr/doc/share/mk/doc.project.mk 156.It Pa /usr/ports/Mk/bsd.port.mk 157.It Pa /usr/ports/Mk/bsd.sites.mk 158.It Pa /usr/share/examples/etc/make.conf 159.It Pa /usr/src/Makefile 160.It Pa /usr/src/Makefile.inc1 161.El 162.Sh EXAMPLES 163For an 164.Dq approved 165method of updating your system from the latest sources, 166please see the 167.Sx COMMON ITEMS 168section in 169.Pa src/UPDATING . 170.Pp 171The following sequence of commands can be used to cross-build the 172system for the Alpha architecture on an i386 host: 173.Bd -literal -offset indent 174cd /usr/src 175make TARGET_ARCH=alpha buildworld 176make TARGET_ARCH=alpha DESTDIR=/clients/axp installworld 177.Ed 178.Sh SEE ALSO 179.Xr cc 1 , 180.Xr install 1 , 181.Xr make 1 , 182.Xr make.conf 5 , 183.Xr ports 7 , 184.Xr release 7 , 185.Xr config 8 , 186.Xr mergemaster 8 , 187.Xr reboot 8 , 188.Xr shutdown 8 189.Sh AUTHORS 190.An Mike W. Meyer Aq mwm@mired.org . 191