* Kill hard sentence breaks.
[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 .\" $DragonFly: src/share/man/man7/build.7,v 1.10 2006/03/16 18:32:12 swildner Exp $
27 .\"
28 .Dd March 8, 2006
29 .Dt BUILD 7
30 .Os
31 .Sh NAME
32 .Nm build
33 .Nd information on how to build the system
34 .Sh DESCRIPTION
35 The source for the
36 .Dx
37 system and applications is located in
38 .Pa /usr/src .
39 This directory contains the
40 .Dq "base system"
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
44 manual pages.
45 Third party applications have to be built using the
46 .Em pkgsrc
47 system.
48 The file
49 .Pa /usr/src/UPDATING
50 gives specifics on how to obtain the tree for building packages while
51 .Xr packages 7
52 describes the variables and targets that are available.
53 .Pp
54 The
55 .Xr make 1
56 command is used in
57 .Pa /usr/src
58 to build and install the things in that directory.
59 Issuing the
60 .Xr make 1
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"
67 .It Cm clean
68 Removes any files created during the build process.
69 .It Cm install
70 Installs the results of the build for this directory.
71 .It Cm update
72 Gets updated sources as configured in
73 .Pa /etc/make.conf .
74 .El
75 .Pp
76 The other
77 .Pa /usr/src
78 make targets are:
79 .Bl -tag -width ".Cm reinstallkernel"
80 .It Cm buildworld
81 Rebuild everything but the kernel.
82 .It Cm quickworld
83 Same as
84 .Cm buildworld ,
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
88 .Cm buildworld .
89 .It Cm realquickworld
90 Same as
91 .Cm quickworld ,
92 but also skip the depend step.
93 .It Cm crossworld
94 Just do the bootstrap, build and cross-build steps.
95 .It Cm installworld
96 Install everything built by
97 .Cm buildworld .
98 .It Cm world
99 .Cm buildworld +
100 .Cm installworld .
101 .It Cm buildkernel
102 Rebuild the kernel and the kernel-modules.
103 .It Cm nativekernel
104 Rebuild the kernel and the kernel-modules using native tools.
105 .It Cm quickkernel
106 Same as
107 .Cm buildkernel ,
108 but skip the depend step and do not clean out the
109 obj modules.
110 This target can be used for incremental upgrades once a full
111 build of the kernel has been done with
112 .Cm buildkernel .
113 .It Cm installkernel
114 Install the kernel and the kernel-modules.
115 .It Cm reinstallkernel
116 Reinstall the kernel and the kernel-modules.
117 .It Cm kernel
118 .Cm buildkernel +
119 .Cm installkernel .
120 .It Cm preupgrade
121 Perform certain upgrades that have to be done before
122 .Cm installworld .
123 .Cm installworld
124 will complain if they have not been done.
125 .It Cm upgrade
126 Upgrade the files in /etc and also setup the rest of the system for
127 the version of
128 .Dx
129 just installed.
130 .It Cm most
131 Build user commands, no libraries or include files.
132 .It Cm installmost
133 Install user commands, no libraries or include files.
134 .El
135 .Sh ENVIRONMENT
136 .Bl -tag -width ".Va TARGET_ARCH"
137 .It Va TARGET_ARCH
138 The target machine processor architecture.
139 This is analogous to the
140 .Dq Nm uname Fl p
141 output.
142 .\"Set this to cross-build for a different architecture.
143 .It Va TARGET
144 The target hardware platform.
145 This is analogous to the
146 .Dq Nm uname Fl m
147 output.
148 .\"This is necessary to cross-build some target architectures.
149 .It Va NO_WERROR
150 If defined, warnings will not cause the build to halt, even if the
151 makefile says otherwise.
152 .It Va DESTDIR
153 The directory hierarchy where the resulting binaries will be
154 installed.
155 .El
156 .Sh FILES
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
163 .El
164 .Sh EXAMPLES
165 The
166 .Dq approved
167 method of updating your system from the latest sources is:
168 .Bd -literal -offset indent
169 make buildworld
170 make buildkernel KERNCONF=FOO
171 make installkernel KERNCONF=FOO
172 make installworld
173 make upgrade
174 .Ed
175 .Pp
176 .Dq FOO
177 must be replaced with the name of the kernel configuration file from which
178 the kernel should be built.
179 Alternatively, the
180 .Va KERNCONF
181 variable in
182 .Pa /etc/make.conf
183 can be set to the name of the kernel to build;
184 in this case the
185 .Dq KERNCONF=FOO
186 part of the
187 .Cm buildkernel
188 and
189 .Cm installkernel
190 commands can be omitted.
191 .Pp
192 After running these commands a system reboot is required,
193 otherwise many programs which have been rebuilt
194 (such as
195 .Nm ps ,
196 .Nm top ,
197 etc)
198 may not work with the old kernel which is still running.
199 .Sh CAVEATS
200 The build and install order in the
201 .Sx EXAMPLES
202 section enforces that the new kernel is installed before the new
203 world.
204 Sometimes it might be necessary to reboot the system between those two
205 steps.
206 In this case the
207 .Cm installworld
208 target will tell you so.
209 .Pp
210 Also note that you should
211 .Em never
212 run the
213 .Cm upgrade
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
217 .Cm upgrade
218 might remove something that the old system still needs for
219 functioning correctly.
220 .Sh SEE ALSO
221 .Xr cc 1 ,
222 .Xr install 1 ,
223 .Xr make 1 ,
224 .Xr wmake 1 ,
225 .Xr make.conf 5 ,
226 .Xr packages 7 ,
227 .Xr release 7 ,
228 .Xr config 8 ,
229 .Xr reboot 8 ,
230 .Xr shutdown 8
231 .Sh AUTHORS
232 .An -nosplit
233 .An Mike W. Meyer Aq mwm@mired.org
234 and
235 .An Sascha Wildner Aq swildner@gmail.com .