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
45 Third party applications have to be built using the
50 gives specifics on how to obtain the tree for building packages.
56 to build and install the things in that directory.
59 command in any directory or
60 subdirectory of those directories has the same effect as issuing the
61 same command in all subdirectories of that directory.
62 With no target specified, the things in that directory are just built.
63 The following list provides the names and actions for other targets:
64 .Bl -tag -width ".Cm install"
66 Removes any files created during the build process.
68 Installs the results of the build for this directory.
74 .Bl -tag -width ".Cm reinstallkernel"
76 Rebuild everything but the kernel.
80 but skip bootstrap, build and cross-build tool steps.
81 This target can be used for incremental upgrades once a full build of the
82 world has been done with
87 but also skip the depend step.
89 Just do the bootstrap, build and cross-build steps.
91 Install everything built by
97 Rebuild the kernel and the kernel-modules.
99 Rebuild the kernel and the kernel-modules using native tools.
103 but skip the depend step and do not clean out the
105 This target can be used for incremental upgrades once a full
106 build of the kernel has been done with
109 Install the kernel and the kernel-modules.
110 .It Cm reinstallkernel
111 Reinstall the kernel and the kernel-modules.
116 Perform certain upgrades that have to be done before
119 will complain if they have not been done.
121 Upgrade the files in /etc and also setup the rest of the system for
126 Build user commands, no libraries or include files.
128 Install user commands, no libraries or include files.
131 .Bl -tag -width ".Ev TARGET_ARCH"
133 The target machine processor architecture.
134 This is analogous to the
137 .\"Set this to cross-build for a different architecture.
139 The target hardware platform.
140 This is analogous to the
143 .\"This is necessary to cross-build some target architectures.
145 .\"If defined, warnings will not cause the build to halt, even if the
146 .\"makefile says otherwise.
148 An existing directory to be the root of
149 the hierarchy where the resulting binaries will be
150 installed (the default is
152 .It Ev MAKEOBJDIRPREFIX
153 The directory hierarchy where the object files will be built (the default is
156 Used to override the path of
159 .Pa /etc/make.conf ) .
161 The name of the kernel configuration file from which the kernel should
162 be built (the default is
165 The directory where the kernel configuration files are kept (the default is
166 .Pa /usr/src/sys/config ) .
168 Common suffix added to kernel and modules directory names, prefixed by
169 a single dot. For example,
170 .Bd -literal -offset indent
171 make DESTLABEL=test installkernel
175 .Pa /boot/kernel.test
177 .Pa /boot/modules.test ,
180 Where to install the kernel and the modules (the default is
182 in the directory hierarchy specified by the environment variable
185 The name of the installed kernel file (the default is
187 under the directory specified by
189 This overrides the effect of
191 .It Ev DESTMODULESNAME
192 The name of the directory to install the kernel modules (the default is
194 under the directory specified by
196 This overrides the effect of
200 .Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact
201 .It Pa /etc/make.conf
202 .It Pa /etc/defaults/make.conf
203 .It Pa /usr/src/share/doc/Makefile
204 .It Pa /usr/src/Makefile
205 .It Pa /usr/src/Makefile.inc1
210 method of updating your system from the latest sources is:
211 .Bd -literal -offset indent
213 make buildkernel KERNCONF=FOO
214 make installkernel KERNCONF=FOO
219 After running these commands a system reboot is required,
220 otherwise many programs which have been rebuilt (such as
223 etc.) may not work with the old kernel which is still running.
225 The build and install order in the
227 section enforces that the new kernel is installed before the new
229 Sometimes it might be necessary to reboot the system between those two
232 .Dq Nm make Cm installworld
233 will tell you to do so.
248 .An Mike W. Meyer Aq mwm@mired.org
250 .An Sascha Wildner Aq swildner@gmail.com .