0723fc140dbe2a236ad5707bc7f6cd37d392e4ca
[dragonfly.git] / share / man / man7 / build.7
1 .\" Copyright (c) 2000
2 .\"     Mike W. Meyer
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
12 .\"
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
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man7/build.7,v 1.19.2.1 2002/03/18 08:33:02 murray Exp $
26 .\"
27 .Dd July 23, 2016
28 .Dt BUILD 7
29 .Os
30 .Sh NAME
31 .Nm build
32 .Nd information on how to build the system
33 .Sh DESCRIPTION
34 The source for the
35 .Dx
36 system and applications is located in
37 .Pa /usr/src .
38 This directory contains the
39 .Dq "base system"
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
43 manual pages.
44 Refer to
45 .Xr development 7
46 for more information on how to obtain the
47 .Dx
48 sources.
49 .Pp
50 Third party applications have to be built using the
51 .Xr dports 7
52 system.
53 The file
54 .Pa /usr/Makefile
55 has targets for obtaining the dports tree.
56 Typing
57 .Li make
58 in
59 .Pa /usr
60 gives specifics on how to obtain the tree for building packages.
61 .Pp
62 The
63 .Xr make 1
64 command is used in
65 .Pa /usr/src
66 to build and install the things in that directory.
67 Issuing the
68 .Xr make 1
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"
75 .It Cm clean
76 Removes any files created during the build process.
77 .It Cm install
78 Installs the results of the build for this directory.
79 .El
80 .Pp
81 The other
82 .Pa /usr/src
83 make targets are:
84 .Bl -tag -width ".Cm installworld-force"
85 .It Cm buildworld
86 Rebuild everything but the kernel.
87 .It Cm quickworld
88 Same as
89 .Cm buildworld ,
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
93 .Cm buildworld .
94 .It Cm realquickworld
95 Same as
96 .Cm quickworld ,
97 but also skip the depend step.
98 .It Cm crossworld
99 Just do the bootstrap, build and cross-build steps.
100 .It Cm installworld
101 Install everything built by
102 .Cm buildworld .
103 .It Cm installworld-force
104 Force an
105 .Cm installworld .
106 This will install to a temporary directory, then copy the main binaries
107 and libraries with a static
108 .Xr cpdup 1
109 to
110 .Ev DESTDIR
111 and finally will issue a normal
112 .Cm installworld
113 and
114 .Cm upgrade .
115 It is a special case to be used on older systems as a last resort when
116 the normal
117 .Cm installworld
118 doesn't work.
119 .It Cm world
120 .Cm buildworld +
121 .Cm installworld .
122 .It Cm buildkernel
123 Rebuild the kernel and the kernel-modules.
124 .It Cm nativekernel
125 Rebuild the kernel and the kernel-modules using native tools.
126 .It Cm quickkernel
127 Same as
128 .Cm buildkernel ,
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
132 .Cm buildkernel .
133 .It Cm realquickkernel
134 Same as
135 .Cm quickkernel ,
136 but also skip the depend step.
137 .It Cm installkernel
138 Install the kernel and the kernel-modules.
139 .It Cm reinstallkernel
140 Reinstall the kernel and the kernel-modules.
141 .It Cm kernel
142 .Cm buildkernel +
143 .Cm installkernel .
144 .It Cm preupgrade
145 Perform certain upgrades that have to be done before
146 .Cm installworld .
147 .Cm installworld
148 will complain if they have not been done.
149 .It Cm upgrade
150 Upgrade the files in /etc and also setup the rest of the system for
151 the version of
152 .Dx
153 just installed.
154 .It Cm rescue
155 Create a rescue initrd.
156 .It Cm most
157 Build user commands, no libraries or include files.
158 .It Cm installmost
159 Install user commands, no libraries or include files.
160 .It Cm backupworld
161 Manually archive binaries from installed world to location specified by
162 .Ev WORLD_BACKUP .
163 .It Cm backup-clean
164 Delete archive created by
165 .Cm backupworld .
166 .It Cm backup-auto-clean
167 Delete archive created automatically during
168 .Cm installworld .
169 .It Cm restoreworld
170 Restore binaries from archive created by
171 .Cm backupworld .
172 .It Cm restoreworld-auto
173 Restore binaries from archive created automatically during
174 .Cm installworld .
175 The archive location is specified by
176 .Ev AUTO_BACKUP .
177 .El
178 .Sh ENVIRONMENT
179 .Bl -tag -width ".Ev MAKEOBJDIRPREFIX"
180 .It Ev TARGET_ARCH , TARGET_PLATFORM
181 The target machine processor architecture and hardware platform.
182 These have to be set for cross-building.
183 .Ev TARGET_ARCH
184 is analogous to the
185 .Dq Nm uname Fl p
186 output.
187 For the 64 bit
188 .Tn AMD
189 architecture known as AMD64, x86-64 or Intel 64, use:
190 .Bd -literal -offset indent
191 TARGET_ARCH=x86_64
192 TARGET_PLATFORM=pc64
193 .Ed
194 .It Ev DESTDIR
195 An existing directory to be the root of
196 the hierarchy where the resulting binaries will be
197 installed (the default is
198 .Pa / ) .
199 .It Ev MAKEOBJDIRPREFIX
200 The directory hierarchy where the object files will be built (the default is
201 .Pa /usr/obj ) .
202 .It Ev __MAKE_CONF
203 Used to override the path of
204 .Xr make.conf 5
205 (the default is
206 .Pa /etc/make.conf ) .
207 .It Ev KERNCONF
208 The name of one or more kernel configurations from which kernels should
209 be built (the default is
210 .Li X86_64_GENERIC ) .
211 .It Ev KERNCONFDIR
212 The directory where the kernel configuration files are kept (the default is
213 .Pa /usr/src/sys/config ) .
214 .It Ev DESTLABEL
215 Common suffix added to kernel and modules directory names, prefixed by
216 a single dot.  For example,
217 .Bd -literal -offset indent
218 make DESTLABEL=test installkernel
219 .Ed
220 .Pp
221 installs them as
222 .Pa /boot/kernel.test/kernel
223 and
224 .Pa /boot/kernel.test ,
225 respectively.
226 .It Ev DESTKERNDIR
227 Where to install the kernel and the modules (the default is
228 .Pa /boot ) ,
229 in the directory hierarchy specified by the environment variable
230 .Ev DESTDIR .
231 .It Ev DESTKERNNAME
232 The name of the installed kernel file (the default is
233 .Pa kernel ) ,
234 under the directory specified by
235 .Ev DESTKERNDIR .
236 This overrides the effect of
237 .Ev DESTLABEL .
238 .It Ev DESTMODULESNAME
239 The name of the directory to install the kernel modules (the default is
240 .Pa modules ) ,
241 under the directory specified by
242 .Ev DESTKERNDIR .
243 This overrides the effect of
244 .Ev DESTLABEL .
245 .It Ev WORLD_BACKUP
246 Directory for manual backup of binaries of installed world (default:
247 .Pa /var/backups/world_backup ) .
248 .It Ev AUTO_BACKUP
249 Directory for automatic backup of binaries of installed world (default:
250 .Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) .
251 .It Ev NO_BACKUP
252 When defined, the automatic backup feature of
253 .Cm installworld
254 is inhibited.
255 .It Ev COPTFLAGS
256 Overrides the default optimization flags for kernel and module compiles.
257 .It Ev KCFLAGS
258 Allows you to add additional compiler flags for kernel and module compiles.
259 But use
260 .Ev COPTFLAGS
261 to specify any optimization overrides, as some modules may have to override
262 it to enforce a lower optimization level.
263 .El
264 .Sh OTHER
265 There are two other mechanisms that users should be aware of.  First,
266 when you issue a
267 .Cm installkernel
268 .Dx
269 will make a backup of the current kernel in
270 .Pa /boot/kernel.old .
271 Because people often do multiple installkernel operations, this backup
272 kernel can also get lost in the noise.
273 It is usually prudent to make a backup of the old kernel manually
274 every once in a while when you know that it is a good kernel.  you can
275 do this after issuing the
276 .Cm installkernel
277 by running the command:
278 .Bd -literal -offset indent
279 cpdup /boot/kernel.old /boot/kernel.bak
280 .Ed
281 .Pp
282 The advantage of this is that no installation mechanism will overwrite
283 your
284 .Pa /boot/kernel.bak ,
285 and in addition to that the loader's boot menu will check for its
286 existence and present a menu option 'b' to allow you to boot from it.
287 .Pp
288 The second mechanism is related to the two-stage root mount.
289 When using an encrypted root, the system will actually boot from a
290 small UFS image stored as
291 .Pa /boot/kernel/initrd.img.gz .
292 This image will handle the encrypted configuration, mount, and chroot
293 to the real root.
294 This image is also used as the rescue ramdisk boot menu option.
295 This image is NOT updated automatically by
296 .Cm installworld
297 or
298 .Cm installkernel .
299 Instead, updating this image has to be done by running the manual command:
300 .Bd -literal -offset indent
301 mkinitrd
302 .Ed
303 .Pp
304 It is usually a good idea to run this command after rebooting into a new
305 world that you installed (so you know the world you installed is good).
306 This command will update the rescue ramdisk image in
307 .Pa /boot/kernel .
308 .Sh FILES
309 .Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact
310 .It Pa /etc/make.conf
311 .It Pa /etc/defaults/make.conf
312 .It Pa /usr/src/share/doc/Makefile
313 .It Pa /usr/src/Makefile
314 .It Pa /usr/src/Makefile.inc1
315 .It Pa /usr/src/Makefile_upgrade.inc
316 .El
317 .Sh EXAMPLES
318 The
319 .Dq approved
320 method of updating your system from the latest sources is:
321 .Bd -literal -offset indent
322 make buildworld
323 make buildkernel KERNCONF=FOO
324 make installkernel KERNCONF=FOO
325 make installworld
326 make upgrade
327 .Ed
328 .Pp
329 After running these commands a system reboot is required,
330 otherwise many programs which have been rebuilt (such as
331 .Xr ps 1 ,
332 .Xr top 1 ,
333 etc.) may not work with the old kernel which is still running.
334 .Sh CAVEATS
335 The build and install order in the
336 .Sx EXAMPLES
337 section enforces that the new kernel is installed before the new
338 world.
339 Sometimes it might be necessary to reboot the system between those two
340 steps.
341 In this case
342 .Dq Nm make Cm installworld
343 will tell you to do so.
344 .Sh SEE ALSO
345 .Xr cc 1 ,
346 .Xr install 1 ,
347 .Xr make 1 ,
348 .Xr wmake 1 ,
349 .Xr make.conf 5 ,
350 .Xr development 7 ,
351 .Xr dports 7 ,
352 .Xr release 7 ,
353 .Xr config 8 ,
354 .Xr reboot 8 ,
355 .Xr shutdown 8
356 .Sh AUTHORS
357 .An -nosplit
358 .An Mike W. Meyer Aq Mt mwm@mired.org
359 and
360 .An Sascha Wildner Aq Mt swildner@gmail.com .