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 skip the depend step and do not clean out the
131 This target can be used for incremental upgrades once a full
132 build of the kernel has been done with
135 Install the kernel and the kernel-modules.
136 .It Cm reinstallkernel
137 Reinstall the kernel and the kernel-modules.
142 Perform certain upgrades that have to be done before
145 will complain if they have not been done.
147 Upgrade the files in /etc and also setup the rest of the system for
152 Create a rescue initrd.
154 Build user commands, no libraries or include files.
156 Install user commands, no libraries or include files.
158 Manually archive binaries from installed world to location specified by
161 Delete archive created by
163 .It Cm backup-auto-clean
164 Delete archive created automatically during
167 Restore binaries from archive created by
169 .It Cm restoreworld-auto
170 Restore binaries from archive created automatically during
172 The archive location is specified by
176 .Bl -tag -width ".Ev MAKEOBJDIRPREFIX"
177 .It Ev TARGET_ARCH , TARGET_PLATFORM
178 The target machine processor architecture and hardware platform.
179 These have to be set for cross-building.
184 To build for the 32 bit
186 architecture known as IA-32, x86 or x86-32, use:
187 .Bd -literal -offset indent
194 architecture known as AMD64, x86-64 or Intel 64, use:
195 .Bd -literal -offset indent
200 An existing directory to be the root of
201 the hierarchy where the resulting binaries will be
202 installed (the default is
204 .It Ev MAKEOBJDIRPREFIX
205 The directory hierarchy where the object files will be built (the default is
208 Used to override the path of
211 .Pa /etc/make.conf ) .
213 The name of the kernel configuration file from which the kernel should
214 be built (the default is
217 The directory where the kernel configuration files are kept (the default is
218 .Pa /usr/src/sys/config ) .
220 Common suffix added to kernel and modules directory names, prefixed by
221 a single dot. For example,
222 .Bd -literal -offset indent
223 make DESTLABEL=test installkernel
227 .Pa /boot/kernel.test/kernel
229 .Pa /boot/kernel.test ,
232 Where to install the kernel and the modules (the default is
234 in the directory hierarchy specified by the environment variable
237 The name of the installed kernel file (the default is
239 under the directory specified by
241 This overrides the effect of
243 .It Ev DESTMODULESNAME
244 The name of the directory to install the kernel modules (the default is
246 under the directory specified by
248 This overrides the effect of
251 Directory for manual backup of binaries of installed world (default:
252 .Pa /var/backups/world_backup ) .
254 Directory for automatic backup of binaries of installed world (default:
255 .Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) .
257 When defined, the automatic backup feature of
262 .Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact
263 .It Pa /etc/make.conf
264 .It Pa /etc/defaults/make.conf
265 .It Pa /usr/src/share/doc/Makefile
266 .It Pa /usr/src/Makefile
267 .It Pa /usr/src/Makefile.inc1
268 .It Pa /usr/src/Makefile_upgrade.inc
273 method of updating your system from the latest sources is:
274 .Bd -literal -offset indent
276 make buildkernel KERNCONF=FOO
277 make installkernel KERNCONF=FOO
282 After running these commands a system reboot is required,
283 otherwise many programs which have been rebuilt (such as
286 etc.) may not work with the old kernel which is still running.
288 The build and install order in the
290 section enforces that the new kernel is installed before the new
292 Sometimes it might be necessary to reboot the system between those two
295 .Dq Nm make Cm installworld
296 will tell you to do so.
311 .An Mike W. Meyer Aq Mt mwm@mired.org
313 .An Sascha Wildner Aq Mt swildner@gmail.com .