build.7 revision 82953
Copyright (c) 2000
Mike W. Meyer

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

$FreeBSD: head/share/man/man7/build.7 82953 2001-09-04 10:08:19Z ru $

.Dd November 4, 2000 .Dt BUILD 7 .Os .Sh NAME .Nm build .Nd information on how to build the system .Sh DESCRIPTION The source for the .Fx system and applications are contained in three different directories, normally

a /usr/src ,

a /usr/doc , and

a /usr/ports .

a /usr/src contains the .Dq "base system" sources, which is loosely defined as the things required to rebuild the system to a useful state.

a /usr/doc contains the source for the system documentation, excluding the manual pages.

a /usr/ports is a tree that provides a consistent interface for building and installing third party applications.

p The .Xr make 1 command is used in each of these directories to build and install the things in that directory. Issuing the make command in any directory or subdirectory of those directories has the same effect as issuing the same command in all subdirectories of that directory. With no target specified, the things in that directory are just built. The following list provides the names and actions for other targets: l -tag -width Ar t Ar clean Removes any files created during the build process. t Ar install Installs the results of the build for this directory. t Ar update Gets updated sources as configured in

a /etc/make.conf . .El

p The other

a /usr/src make targets are: l -tag -width Ar t Ar buildworld Rebuild everything but the kernel, configure files in

a /etc , and release. t Ar installworld Install everything built by .Dq buildworld . t Ar world buildworld + installworld. t Ar buildkernel Rebuild the kernel and the kernel-modules. t Ar installkernel Install the kernel and the kernel-modules. t Ar reinstallkernel Reinstall the kernel and the kernel-modules. t Ar upgrade Upgrade a.out (2.2.x/3.0) system to the new ELF way t Ar most Build user commands, no libraries or include files. t Ar installmost Install user commands, no libraries or include files. t Ar aout-to-elf Upgrade an system from a.out to elf format. t Ar aout-to-elf-build Build everything required to upgrade a system from a.out to elf format. t Ar aout-to-elf-install Install everything built by aout-to-elf-build. t Ar move-aout-libs Move the a.out libraries into an aout sub-directory of each elf library sub-directory. .El

p For more information about the ports build process, see .Xr ports 7 . .Sh FILES l -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact t Pa /etc/make.conf t Pa /usr/doc/Makefile t Pa /usr/doc/share/mk/doc.project.mk t Pa /usr/ports/Mk/bsd.port.mk t Pa /usr/ports/Mk/bsd.sites.mk t Pa /usr/share/examples/etc//make.conf t Pa /usr/src/Makefile t Pa /usr/src/Makefile.inc1 .El .Sh EXAMPLES The .Dq approved method of updating your system from the latest sources is: d -literal -offset indent make buildworld make buildkernel KERNCONF=FOO make installkernel KERNCONF=FOO make installworld mergemaster .Ed

p .Dq FOO must be replaced with the name of the kernel configuration file from which the kernel should be built. Alternatively, the .Va KERNCONF variable in

a /etc/make.conf can be set to the name of the kernel to build; in this case the .Dq KERNCONF=FOO part of the .Dq buildkernel and .Dq installkernel commands can be omitted.

p After running these commands a system reboot is required, otherwise many programs which have been rebuilt (such as .Nm ps , .Nm top , etc) may not work with the old kernel which is still running. .Sh SEE ALSO .Xr cc 1 , .Xr install 1 , .Xr make 1 , .Xr make.conf 5 , .Xr ports 7 , .Xr mergemaster 8 , .Xr reboot 8 , .Xr shutdown 8 .Sh AUTHORS .An Mike W. Meyer Aq mwm@mired.org .