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.13 2007/05/14 14:28:47 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.
70 Gets updated sources as configured in
77 .Bl -tag -width ".Cm reinstallkernel"
79 Rebuild everything but the kernel.
83 but skip bootstrap, build and cross-build tool steps.
84 This target can be used for incremental upgrades once a full build of the
85 world has been done with
90 but also skip the depend step.
92 Just do the bootstrap, build and cross-build steps.
94 Install everything built by
100 Rebuild the kernel and the kernel-modules.
102 Rebuild the kernel and the kernel-modules using native tools.
106 but skip the depend step and do not clean out the
108 This target can be used for incremental upgrades once a full
109 build of the kernel has been done with
112 Install the kernel and the kernel-modules.
113 .It Cm reinstallkernel
114 Reinstall the kernel and the kernel-modules.
119 Perform certain upgrades that have to be done before
122 will complain if they have not been done.
124 Upgrade the files in /etc and also setup the rest of the system for
129 Build user commands, no libraries or include files.
131 Install user commands, no libraries or include files.
134 .Bl -tag -width ".Ev TARGET_ARCH"
136 The target machine processor architecture.
137 This is analogous to the
140 .\"Set this to cross-build for a different architecture.
142 The target hardware platform.
143 This is analogous to the
146 .\"This is necessary to cross-build some target architectures.
148 If defined, warnings will not cause the build to halt, even if the
149 makefile says otherwise.
151 The directory hierarchy where the resulting binaries will be
152 installed (the default is
154 .It Ev MAKEOBJDIRPREFIX
155 The directory hierarchy where the object files will be built (the default is
158 The name of the kernel configuration file from which the kernel should
159 be built (the default is
162 The directory where the kernel configuration files are kept (the default is
163 .Pa /usr/src/sys/config ) .
166 .Bl -tag -width ".Pa /usr/src/share/doc/Makefile" -compact
167 .It Pa /etc/make.conf
168 .It Pa /etc/defaults/make.conf
169 .It Pa /usr/src/share/doc/Makefile
170 .It Pa /usr/src/Makefile
171 .It Pa /usr/src/Makefile.inc1
176 method of updating your system from the latest sources is:
177 .Bd -literal -offset indent
179 make buildkernel KERNCONF=FOO
180 make installkernel KERNCONF=FOO
185 After running these commands a system reboot is required,
186 otherwise many programs which have been rebuilt
191 may not work with the old kernel which is still running.
193 The build and install order in the
195 section enforces that the new kernel is installed before the new
197 Sometimes it might be necessary to reboot the system between those two
200 .Dq Nm make Cm installworld
201 will tell you to do so.
203 Also note that you should
206 .Dq Nm make Cm upgrade
207 before having installed the new kernel and world because your
208 system might (in the worst case) be rendered useless if you do so.
209 This can happen because
210 .Dq Nm make Cm upgrade
211 might remove something that the old system still needs for
212 functioning correctly.
226 .An Mike W. Meyer Aq mwm@mired.org
228 .An Sascha Wildner Aq swildner@gmail.com .