i386 removal, part 2/x: Remove i386 specific kernel config files.
[dragonfly.git] / share / man / man7 / build.7
CommitLineData
984263bc
MD
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.\"
dd7331fe 27.Dd June 20, 2015
984263bc
MD
28.Dt BUILD 7
29.Os
30.Sh NAME
31.Nm build
32.Nd information on how to build the system
33.Sh DESCRIPTION
34The source for the
9bb2a92d 35.Dx
b4223d36
SW
36system and applications is located in
37.Pa /usr/src .
38This directory contains the
984263bc
MD
39.Dq "base system"
40sources, which is loosely defined as the things required to rebuild
41the system to a useful state.
0cd7b3a7
HP
42It also contains the source for the system documentation, including
43manual pages.
2f2b5493
SW
44Refer to
45.Xr development 7
46for more information on how to obtain the
47.Dx
48sources.
49.Pp
b4223d36 50Third party applications have to be built using the
e8c03636 51.Xr dports 7
b4223d36
SW
52system.
53The file
329dd511
SW
54.Pa /usr/Makefile
55has targets for obtaining the dports tree.
56Typing
57.Li make
58in
59.Pa /usr
d524fc16 60gives specifics on how to obtain the tree for building packages.
984263bc
MD
61.Pp
62The
63.Xr make 1
b4223d36
SW
64command is used in
65.Pa /usr/src
66to build and install the things in that directory.
67Issuing the
4fb5b569
SW
68.Xr make 1
69command in any directory or
984263bc 70subdirectory of those directories has the same effect as issuing the
b4223d36
SW
71same command in all subdirectories of that directory.
72With no target specified, the things in that directory are just built.
73The following list provides the names and actions for other targets:
4fb5b569
SW
74.Bl -tag -width ".Cm install"
75.It Cm clean
984263bc 76Removes any files created during the build process.
4fb5b569 77.It Cm install
984263bc 78Installs the results of the build for this directory.
984263bc
MD
79.El
80.Pp
81The other
82.Pa /usr/src
83make targets are:
2cd128d1 84.Bl -tag -width ".Cm installworld-force"
4fb5b569
SW
85.It Cm buildworld
86Rebuild everything but the kernel.
87.It Cm quickworld
88Same as
89.Cm buildworld ,
90but skip bootstrap, build and cross-build tool steps.
91This target can be used for incremental upgrades once a full build of the
92world has been done with
93.Cm buildworld .
94.It Cm realquickworld
95Same as
96.Cm quickworld ,
97but also skip the depend step.
98.It Cm crossworld
99Just do the bootstrap, build and cross-build steps.
100.It Cm installworld
984263bc 101Install everything built by
4fb5b569 102.Cm buildworld .
2cd128d1
RH
103.It Cm installworld-force
104Force an
105.Cm installworld .
106This will install to a temporary directory, then copy the main binaries
107and libraries with a static
108.Xr cpdup 1
109to
110.Ev DESTDIR
111and finally will issue a normal
112.Cm installworld
113and
114.Cm upgrade .
115It is a special case to be used on older systems as a last resort when
116the normal
117.Cm installworld
118doesn't work.
4fb5b569
SW
119.It Cm world
120.Cm buildworld +
121.Cm installworld .
122.It Cm buildkernel
984263bc 123Rebuild the kernel and the kernel-modules.
4fb5b569
SW
124.It Cm nativekernel
125Rebuild the kernel and the kernel-modules using native tools.
126.It Cm quickkernel
127Same as
128.Cm buildkernel ,
129but skip the depend step and do not clean out the
b4223d36
SW
130obj modules.
131This target can be used for incremental upgrades once a full
4fb5b569
SW
132build of the kernel has been done with
133.Cm buildkernel .
134.It Cm installkernel
984263bc 135Install the kernel and the kernel-modules.
4fb5b569 136.It Cm reinstallkernel
984263bc 137Reinstall the kernel and the kernel-modules.
4fb5b569
SW
138.It Cm kernel
139.Cm buildkernel +
140.Cm installkernel .
141.It Cm preupgrade
142Perform certain upgrades that have to be done before
143.Cm installworld .
144.Cm installworld
145will complain if they have not been done.
146.It Cm upgrade
147Upgrade the files in /etc and also setup the rest of the system for
a3220ac5
SW
148the version of
149.Dx
150just installed.
a63e7f94
RH
151.It Cm rescue
152Create a rescue initrd.
4fb5b569 153.It Cm most
984263bc 154Build user commands, no libraries or include files.
4fb5b569 155.It Cm installmost
984263bc 156Install user commands, no libraries or include files.
2decc9b9
JM
157.It Cm backupworld
158Manually archive binaries from installed world to location specified by
159.Ev WORLD_BACKUP .
160.It Cm backup-clean
161Delete archive created by
162.Cm backupworld .
163.It Cm backup-auto-clean
164Delete archive created automatically during
165.Cm installworld .
166.It Cm restoreworld
167Restore binaries from archive created by
168.Cm backupworld .
169.It Cm restoreworld-auto
170Restore binaries from archive created automatically during
171.Cm installworld .
172The archive location is specified by
173.Ev AUTO_BACKUP .
984263bc 174.El
984263bc 175.Sh ENVIRONMENT
29c86147
SW
176.Bl -tag -width ".Ev MAKEOBJDIRPREFIX"
177.It Ev TARGET_ARCH , TARGET_PLATFORM
178The target machine processor architecture and hardware platform.
179These have to be set for cross-building.
180.Ev TARGET_ARCH
181is analogous to the
4fb5b569 182.Dq Nm uname Fl p
984263bc 183output.
29c86147
SW
184To build for the 32 bit
185.Tn Intel
186architecture known as IA-32, x86 or x86-32, use:
187.Bd -literal -offset indent
188TARGET_ARCH=i386
189TARGET_PLATFORM=pc32
190.Ed
191.Pp
192For the 64 bit
193.Tn AMD
194architecture known as AMD64, x86-64 or Intel 64, use:
195.Bd -literal -offset indent
b2b3ffcd 196TARGET_ARCH=x86_64
29c86147
SW
197TARGET_PLATFORM=pc64
198.Ed
f82d774f 199.It Ev DESTDIR
e2c9718c
SW
200An existing directory to be the root of
201the hierarchy where the resulting binaries will be
f82d774f
SW
202installed (the default is
203.Pa / ) .
204.It Ev MAKEOBJDIRPREFIX
205The directory hierarchy where the object files will be built (the default is
206.Pa /usr/obj ) .
458e075b
SW
207.It Ev __MAKE_CONF
208Used to override the path of
209.Xr make.conf 5
210(the default is
211.Pa /etc/make.conf ) .
f82d774f
SW
212.It Ev KERNCONF
213The name of the kernel configuration file from which the kernel should
214be built (the default is
dd7331fe 215.Li X86_64_GENERIC ) .
f82d774f
SW
216.It Ev KERNCONFDIR
217The directory where the kernel configuration files are kept (the default is
218.Pa /usr/src/sys/config ) .
0aa15547
YT
219.It Ev DESTLABEL
220Common suffix added to kernel and modules directory names, prefixed by
221a single dot. For example,
222.Bd -literal -offset indent
223make DESTLABEL=test installkernel
224.Ed
225.Pp
226installs them as
af300af3 227.Pa /boot/kernel.test/kernel
0aa15547 228and
af300af3 229.Pa /boot/kernel.test ,
0aa15547
YT
230respectively.
231.It Ev DESTKERNDIR
232Where to install the kernel and the modules (the default is
233.Pa /boot ) ,
234in the directory hierarchy specified by the environment variable
235.Ev DESTDIR .
236.It Ev DESTKERNNAME
237The name of the installed kernel file (the default is
238.Pa kernel ) ,
239under the directory specified by
240.Ev DESTKERNDIR .
241This overrides the effect of
242.Ev DESTLABEL .
243.It Ev DESTMODULESNAME
244The name of the directory to install the kernel modules (the default is
245.Pa modules ) ,
246under the directory specified by
247.Ev DESTKERNDIR .
248This overrides the effect of
249.Ev DESTLABEL .
2decc9b9
JM
250.It Ev WORLD_BACKUP
251Directory for manual backup of binaries of installed world (default:
252.Pa /var/backups/world_backup ) .
253.It Ev AUTO_BACKUP
254Directory for automatic backup of binaries of installed world (default:
255.Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR ) .
256.It Ev NO_BACKUP
d3479bf7 257When defined, the automatic backup feature of
2decc9b9
JM
258.Cm installworld
259is inhibited.
984263bc
MD
260.El
261.Sh FILES
0ee79394 262.Bl -tag -width ".Pa /usr/src/Makefile_upgrade.inc" -compact
984263bc 263.It Pa /etc/make.conf
4fb5b569 264.It Pa /etc/defaults/make.conf
0cd7b3a7 265.It Pa /usr/src/share/doc/Makefile
984263bc
MD
266.It Pa /usr/src/Makefile
267.It Pa /usr/src/Makefile.inc1
0ee79394 268.It Pa /usr/src/Makefile_upgrade.inc
984263bc
MD
269.El
270.Sh EXAMPLES
271The
272.Dq approved
273method of updating your system from the latest sources is:
274.Bd -literal -offset indent
275make buildworld
276make buildkernel KERNCONF=FOO
277make installkernel KERNCONF=FOO
278make installworld
9eee3f0a 279make upgrade
984263bc
MD
280.Ed
281.Pp
984263bc 282After running these commands a system reboot is required,
9b102de4
SW
283otherwise many programs which have been rebuilt (such as
284.Xr ps 1 ,
285.Xr top 1 ,
286etc.) may not work with the old kernel which is still running.
806e1a3a
SW
287.Sh CAVEATS
288The build and install order in the
289.Sx EXAMPLES
290section enforces that the new kernel is installed before the new
291world.
292Sometimes it might be necessary to reboot the system between those two
293steps.
f82d774f
SW
294In this case
295.Dq Nm make Cm installworld
296will tell you to do so.
984263bc
MD
297.Sh SEE ALSO
298.Xr cc 1 ,
299.Xr install 1 ,
300.Xr make 1 ,
7d3337b3 301.Xr wmake 1 ,
984263bc 302.Xr make.conf 5 ,
127e04d4 303.Xr development 7 ,
e8c03636 304.Xr dports 7 ,
984263bc 305.Xr release 7 ,
4fb5b569 306.Xr config 8 ,
984263bc
MD
307.Xr reboot 8 ,
308.Xr shutdown 8
309.Sh AUTHORS
b4223d36 310.An -nosplit
c616d378 311.An Mike W. Meyer Aq Mt mwm@mired.org
b4223d36 312and
c616d378 313.An Sascha Wildner Aq Mt swildner@gmail.com .