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 October 1, 2006 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 sources for the 35.Fx 36system and its applications are contained in three different directories, 37normally 38.Pa /usr/src , 39.Pa /usr/doc , 40and 41.Pa /usr/ports . 42Directory 43.Pa /usr/src 44contains the 45.Dq "base system" 46sources, which is loosely defined as the things required to rebuild 47the system to a useful state. 48Directory 49.Pa /usr/doc 50contains the source for the system documentation, excluding the manual 51pages. 52Directory 53.Pa /usr/ports 54contains a tree that provides a consistent interface for building and 55installing third party applications. 56For more information about the ports build process, see 57.Xr ports 7 . 58.Pp 59The 60.Xr make 1 61command is used in each of these directories to build and install the 62things in that directory. 63Issuing the 64.Xr make 1 65command in any directory or 66subdirectory of those directories has the same effect as issuing the 67same command in all subdirectories of that directory. 68With no target specified, the things in that directory are just built. 69.Pp 70A source tree is allowed to be read-only. 71As described in 72.Xr make 1 , 73objects are usually built in a separate object directory hierarchy 74specified by the environment variable 75.Va MAKEOBJDIRPREFIX , 76or under 77.Pa /usr/obj 78if variable 79.Va MAKEOBJDIRPREFIX 80is not set. 81For a given source directory, its canonical object directory 82would be 83.Pa ${MAKEOBJDIRPREFIX}${.CURDIR} 84if 85.Xr make 1 86variable 87.Va MAKEOBJDIRPREFIX 88is set, or 89.Pa /usr/obj${.CURDIR} 90if this variable is not set. 91Cross-builds set the object directory as described in the 92documentation for the 93.Cm buildworld 94target below. 95.Pp 96The build may be controlled by defining 97.Xr make 1 98variables described in the 99.Sx ENVIRONMENT 100section below, and by the variables documented in 101.Xr make.conf 5 . 102.Pp 103The following list provides the names and actions for the targets 104supported by the build system: 105.Bl -tag -width ".Cm cleandepend" 106.It Cm clean 107Remove any files created during the build process. 108.It Cm cleandepend 109Remove the file 110.Pa ${.OBJDIR}/${DEPENDFILE} 111generated by a prior 112.Dq Li "make depend" 113step. 114.It Cm cleandir 115Remove the canonical object directory if it exists, or perform 116actions equivalent to 117.Dq Li "make clean cleandepend" 118if it does not. 119This target will also remove an 120.Pa obj 121link in 122.Pa ${.CURDIR} 123if that exists. 124.Pp 125It is advisable to run 126.Dq Li "make cleandir" 127twice: the first invocation will remove the canonical object directory 128and the second one will clean up 129.Pa ${.CURDIR} . 130.It Cm depend 131Generate a list of build dependencies in file 132.Pa ${.OBJDIR}/${DEPENDFILE} . 133.It Cm install 134Install the results of the build to the appropriate location in the 135installation directory hierarchy specified in variable 136.Va DESTDIR . 137.It Cm obj 138Create the canonical object directory associated with the current 139directory. 140.It Cm objlink 141Create a symbolic link to the canonical object directory in 142.Pa ${.CURDIR} . 143.It Cm tags 144Generate a tags file using the program specified in the 145.Xr make 1 146variable 147.Va CTAGS . 148The build system supports 149.Xr ctags 1 150and 151.Nm "GNU Global" . 152.El 153.Pp 154The other supported targets under directory 155.Pa /usr/src 156are: 157.Bl -tag -width ".Cm distributeworld" 158.It Cm buildenv 159Spawn an interactive shell with environment variables set up for 160cross-building the system. 161The target architecture needs to be specified with 162.Xr make 1 163variables 164.Va TARGET_ARCH 165and 166.Va TARGET . 167.Pp 168This target is only useful after a complete cross-toolchain including 169the compiler, linker, assembler, headers and libraries has been 170built; see the 171.Cm toolchain 172target below. 173.It Cm buildworld 174Build everything but the kernel, configure files in 175.Pa etc , 176and 177.Pa release . 178The actual build location prefix used is 179.Pa ${MAKEOBJDIRPREFIX}${.CURDIR} 180for native builds, and 181.Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR} 182for cross builds and native builds with variable 183.Va CROSS_BUILD_TESTING 184set. 185.It Cm cleanworld 186Attempt to clean up targets built by a preceding 187.Cm buildworld 188step. 189.It Cm distributeworld 190Distribute everything compiled by a preceding 191.Cm buildworld 192step. 193Files are placed in the directory hierarchy specified by 194.Xr make 1 195variable 196.Va DISTDIR . 197This target is used while building a release; see 198.Xr release 7 . 199.It Cm installworld 200Install everything built by a preceding 201.Cm buildworld 202step into the directory hierarchy pointed to by 203.Xr make 1 204variable 205.Va DESTDIR . 206.Pp 207If installing onto an NFS file system and running 208.Xr make 1 209with the 210.Fl j 211option, make sure that 212.Xr rpc.lockd 8 213is running on both client and server. 214See 215.Xr rc.conf 5 216on how to make it start at boot time. 217.It Cm toolchain 218Create the build toolchain needed to build the rest of the system. 219For cross-architecture builds, this step creates a cross-toolchain. 220.It Cm universe 221Execute a 222.Cm buildworld 223and 224.Cm buildkernel 225for all kernels including 226.Pa LINT , 227for each architecture supported by the build system. 228This command takes a long time. 229.It Cm update 230Get updated sources as configured in 231.Xr make.conf 5 . 232.El 233.Pp 234Kernel specific build targets in 235.Pa /usr/src 236are: 237.Bl -tag -width ".Cm reinstallkernel" 238.It Cm buildkernel 239Rebuild the kernel and the kernel modules. 240.It Cm installkernel 241Install the kernel and the kernel modules to directory 242.Pa ${DESTDIR}/boot/kernel , 243renaming any pre-existing directory with this name to 244.Pa kernel.old 245if it contained the currently running kernel. 246The target directory under 247.Pa ${DESTDIR} 248may be modified using the 249.Va INSTKERNNAME 250and 251.Va KODIR 252.Xr make 1 253variables. 254.It Cm kernel 255Equivalent to 256.Cm buildkernel 257followed by 258.Cm installkernel 259.It Cm kernel-toolchain 260Rebuild the tools needed for kernel compilation. 261Use this if you did not do a 262.Cm buildworld 263first. 264.It Cm reinstallkernel 265Reinstall the kernel and the kernel modules, overwriting the contents 266of the target directory. 267As with the 268.Cm installkernel 269target, the target directory can be specified using the 270.Xr make 1 271variable 272.Va INSTKERNNAME . 273.El 274.Pp 275Convenience targets for cleaning up the install destination directory 276denoted by variable 277.Va DESTDIR 278include: 279.Bl -tag -width ".Cm delete-old-libs" 280.It Cm check-old 281Print a list of old files and directories in the system. 282.It Cm delete-old 283Delete obsolete base system files and directories interactively. 284When 285.Li -DBATCH_DELETE_OLD_FILES 286is specified at the command line, the delete operation will be 287non-interactive. 288The variables 289.Va DESTDIR , 290.Va TARGET_ARCH 291and 292.Va TARGET 293should be set as with 294.Dq Li "make installworld" . 295.It Cm delete-old-libs 296Delete obsolete base system libraries interactively. 297This target should only be used if no 3rd party software uses these 298libraries. 299When 300.Li -DBATCH_DELETE_OLD_FILES 301is specified at the command line, the delete operation will be 302non-interactive. 303The variables 304.Va DESTDIR , 305.Va TARGET_ARCH 306and 307.Va TARGET 308should be set as with 309.Dq Li "make installworld" . 310.El 311.Sh ENVIRONMENT 312Variables that influence all builds include: 313.Bl -tag -width ".Va MAKEOBJDIRPREFIX" 314.It Va DESTDIR 315The directory hierarchy prefix where built objects will be installed. 316If not set, 317.Va DESTDIR 318defaults to the empty string. 319.It Va MAKEOBJDIRPREFIX 320Defines the prefix for directory names in the tree of built objects. 321Defaults to 322.Pa /usr/obj 323if not defined. 324This variable should only be set in the environment and not via 325.Pa /etc/make.conf 326or the command line. 327.It Va NO_WERROR 328If defined, compiler warnings will not cause the build to halt, 329even if the makefile says otherwise. 330.El 331.Pp 332Additionally, builds in 333.Pa /usr/src 334are influenced by the following 335.Xr make 1 336variables: 337.Bl -tag -width ".Va SUBDIR_OVERRIDE" 338.It Va LOCAL_DIRS 339If set, this variable supplies a list of additional directories to 340build, relative to the root of the source tree. 341.It Va SUBDIR_OVERRIDE 342Override the default list of sub-directories and only build the 343sub-directory named in this variable. 344This variable is useful when debugging failed builds. 345.Bd -literal -offset indent 346make some-target SUBDIR_OVERRIDE=foo/bar 347.Ed 348.It Va TARGET 349The target hardware platform. 350This is analogous to the 351.Dq Nm uname Fl m 352output. 353This is necessary to cross-build some target architectures. 354For example, cross-building for PC98 machines requires 355.Va TARGET_ARCH Ns = Ns Li i386 356and 357.Va TARGET Ns = Ns Li pc98 . 358If not set, 359.Va TARGET 360defaults to the current hardware platform. 361.It Va TARGET_ARCH 362The target machine processor architecture. 363This is analogous to the 364.Dq Nm uname Fl p 365output. 366Set this to cross-build for a different architecture. 367If not set, 368.Va TARGET_ARCH 369defaults to the current machine architecture, unless 370.Va TARGET 371is also set, in which case it defaults to the appropriate 372value for that platform. 373.El 374.Pp 375Builds under directory 376.Pa /usr/doc 377are influenced by the following 378.Xr make 1 379variables: 380.Bl -tag -width ".Va DOC_LANG" 381.It Va DOC_LANG 382If set, restricts the documentation build to the language subdirectories 383specified as its content. 384The default action is to build documentation for all languages. 385.El 386.Sh FILES 387.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 388.It Pa /usr/doc/Makefile 389.It Pa /usr/doc/share/mk/doc.project.mk 390.It Pa /usr/ports/Mk/bsd.port.mk 391.It Pa /usr/ports/Mk/bsd.sites.mk 392.It Pa /usr/share/examples/etc/make.conf 393.It Pa /usr/src/Makefile 394.It Pa /usr/src/Makefile.inc1 395.El 396.Sh EXAMPLES 397For an 398.Dq approved 399method of updating your system from the latest sources, please see the 400.Sx COMMON ITEMS 401section in 402.Pa src/UPDATING . 403.Pp 404The following sequence of commands can be used to cross-build the 405system for the sparc64 architecture on an i386 host: 406.Bd -literal -offset indent 407cd /usr/src 408make TARGET=sparc64 buildworld 409make TARGET=sparc64 DESTDIR=/clients/sparc64 installworld 410.Ed 411.Sh SEE ALSO 412.Xr cc 1 , 413.Xr install 1 , 414.Xr make 1 , 415.Xr make.conf 5 , 416.Xr src.conf 5 , 417.Xr ports 7 , 418.Xr release 7 , 419.Xr config 8 , 420.Xr mergemaster 8 , 421.Xr reboot 8 , 422.Xr shutdown 8 423.Sh AUTHORS 424.An Mike W. Meyer Aq mwm@mired.org . 425