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 $
32 .Nd information on how to build the system
36 system and applications is located in
38 This directory contains the
40 sources, which is loosely defined as the things required to rebuild
41 the system to a useful state.
42 It also contains the source for the system documentation, including
46 for more information on how to obtain the
50 Third party applications have to be built using the
55 has targets for obtaining the dports tree.
60 gives specifics on how to obtain the tree for building packages.
66 to build and install the things in that directory.
69 command in any directory or
70 subdirectory of those directories has the same effect as issuing the
71 same command in all subdirectories of that directory.
72 With no target specified, the things in that directory are just built.
73 The following list provides the names and actions for other targets:
74 .Bl -tag -width ".Cm install"
76 Removes any files created during the build process.
78 Installs the results of the build for this directory.
84 .Bl -tag -width ".Cm installworld-force"
86 Rebuild everything but the kernel.
90 but skip bootstrap, build and cross-build tool steps.
91 This target can be used for incremental upgrades once a full build of the
92 world has been done with
97 but also skip the depend step.
99 Just do the bootstrap, build and cross-build steps.
101 Install everything built by
103 .It Cm installworld-force
106 This will install to a temporary directory, then copy the main binaries
107 and libraries with a static
111 and finally will issue a normal
115 It is a special case to be used on older systems as a last resort when
123 Rebuild the kernel and the kernel-modules.
125 Rebuild the kernel and the kernel-modules using native tools.
129 but do not clean out the obj modules.
130 This target can be used for incremental upgrades once a full
131 build of the kernel has been done with
133 .It Cm realquickkernel
136 but also skip the depend step.
138 Install the kernel and the kernel-modules.
139 .It Cm reinstallkernel
140 Reinstall the kernel and the kernel-modules.
145 Perform certain upgrades that have to be done before
147 such as adding new users and groups.
149 will complain if they have not been done.
151 Upgrade the files in /etc and also setup the rest of the system for
156 Build and install the statically linked rescue tools.
158 Create the initial ramdisk based on the above rescue tools and install.
160 Manually archive binaries from installed world to location specified by
163 Delete archive created by
165 .It Cm backup-auto-clean
166 Delete archive created automatically during
169 Restore binaries from archive created by
171 .It Cm restoreworld-auto
172 Restore binaries from archive created automatically during
174 The archive location is specified by
178 .Bl -tag -width ".Ev MAKEOBJDIRPREFIX"
179 .It Ev TARGET_ARCH , TARGET_PLATFORM
180 The target machine processor architecture and hardware platform.
181 These have to be set for cross-building.
188 architecture known as AMD64, x86-64 or Intel 64, use:
189 .Bd -literal -offset indent
194 An existing directory to be the root of
195 the hierarchy where the resulting binaries will be
196 installed (the default is
198 .It Ev MAKEOBJDIRPREFIX
199 The directory hierarchy where the object files will be built (the default is
202 Used to override the path of
205 .Pa /etc/make.conf ) .
207 The name of one or more kernel configurations from which kernels should
208 be built (the default is
209 .Li X86_64_GENERIC ) .
211 The directory where the kernel configuration files are kept (the default is
212 .Pa /usr/src/sys/config ) .
214 Common suffix added to kernel and modules directory names, prefixed by
215 a single dot. For example,
216 .Bd -literal -offset indent
217 make DESTLABEL=test installkernel
221 .Pa /boot/kernel.test/kernel
223 .Pa /boot/kernel.test ,
226 Where to install the kernel and the modules (the default is
228 in the directory hierarchy specified by the environment variable
231 The name of the installed kernel file (the default is
233 under the directory specified by
235 This overrides the effect of
237 .It Ev DESTMODULESNAME
238 The name of the directory to install the kernel modules (the default is
240 under the directory specified by
242 This overrides the effect of
245 Directory for manual backup of binaries of installed world (default:
246 .Pa /var/backups/world_backup ) .
248 Directory for automatic backup of binaries of installed world (default:
249 .Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) .
251 When defined, the automatic backup feature of
255 Overrides the default optimization flags for kernel and module compiles.
257 Allows you to add additional compiler flags for kernel and module compiles.
260 to specify any optimization overrides, as some modules may have to override
261 it to enforce a lower optimization level.
264 There are two other mechanisms that users should be aware of. First,
268 will make a backup of the current kernel in
269 .Pa /boot/kernel.old .
270 Because people often do multiple installkernel operations, this backup
271 kernel can also get lost in the noise.
272 It is usually prudent to make a backup of the old kernel manually
273 every once in a while when you know that it is a good kernel. you can
274 do this after issuing the
276 by running the command:
277 .Bd -literal -offset indent
278 cpdup /boot/kernel.old /boot/kernel.bak
281 The advantage of this is that no installation mechanism will overwrite
283 .Pa /boot/kernel.bak ,
284 and in addition to that the loader's boot menu will check for its
285 existence and present a menu option 'b' to allow you to boot from it.
287 The second mechanism is related to the two-stage root mount.
288 When using an encrypted root, the system will actually boot from a
289 small initial ramdisk (a.k.a. initrd) image stored as
290 .Pa /boot/kernel/initrd.img.gz .
291 This image will handle the encrypted configuration, mount, and chroot
293 This image is also used as the rescue ramdisk boot menu option.
294 This image is NOT updated automatically by
298 Instead, updating this image has to be done by running the manual command:
299 .Bd -literal -offset indent
303 It is usually a good idea to run this command after rebooting into the new
304 world that you installed (so you know the world you installed is good).
305 This command will update the initrd image in
308 .Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact
309 .It Pa /etc/make.conf
310 .It Pa /etc/defaults/make.conf
311 .It Pa /usr/src/share/doc/Makefile
312 .It Pa /usr/src/Makefile
313 .It Pa /usr/src/Makefile.inc1
314 .It Pa /usr/src/Makefile_upgrade.inc
319 method of updating your system from the latest sources is:
320 .Bd -literal -offset indent
322 make buildkernel KERNCONF=FOO
323 make installkernel KERNCONF=FOO
328 After running these commands a system reboot is required,
329 otherwise many programs which have been rebuilt (such as
332 etc.) may not work with the old kernel which is still running.
334 The above mentioned build and install order enforces that the new kernel
335 is installed before the new world.
336 Sometimes it might be necessary to reboot the system between those two
339 .Dq Nm make Cm installworld
340 will tell you to do so.
355 .An Mike W. Meyer Aq Mt mwm@mired.org
357 .An Sascha Wildner Aq Mt swildner@gmail.com .