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.10 2006/03/16 18:32:12 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 while
52 describes the variables and targets that are available.
58 to build and install the things in that directory.
61 command in any directory or
62 subdirectory of those directories has the same effect as issuing the
63 same command in all subdirectories of that directory.
64 With no target specified, the things in that directory are just built.
65 The following list provides the names and actions for other targets:
66 .Bl -tag -width ".Cm install"
68 Removes any files created during the build process.
70 Installs the results of the build for this directory.
72 Gets updated sources as configured in
79 .Bl -tag -width ".Cm reinstallkernel"
81 Rebuild everything but the kernel.
85 but skip bootstrap, build and cross-build tool steps.
86 This target can be used for incremental upgrades once a full build of the
87 world has been done with
92 but also skip the depend step.
94 Just do the bootstrap, build and cross-build steps.
96 Install everything built by
102 Rebuild the kernel and the kernel-modules.
104 Rebuild the kernel and the kernel-modules using native tools.
108 but skip the depend step and do not clean out the
110 This target can be used for incremental upgrades once a full
111 build of the kernel has been done with
114 Install the kernel and the kernel-modules.
115 .It Cm reinstallkernel
116 Reinstall the kernel and the kernel-modules.
121 Perform certain upgrades that have to be done before
124 will complain if they have not been done.
126 Upgrade the files in /etc and also setup the rest of the system for
131 Build user commands, no libraries or include files.
133 Install user commands, no libraries or include files.
136 .Bl -tag -width ".Va TARGET_ARCH"
138 The target machine processor architecture.
139 This is analogous to the
142 .\"Set this to cross-build for a different architecture.
144 The target hardware platform.
145 This is analogous to the
148 .\"This is necessary to cross-build some target architectures.
150 If defined, warnings will not cause the build to halt, even if the
151 makefile says otherwise.
153 The directory hierarchy where the resulting binaries will be
157 .Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact
158 .It Pa /etc/make.conf
159 .It Pa /etc/defaults/make.conf
160 .It Pa /usr/src/share/doc/Makefile
161 .It Pa /usr/src/Makefile
162 .It Pa /usr/src/Makefile.inc1
167 method of updating your system from the latest sources is:
168 .Bd -literal -offset indent
170 make buildkernel KERNCONF=FOO
171 make installkernel KERNCONF=FOO
177 must be replaced with the name of the kernel configuration file from which
178 the kernel should be built.
183 can be set to the name of the kernel to build;
190 commands can be omitted.
192 After running these commands a system reboot is required,
193 otherwise many programs which have been rebuilt
198 may not work with the old kernel which is still running.
200 The build and install order in the
202 section enforces that the new kernel is installed before the new
204 Sometimes it might be necessary to reboot the system between those two
208 target will tell you so.
210 Also note that you should
214 target before having installed the new kernel and world because your
215 system might (in the worst case) be rendered useless if you do so.
216 This can happen because
218 might remove something that the old system still needs for
219 functioning correctly.
233 .An Mike W. Meyer Aq mwm@mired.org
235 .An Sascha Wildner Aq swildner@gmail.com .