4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $FreeBSD: src/share/man/man7/build.7,v 1.19.2.1 2002/03/18 08:33:02 murray Exp $
26 .\" $DragonFly: src/share/man/man7/build.7,v 1.18 2008/11/14 15:04:42 swildner Exp $
33 .Nd information on how to build the system
37 system and applications is located in
39 This directory contains the
41 sources, which is loosely defined as the things required to rebuild
42 the system to a useful state.
43 It also contains the source for the system documentation, including
47 for more information on how to obtain the
51 Third party applications have to be built using the
56 gives specifics on how to obtain the tree for building packages.
62 to build and install the things in that directory.
65 command in any directory or
66 subdirectory of those directories has the same effect as issuing the
67 same command in all subdirectories of that directory.
68 With no target specified, the things in that directory are just built.
69 The following list provides the names and actions for other targets:
70 .Bl -tag -width ".Cm install"
72 Removes any files created during the build process.
74 Installs the results of the build for this directory.
80 .Bl -tag -width ".Cm reinstallkernel"
82 Rebuild everything but the kernel.
86 but skip bootstrap, build and cross-build tool steps.
87 This target can be used for incremental upgrades once a full build of the
88 world has been done with
93 but also skip the depend step.
95 Just do the bootstrap, build and cross-build steps.
97 Install everything built by
103 Rebuild the kernel and the kernel-modules.
105 Rebuild the kernel and the kernel-modules using native tools.
109 but skip the depend step and do not clean out the
111 This target can be used for incremental upgrades once a full
112 build of the kernel has been done with
115 Install the kernel and the kernel-modules.
116 .It Cm reinstallkernel
117 Reinstall the kernel and the kernel-modules.
122 Perform certain upgrades that have to be done before
125 will complain if they have not been done.
127 Upgrade the files in /etc and also setup the rest of the system for
132 Build user commands, no libraries or include files.
134 Install user commands, no libraries or include files.
137 .Bl -tag -width ".Ev MAKEOBJDIRPREFIX"
138 .It Ev TARGET_ARCH , TARGET_PLATFORM
139 The target machine processor architecture and hardware platform.
140 These have to be set for cross-building.
145 To build for the 32 bit
147 architecture known as IA-32, x86 or x86-32, use:
148 .Bd -literal -offset indent
155 architecture known as AMD64, x86-64 or Intel 64, use:
156 .Bd -literal -offset indent
161 An existing directory to be the root of
162 the hierarchy where the resulting binaries will be
163 installed (the default is
165 .It Ev MAKEOBJDIRPREFIX
166 The directory hierarchy where the object files will be built (the default is
169 Used to override the path of
172 .Pa /etc/make.conf ) .
174 The name of the kernel configuration file from which the kernel should
175 be built (the default is
178 The directory where the kernel configuration files are kept (the default is
179 .Pa /usr/src/sys/config ) .
181 Common suffix added to kernel and modules directory names, prefixed by
182 a single dot. For example,
183 .Bd -literal -offset indent
184 make DESTLABEL=test installkernel
188 .Pa /boot/kernel.test
190 .Pa /boot/modules.test ,
193 Where to install the kernel and the modules (the default is
195 in the directory hierarchy specified by the environment variable
198 The name of the installed kernel file (the default is
200 under the directory specified by
202 This overrides the effect of
204 .It Ev DESTMODULESNAME
205 The name of the directory to install the kernel modules (the default is
207 under the directory specified by
209 This overrides the effect of
213 .Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact
214 .It Pa /etc/make.conf
215 .It Pa /etc/defaults/make.conf
216 .It Pa /usr/src/share/doc/Makefile
217 .It Pa /usr/src/Makefile
218 .It Pa /usr/src/Makefile.inc1
223 method of updating your system from the latest sources is:
224 .Bd -literal -offset indent
226 make buildkernel KERNCONF=FOO
227 make installkernel KERNCONF=FOO
232 After running these commands a system reboot is required,
233 otherwise many programs which have been rebuilt (such as
236 etc.) may not work with the old kernel which is still running.
238 The build and install order in the
240 section enforces that the new kernel is installed before the new
242 Sometimes it might be necessary to reboot the system between those two
245 .Dq Nm make Cm installworld
246 will tell you to do so.
261 .An Mike W. Meyer Aq mwm@mired.org
263 .An Sascha Wildner Aq swildner@gmail.com .