BUILDING revision 1.104
1BUILDING(8)                 System Manager's Manual                BUILDING(8)
2
3NNAAMMEE
4     BBUUIILLDDIINNGG -- Procedure for building NetBSD from source code.
5
6RREEQQUUIIRREEMMEENNTTSS
7     NetBSD is designed to be buildable on most POSIX-compliant host systems.
8     The basic build procedure is the same whether compiling _n_a_t_i_v_e_l_y (on the
9     same NetBSD architecture) or _c_r_o_s_s _c_o_m_p_i_l_i_n_g (on another architecture or
10     OS).
11
12     This source tree contains a special subtree, ``tools'', which uses the
13     host system to create a build toolchain for the target architecture.  The
14     host system must have at least C and C++ compilers in order to create the
15     toolchain (mmaakkee is not required); all other tools are created as part of
16     the NetBSD build process.  (See the environment variables section below
17     if you need to override or manually select your compilers.)
18
19FFIILLEESS
20   SSoouurrccee ttrreeee llaayyoouutt
21     ddoocc//BBUUIILLDDIINNGG..mmddoocc
22                    This document (in -mdoc troff format; the original copy).
23
24     BBUUIILLDDIINNGG       This document (in plaintext).
25
26     ttoooollss//ccoommppaatt//RREEAADDMMEE
27                    Special notes for cross-hosting a NetBSD build on non-
28                    NetBSD platforms.
29
30     MMaakkeeffiillee       The main Makefile for NetBSD; should only be run for
31                    native builds with an appropriately up-to-date version of
32                    NetBSD make(1).  (For building from out-of-date systems or
33                    on a non-native host, see the bbuuiilldd..sshh shell script.)
34
35     UUPPDDAATTIINNGG       Special notes for updating from an earlier revision of
36                    NetBSD.  It is important to read this file before every
37                    build of an updated source tree.
38
39     bbuuiilldd..sshh       Bourne-compatible shell script used for building the host
40                    build tools and the NetBSD system from scratch.  Can be
41                    used for both native and cross builds, and should be used
42                    instead of make(1) for any source tree that is updated and
43                    recompiled regularly.
44
45     ccrryyppttoo//ddiisstt//, ddiisstt//, ggnnuu//ddiisstt//
46                    Sources imported verbatim from third parties, without
47                    mangling the existing build structure.  Other source trees
48                    in bbiinn through uussrr..ssbbiinn use the NetBSD make(1)
49                    ``reachover'' Makefile semantics when building these
50                    programs for a native host.
51
52     ddiissttrriibb//, eettcc//
53                    Sources for items used when making a full release
54                    snapshot, such as files installed in DDEESSTTDDIIRR_/_e_t_c on the
55                    destination system, boot media, and release notes.
56
57     tteessttss//, rreeggrreessss//
58                    Regression test harness.  Can be cross-compiled, but only
59                    run natively.  _t_e_s_t_s_/ uses the atf(7) test framework;
60                    _r_e_g_r_e_s_s_/ contains older tests that have not yet been
61                    migrated to atf(7).
62
63     ssyyss//           NetBSD kernel sources.
64
65     ttoooollss//         ``Reachover'' build structure for the host build tools.
66                    This has a special method of determining out-of-date
67                    status.
68
69     bbiinn// ...... uussrr..ssbbiinn//
70                    Sources to the NetBSD userland (non-kernel) programs.  If
71                    any of these directories are missing, they will be skipped
72                    during the build.
73
74     xx1111//           ``Reachover'' build structure for X11R6; the source is in
75                    XX1111SSRRCCDDIIRR.
76
77   BBuuiilldd ttrreeee llaayyoouutt
78     The NetBSD build tree is described in hier(7), and the release layout is
79     described in release(7).
80
81CCOONNFFIIGGUURRAATTIIOONN
82   EEnnvviirroonnmmeenntt vvaarriiaabblleess
83     Several environment variables control the behaviour of NetBSD builds.
84
85     HHOOSSTT__SSHH           Path name to a shell available on the host system and
86                       suitable for use during the build.  The NetBSD build
87                       system requires a modern Bourne-like shell with POSIX-
88                       compliant features, and also requires support for the
89                       ``local'' keyword to declare local variables in shell
90                       functions (which is a widely-implemented but non-
91                       standardised feature).
92
93                       Depending on the host system, a suitable shell may be
94                       _/_b_i_n_/_s_h, _/_u_s_r_/_x_p_g_4_/_b_i_n_/_s_h, _/_b_i_n_/_k_s_h (provided it is a
95                       variant of ksh that supports the ``local'' keyword,
96                       such as ksh88, but not ksh93), or _/_u_s_r_/_l_o_c_a_l_/_b_i_n_/_b_a_s_h.
97
98                       Most parts of the build require HHOOSSTT__SSHH to be an
99                       absolute path; however, bbuuiilldd..sshh allows it to be a
100                       simple command name, which will be converted to an
101                       absolute path by searching the PPAATTHH.
102
103     HHOOSSTT__CCCC           Path name to C compiler used to create the toolchain.
104
105     HHOOSSTT__CCXXXX          Path name to C++ compiler used to create the toolchain.
106
107     MMAACCHHIINNEE           Machine type, e.g., ``macppc''.
108
109     MMAACCHHIINNEE__AARRCCHH      Machine architecture, e.g., ``powerpc''.
110
111     MMAAKKEE              Path name to invoke make(1) as.
112
113     MMAAKKEEFFLLAAGGSS         Flags to invoke make(1) with.  Note that bbuuiilldd..sshh
114                       ignores the value of MMAAKKEEFFLLAAGGSS passed in the
115                       environment, but allows MMAAKKEEFFLLAAGGSS to be set via the --VV
116                       option.
117
118     MMAAKKEEOOBBJJDDIIRR        Directory to use as the ..OOBBJJDDIIRR for the current
119                       directory.  The value is subjected to variable
120                       expansion by make(1).  Typical usage is to set this
121                       variable to a value involving the use of
122                       `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the
123                       value of ..OOBBJJDDIIRR from the value of ..CCUURRDDIIRR.  Used only
124                       if MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX is not defined.  MMAAKKEEOOBBJJDDIIRR can be
125                       provided only in the environment or via the --OO flag of
126                       bbuuiilldd..sshh; it cannot usefully be set inside a Makefile,
127                       including _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
128
129     MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX  Top level directory of the object directory tree.  The
130                       value is subjected to variable expansion by make(1).
131                       bbuuiilldd..sshh will create the ${MAKEOBJDIRPREFIX} directory
132                       if necessary, but if make(1) is used without bbuuiilldd..sshh,
133                       then rules in <bsd.obj.mk> will abort the build if the
134                       ${MAKEOBJDIRPREFIX} directory does not exist.  If the
135                       value is defined and valid, then
136                       ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the ..OOBBJJDDIIRR
137                       for the current directory.  The current directory may
138                       be read only.  MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX can be provided only in
139                       the environment or via the --MM flag of bbuuiilldd..sshh; it
140                       cannot usefully be set inside a Makefile, including
141                       _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
142
143   ""mmaakkee"" vvaarriiaabblleess
144     Several variables control the behavior of NetBSD builds.  Unless
145     otherwise specified, these variables may be set in either the process
146     environment or the make(1) configuration file specified by MMAAKKEECCOONNFF.
147
148     BBUUIILLDDIIDD     Identifier for the build.  The identifier will be appended to
149                 object directory names, and can be consulted in the make(1)
150                 configuration file in order to set additional build
151                 parameters, such as compiler flags.
152
153     BBUUIILLDDSSEEEEDD   GCC uses random numbers when compiling C++ code.  This
154                 variable seeds the gcc random number generator using the
155                 -frandom-seed flag with this value.  By default, it is set to
156                 NetBSD-(majorversion).  Using a fixed value causes C++
157                 binaries to be the same when built from the same sources,
158                 resulting in identical (reproducible) builds.  Additional
159                 information is available in the GCC documentation of
160                 -frandom-seed.
161
162     DDEESSTTDDIIRR     Directory to contain the built NetBSD system.  If set,
163                 special options are passed to the compilation tools to
164                 prevent their default use of the host system's //uussrr//iinncclluuddee,
165                 //uussrr//lliibb, and so forth.  This pathname must be an absolute
166                 path, and should _n_o_t end with a slash (/) character.  (For
167                 installation into the system's root directory, set DDEESSTTDDIIRR to
168                 an empty string, not to ``/'').  The directory must reside on
169                 a file system which supports long file names and hard links.
170
171                 _D_e_f_a_u_l_t: Empty string if UUSSEETTOOOOLLSS is ``yes''; unset
172                 otherwise.
173
174                 _N_o_t_e: bbuuiilldd..sshh will provide a default of _d_e_s_t_d_i_r_.MMAACCHHIINNEE (in
175                 the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
176
177     MMAAKKEECCOONNFF    The name of the make(1) configuration file.  _O_n_l_y _s_e_t_t_a_b_l_e _i_n
178                 _t_h_e _p_r_o_c_e_s_s _e_n_v_i_r_o_n_m_e_n_t_.
179
180                 _D_e_f_a_u_l_t: ``/etc/mk.conf''
181
182     MMAAKKEEVVEERRBBOOSSEE
183                 Level of verbosity of status messages.  Supported values:
184
185                 0    No descriptive messages or commands executed by make(1)
186                      are shown.
187
188                 1    Brief messages are shown describing what is being done,
189                      but the actual commands executed by make(1) are not
190                      displayed.
191
192                 2    Descriptive messages are shown as above (prefixed with a
193                      `#'), and ordinary commands performed by make(1) are
194                      displayed.
195
196                 3    In addition to the above, all commands performed by
197                      make(1) are displayed, even if they would ordinarily
198                      have been hidden through use of the ``@'' prefix in the
199                      relevant makefile.
200
201                 4    In addition to the above, commands executed by make(1)
202                      are traced through use of the sh(1) ``--xx'' flag.
203
204                 _D_e_f_a_u_l_t: 2
205
206     MMKKCCAATTPPAAGGEESS  Can be set to ``yes'' or ``no''.  Indicates whether
207                 preformatted plaintext manual pages will be created during a
208                 build.
209
210                 _D_e_f_a_u_l_t: ``no''
211
212     MMKKCCRRYYPPTTOO    Can be set to ``yes'' or ``no''.  Indicates whether
213                 cryptographic code will be included in a build; provided for
214                 the benefit of countries that do not allow strong
215                 cryptography.  Will not affect use of the standard low-
216                 security password encryption system, crypt(3).
217
218                 _D_e_f_a_u_l_t: ``yes''
219
220     MMKKDDOOCC       Can be set to ``yes'' or ``no''.  Indicates whether system
221                 documentation destined for DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e_/_d_o_c will be
222                 installed during a build.
223
224                 _D_e_f_a_u_l_t: ``yes''
225
226     MMKKHHTTMMLL      Can be set to ``yes'' or ``no''.  Indicates whether
227                 preformatted HTML manual pages will be built and installed
228
229                 _D_e_f_a_u_l_t: ``yes''
230
231     MMKKHHOOSSTTOOBBJJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for
232                 programs intended to be run on the compile host, the name,
233                 release, and architecture of the host operating system will
234                 be suffixed to the name of the object directory created by
235                 ``make obj''.  (This allows multiple host systems to compile
236                 NetBSD for a single target.)  If set to ``no'', then programs
237                 built to be run on the compile host will use the same object
238                 directory names as programs built to be run on the target.
239
240                 _D_e_f_a_u_l_t: ``no''
241
242     MMKKIINNFFOO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info
243                 files, used for the documentation for most of the compilation
244                 tools, will be created and installed during a build.
245
246                 _D_e_f_a_u_l_t: ``yes''
247
248     MMKKKKMMOODD      Can be set to ``yes'' or ``no''.  Indicates whether kernel
249                 modules are built and installed.
250
251                 _D_e_f_a_u_l_t: ``yes''
252
253     MMKKLLIINNTT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)
254                 will be run against portions of the NetBSD source code during
255                 the build, and whether lint libraries will be installed into
256                 DDEESSTTDDIIRR_/_u_s_r_/_l_i_b_d_a_t_a_/_l_i_n_t.
257
258                 _D_e_f_a_u_l_t: ``yes''
259
260     MMKKMMAANN       Can be set to ``yes'' or ``no''.  Indicates whether manual
261                 pages will be installed during a build.
262
263                 _D_e_f_a_u_l_t: ``yes''
264
265     MMKKNNLLSS       Can be set to ``yes'' or ``no''.  Indicates whether Native
266                 Language System locale zone files will be compiled and
267                 installed during a build.
268
269                 _D_e_f_a_u_l_t: ``yes''
270
271     MMKKOOBBJJ       Can be set to ``yes'' or ``no''.  Indicates whether object
272                 directories will be created when running ``make obj''.  If
273                 set to ``no'', then all built files will be located inside
274                 the regular source tree.
275
276                 _D_e_f_a_u_l_t: ``yes''
277
278                 Note that setting MMKKOOBBJJ to ``no'' is not recommended and may
279                 cause problems when updating the tree with cvs(1).
280
281     MMKKPPIICC       Can be set to ``yes'' or ``no''.  Indicates whether shared
282                 objects and libraries will be created and installed during a
283                 build.  If set to ``no'', the entire built system will be
284                 statically linked.
285
286                 _D_e_f_a_u_l_t: Platform dependent.  As of this writing, all
287                 platforms except sshh33 default to ``yes''.
288
289     MMKKPPIICCIINNSSTTAALLLL
290                 Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
291                 format libraries (lliibb**__ppiicc..aa), used to generate shared
292                 libraries, are installed during a build.
293
294                 _D_e_f_a_u_l_t: ``yes''
295
296     MMKKPPRROOFFIILLEE   Can be set to ``yes'' or ``no''.  Indicates whether profiled
297                 libraries (lliibb**__pp..aa) will be built and installed during a
298                 build.
299
300                 _D_e_f_a_u_l_t: ``yes''; however, some platforms turn off MMKKPPRROOFFIILLEE
301                 by default at times due to toolchain problems with profiled
302                 code.
303
304     MMKKRREEPPRROO     Can be set to ``yes'' or ``no''.  Create reproducable builds.
305                 This enables different switches to make two builds from the
306                 same source tree result in the same build results.
307
308                 _D_e_f_a_u_l_t: ``no''
309
310     MMKKSSHHAARREE     Can be set to ``yes'' or ``no''.  Indicates whether files
311                 destined to reside in DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e will be built and
312                 installed during a build.  If set to ``no'', then all of
313                 MMKKCCAATTPPAAGGEESS, MMKKDDOOCC, MMKKIINNFFOO, MMKKMMAANN, and MMKKNNLLSS will be set to
314                 ``no'' unconditionally.
315
316                 _D_e_f_a_u_l_t: ``yes''
317
318     MMKKSSTTRRIIPPIIDDEENNTT
319                 Can be set to ``yes'' or ``no''.  Indicates whether RCS IDs,
320                 for use with ident(1), should be stripped from program
321                 binaries and shared libraries.
322
323                 _D_e_f_a_u_l_t: ``no''
324
325     MMKKUUNNPPRRIIVVEEDD  Can be set to ``yes'' or ``no''.  Indicates whether an
326                 unprivileged install will occur.  The user, group,
327                 permissions, and file flags, will not be set on the installed
328                 items; instead the information will be appended to a file
329                 called _M_E_T_A_L_O_G in DDEESSTTDDIIRR.  The contents of _M_E_T_A_L_O_G are used
330                 during the generation of the distribution tar files to ensure
331                 that the appropriate file ownership is stored.
332
333                 _D_e_f_a_u_l_t: ``no''
334
335     MMKKUUPPDDAATTEE    Can be set to ``yes'' or ``no''.  Indicates whether all
336                 install operations intended to write to DDEESSTTDDIIRR will compare
337                 file timestamps before installing, and skip the install phase
338                 if the destination files are up-to-date.  This also has
339                 implications on full builds (see next subsection).
340
341                 _D_e_f_a_u_l_t: ``no''
342
343     MMKKXX1111       Can be set to ``yes'' or ``no''.  Indicates whether X11 is
344                 built from XX1111SSRRCCDDIIRR.
345
346                 _D_e_f_a_u_l_t: ``no''
347
348     TTOOOOLLDDIIRR     Directory to hold the host tools, once built.  If specified,
349                 must be an absolute path.  This directory should be unique to
350                 a given host system and NetBSD source tree.  (However,
351                 multiple targets may share the same TTOOOOLLDDIIRR; the target-
352                 dependent files have unique names.)  If unset, a default
353                 based on the uname(1) information of the host platform will
354                 be created in the ..OOBBJJDDIIRR of _s_r_c.
355
356                 _D_e_f_a_u_l_t: Unset.
357
358     UUSSEETTOOOOLLSS    Indicates whether the tools specified by TTOOOOLLDDIIRR should be
359                 used as part of a build in progress.  Must be set to ``yes''
360                 if cross-compiling.
361
362                 yyeess    Use the tools from TTOOOOLLDDIIRR.
363
364                 nnoo     Do not use the tools from TTOOOOLLDDIIRR, but refuse to build
365                        native compilation tool components that are version-
366                        specific for that tool.
367
368                 nneevveerr  Do not use the tools from TTOOOOLLDDIIRR, even when building
369                        native tool components.  This is similar to the
370                        traditional NetBSD build method, but does _n_o_t verify
371                        that the compilation tools in use are up-to-date
372                        enough in order to build the tree successfully.  This
373                        may cause build or runtime problems when building the
374                        whole NetBSD source tree.
375
376                 _D_e_f_a_u_l_t: ``yes'', unless TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG is set to ``yes''.
377
378                 UUSSEETTOOOOLLSS is also set to ``no'' when using <bsd.*.mk> outside
379                 the NetBSD source tree.
380
381     XX1111SSRRCCDDIIRR   Directory containing the X11R6 source.  If specified, must be
382                 an absolute path.  The main X11R6 source is found in
383                 XX1111SSRRCCDDIIRR_/_x_f_r_e_e_/_x_c.
384
385                 _D_e_f_a_u_l_t: NNEETTBBSSDDRRCCDDIIRR_/_._._/_x_s_r_c, if that exists; otherwise
386                 _/_u_s_r_/_x_s_r_c.
387
388     XX1111FFLLAAVVOOUURR  The style of X11 cross-built, set to either ``Xorg'' or
389                 ``XFree86''.
390
391                 _D_e_f_a_u_l_t: ``Xorg'' on amd64, i386, macppc, shark and sparc64
392                 platforms, ``XFree86'' on everything else.
393
394   ""mmaakkee"" vvaarriiaabblleess ffoorr ffuullll bbuuiillddss
395     These variables only affect the top level ``Makefile'' and do not affect
396     manually building subtrees of the NetBSD source code.
397
398     IINNSSTTAALLLLWWOORRLLDDDDIIRR  Location for the ``make installworld'' target to install
399                      to.  If specified, must be an absolute path.
400
401                      _D_e_f_a_u_l_t: ``/''
402
403     MMKKOOBBJJDDIIRRSS        Can be set to ``yes'' or ``no''.  Indicates whether
404                      object directories will be created automatically (via a
405                      ``make obj'' pass) at the start of a build.
406
407                      _D_e_f_a_u_l_t: ``no''
408
409                      If using bbuuiilldd..sshh, the default is ``yes''.  This may be
410                      set back to ``no'' by giving bbuuiilldd..sshh the --oo option.
411
412     MMKKUUPPDDAATTEE         Can be set to ``yes'' or ``no''.  If set, then in
413                      addition to the effects described for MMKKUUPPDDAATTEE==yyeess
414                      above, this implies the effects of NNOOCCLLEEAANNDDIIRR (i.e.,
415                      ``make cleandir'' is avoided).
416
417                      _D_e_f_a_u_l_t: ``no''
418
419                      If using bbuuiilldd..sshh, this may be set by giving the --uu
420                      option.
421
422     NNBBUUIILLDDJJOOBBSS       Now obsolete.  Use the make(1) option --jj, instead.  See
423                      below.
424
425                      _D_e_f_a_u_l_t: Unset.
426
427     NNOOCCLLEEAANNDDIIRR       If set, avoids the ``make cleandir'' phase of a full
428                      build.  This has the effect of allowing only changed
429                      files in a source tree to be recompiled.  This can speed
430                      up builds when updating only a few files in the tree.
431
432                      _D_e_f_a_u_l_t: Unset.
433
434                      See also MMKKUUPPDDAATTEE.
435
436     NNOODDIISSTTRRIIBBDDIIRRSS    If set, avoids the ``make distrib-dirs'' phase of a full
437                      build.  This skips running mtree(8) on DDEESSTTDDIIRR, useful
438                      on systems where building as an unprivileged user, or
439                      where it is known that the system-wide mtree files have
440                      not changed.
441
442                      _D_e_f_a_u_l_t: Unset.
443
444     NNOOIINNCCLLUUDDEESS       If set, avoids the ``make includes'' phase of a full
445                      build.  This has the effect of preventing make(1) from
446                      thinking that some programs are out-of-date simply
447                      because the system include files have changed.  However,
448                      this option should not be used when updating the entire
449                      NetBSD source tree arbitrarily; it is suggested to use
450                      MMKKUUPPDDAATTEE==yyeess instead in that case.
451
452                      _D_e_f_a_u_l_t: Unset.
453
454     RREELLEEAASSEEDDIIRR       If set, specifies the directory to which a release(7)
455                      layout will be written at the end of a ``make release''.
456                      If specified, must be an absolute path.
457
458                      _D_e_f_a_u_l_t: Unset.
459
460                      _N_o_t_e: bbuuiilldd..sshh will provide a default of _r_e_l_e_a_s_e_d_i_r (in
461                      the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
462
463BBUUIILLDDIINNGG
464   ""mmaakkee"" ccoommmmaanndd lliinnee ooppttiioonnss
465     This is not a summary of all the options available to make(1); only the
466     options used most frequently with NetBSD builds are listed here.
467
468     --jj _n_j_o_b    Run up to _n_j_o_b make(1) subjobs in parallel.  Makefiles should
469                use .WAIT or have explicit dependencies as necessary to
470                enforce build ordering.
471
472     --mm _d_i_r     Specify the default directory for searching for system
473                Makefile segments, mainly the <bsd.*.mk> files.  When building
474                any full NetBSD source tree, this should be set to the
475                ``share/mk'' directory in the source tree.  This is set
476                automatically when building from the top level, or when using
477                bbuuiilldd..sshh.
478
479     --nn         Display the commands that would have been executed, but do not
480                actually execute them.  This will still cause recursion to
481                take place.
482
483     --VV _v_a_r     Print make(1)'s idea of the value of _v_a_r.  Does not build any
484                targets.
485
486     _v_a_r_=_v_a_l_u_e  Set the variable _v_a_r to _v_a_l_u_e, overriding any setting
487                specified by the process environment, the MMAAKKEECCOONNFF
488                configuration file, or the system Makefile segments.
489
490   ""mmaakkee"" ttaarrggeettss
491     These default targets may be built by running make(1) in any subtree of
492     the NetBSD source code.  It is recommended that none of these be used
493     from the top level Makefile; as a specific exception, ``make obj'' and
494     ``make cleandir'' are useful in that context.
495
496     aallll        Build programs, libraries, and preformatted documentation.
497
498     cclleeaann      Remove program and library object code files.
499
500     cclleeaannddiirr   Same as cclleeaann, but also remove preformatted documentation,
501                dependency files generated by ``make depend'', and any other
502                files known to be created at build time.
503
504     ddeeppeenndd     Create dependency files (..ddeeppeenndd) containing more detailed
505                information about the dependencies of source code on header
506                files.  Allows programs to be recompiled automatically when a
507                dependency changes.
508
509     ddeeppeennddaallll  Does a ``make depend'' immediately followed by a ``make all''.
510                This improves cache locality of the build since both passes
511                read the source files in their entirety.
512
513     ddiissttcclleeaann  Synonym for cclleeaannddiirr.
514
515     iinncclluuddeess   Build and install system header files.  Typically needed
516                before any system libraries or programs can be built.
517
518     iinnssttaallll    Install programs, libraries, and documentation into DDEESSTTDDIIRR.
519                Few files will be installed to DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c,
520                DDEESSTTDDIIRR_/_r_o_o_t or DDEESSTTDDIIRR_/_v_a_r in order to prevent user supplied
521                configuration data from being overwritten.
522
523     lliinntt       Run lint(1) against the C source code, where appropriate, and
524                generate system-installed lint libraries.
525
526     oobbjj        Create object directories to be used for built files, instead
527                of building directly in the source tree.
528
529     ttaaggss       Create ctags(1) searchable function lists usable by the ex(1)
530                and vi(1) text editors.
531
532   ""mmaakkee"" ttaarrggeettss ffoorr tthhee ttoopp lleevveell
533     Additional make(1) targets are usable specifically from the top source
534     level to facilitate building the entire NetBSD source tree.
535
536     bbuuiilldd         Build the entire NetBSD system (except the kernel).  This
537                   orders portions of the source tree such that prerequisites
538                   will be built in the proper order.
539
540     ddiissttrriibbuuttiioonn  Do a ``make build'', and then install a full distribution
541                   (which does not include a kernel) into DDEESSTTDDIIRR, including
542                   files in DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c, DDEESSTTDDIIRR_/_r_o_o_t and
543                   DDEESSTTDDIIRR_/_v_a_r.
544
545     bbuuiillddwwoorrlldd    As per ``make distribution'', except that it ensures that
546                   DDEESSTTDDIIRR is not the root directory.
547
548     iinnssttaallllwwoorrlldd  Install the distribution from DDEESSTTDDIIRR to IINNSSTTAALLLLWWOORRLLDDDDIIRR,
549                   which defaults to the root directory.  Ensures that
550                   IINNSSTTAALLLLWWOORRLLDDDDIIRR is not the root directory if cross
551                   compiling.
552
553                   The IINNSSTTAALLLLSSEETTSS environment variable may be set to a space-
554                   separated list of distribution sets to be installed.  By
555                   default, all sets except ``etc'' and ``xetc'' are
556                   installed, so most files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c will not be
557                   installed or modified.
558
559                   _N_o_t_e: Before performing this operation with
560                   IINNSSTTAALLLLWWOORRLLDDDDIIRR=_/, it is highly recommended that you
561                   upgrade your kernel and reboot.  After performing this
562                   operation, it is recommended that you use etcupdate(8) to
563                   update files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c, and postinstall(8) to
564                   check for or fix inconsistencies.
565
566     sseettss          Create distribution sets from DDEESSTTDDIIRR into
567                   RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_e_t_s.  Should be run
568                   after ``make distribution'', as ``make build'' alone does
569                   not install all of the required files.
570
571     ssoouurrcceesseettss    Create source sets of the source tree into
572                   RREELLEEAASSEEDDIIRR_/_s_o_u_r_c_e_/_s_e_t_s.
573
574     ssyyssppkkggss       Create syspkgs from DDEESSTTDDIIRR into
575                   RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_y_s_p_k_g_s.  Should be run
576                   after ``make distribution'', as ``make build'' alone does
577                   not install all of the required files.
578
579     rreelleeaassee       Do a ``make distribution'', build kernels, distribution
580                   media, and install sets (this as per ``make sets''), and
581                   then package the system into a standard release layout as
582                   described by release(7).  This requires that RREELLEEAASSEEDDIIRR be
583                   set (see above).
584
585     iissoo--iimmaaggee     Create a NetBSD installation CD-ROM image in the
586                   RREELLEEAASSEEDDIIRR_/_i_s_o directory.  The CD-ROM file system will have
587                   a layout as described in release(7).
588
589                   For most machine types, the CD-ROM will be bootable, and
590                   will automatically run the sysinst(8) menu-based
591                   installation program, which can be used to install or
592                   upgrade a NetBSD system.  Bootable CD-ROMs also contain
593                   tools that may be useful in repairing a damaged NetBSD
594                   installation.
595
596                   Before ``make iso-image'' is attempted, RELEASEDIR must be
597                   populated by ``make release'' or equivalent.
598
599                   Note that other, smaller, CD-ROM images may be created in
600                   the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
601                   directory by ``make release''.  These smaller images
602                   usually contain the same tools as the larger images in
603                   RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such
604                   as the distribution sets.
605
606                   Note that the mac68k port still uses an older method of
607                   creating CD-ROM images.  This requires the mkisofs(1)
608                   utility, which is not part of NetBSD, but which can be
609                   installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
610
611     iissoo--iimmaaggee--ssoouurrccee
612                   Create a NetBSD installation CD-ROM image in the
613                   RREELLEEAASSEEDDIIRR_/_i_s_o directory.  The CD-ROM file system will have
614                   a layout as described in release(7).  It will have top
615                   level directories for the machine type and source.
616
617                   For most machine types, the CD-ROM will be bootable, and
618                   will automatically run the sysinst(8) menu-based
619                   installation program, which can be used to install or
620                   upgrade a NetBSD system.  Bootable CD-ROMs also contain
621                   tools that may be useful in repairing a damaged NetBSD
622                   installation.
623
624                   Before ``make iso-image-source'' is attempted, RELEASEDIR
625                   must be populated by ``make sourcesets release'' or
626                   equivalent.
627
628                   Note that other, smaller, CD-ROM images may be created in
629                   the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
630                   directory by ``make release''.  These smaller images
631                   usually contain the same tools as the larger images in
632                   RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such
633                   as the distribution sets.
634
635                   Note that the mac68k port still uses an older method of
636                   creating CD-ROM images.  This requires the mkisofs(1)
637                   utility, which is not part of NetBSD, but which can be
638                   installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
639
640     iinnssttaallll--iimmaaggee
641                   Create a bootable NetBSD installation disk image in the
642                   RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_i_n_s_t_a_l_l_i_m_a_g_e
643                   directory.  The installation disk image is suitable for
644                   copying to bootable USB flash memory sticks, etc., for
645                   machines which are able to boot from such devices.  The
646                   file system in the bootable disk image will have a layout
647                   as described in release(7).
648
649                   The installation image is bootable, and will automatically
650                   run the sysinst(8) menu-based installation program, which
651                   can be used to install or upgrade a NetBSD system.  The
652                   image also contains tools that may be useful in repairing a
653                   damaged NetBSD installation.
654
655                   Before ``make install-image'' is attempted, RREELLEEAASSEEDDIIRR must
656                   be populated by ``make release'' or equivalent.  The build
657                   must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
658                   install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
659
660     live-image    Create NetBSD live images in the
661                   RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_l_i_v_e_i_m_a_g_e
662                   directory.  The live image contains all necessary files to
663                   boot NetBSD up to multi-user mode, including all files
664                   which should be extracted during installation, NetBSD
665                   disklabel, bootloaders, etc.
666
667                   The live image is suitable for use as a disk image in
668                   virtual machine environments such as QEMU, and also useful
669                   to boot NetBSD from a USB flash memory stick on a real
670                   machine, without the need for installation.
671
672                   Before ``make live-image'' is attempted, RELEASEDIR must be
673                   populated by ``make release'' or equivalent.  The build
674                   must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
675                   install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
676
677     rreeggrreessssiioonn--tteessttss
678                   Can only be run after building the regression tests in the
679                   directory ``regress''.  Runs those compiled regression
680                   tests on the local host.  Note that most tests are now
681                   managed instead using atf(7); this target should probably
682                   run those as well but currently does not.
683
684   TThhee ""bbuuiilldd..sshh"" ssccrriipptt
685     This script file is a shell script designed to build the entire NetBSD
686     system on any host with a suitable modern shell and some common
687     utilities.  The required shell features are described under the HHOOSSTT__SSHH
688     variable.
689
690     If a host system's default shell does support the required features, then
691     we suggest that you explicitly specify a suitable shell using a command
692     like
693
694           /path/to/suitable/shell build.sh [_o_p_t_i_o_n_s]
695
696     The above command will usually enable bbuuiilldd..sshh to automatically set
697     HHOOSSTT__SSHH==_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l, but if that fails, then the following
698     set of commands may be used instead:
699
700           HOST_SH=_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l
701           export HOST_SH
702           ${HOST_SH} build.sh [_o_p_t_i_o_n_s]
703
704     If bbuuiilldd..sshh detects that it is being executed under an unsuitable shell,
705     it attempts to exec a suitable shell instead, or prints an error message.
706     If HHOOSSTT__SSHH is not set explicitly, then bbuuiilldd..sshh sets a default using
707     heuristics dependent on the host platform, or from the shell under which
708     bbuuiilldd..sshh is executed (if that can be determined), or using the first copy
709     of _s_h found in PPAATTHH.
710
711     All cross-compile builds, and most native builds, of the entire system
712     should make use of bbuuiilldd..sshh rather than just running ``make''.  This way,
713     the make(1) program will be bootstrapped properly, in case the host
714     system has an older or incompatible ``make'' program.
715
716     When compiling the entire system via bbuuiilldd..sshh, many make(1) variables are
717     set for you in order to help encapsulate the build process.  In the list
718     of options below, variables that are automatically set by bbuuiilldd..sshh are
719     noted where applicable.
720
721     The following operations are supported by bbuuiilldd..sshh:
722
723     bbuuiilldd         Build the system as per ``make build''.  Before the main
724                   part of the build commences, this command runs the oobbjj
725                   operation (unless the --oo option is given), ``make
726                   cleandir'' (unless the --uu option is given), and the ttoooollss
727                   operation.
728
729     ddiissttrriibbuuttiioonn  Build a full distribution as per ``make distribution''.
730                   This command first runs the bbuuiilldd operation.
731
732     rreelleeaassee       Build a full release as per ``make release''.  This command
733                   first runs the ddiissttrriibbuuttiioonn operation.
734
735     mmaakkeewwrraappppeerr   Create the nnbbmmaakkee--MMAACCHHIINNEE wrapper.  This operation is
736                   automatically performed for any of the other operations.
737
738     cclleeaannddiirr      Perform ``make cleandir''.
739
740     oobbjj           Perform ``make obj''.
741
742     ttoooollss         Build and install the host tools from _s_r_c_/_t_o_o_l_s.  This
743                   command will first run ``make obj'' and ``make cleandir''
744                   in the _t_o_o_l_s subdirectory unless the --oo or --uu options
745                   (respectively) are given.
746
747     iinnssttaallll=_i_d_i_r  Install the contents of DDEESSTTDDIIRR to _i_d_i_r, using ``make
748                   installworld''.  Note that files that are part of the
749                   ``etc'' or ``xetc'' sets will not be installed, unless
750                   overridden by the INSTALLSETS environment variable.
751
752     kkeerrnneell=_k_c_o_n_f  Build a new kernel.  The _k_c_o_n_f argument is the name of a
753                   configuration file suitable for use by config(1).  If _k_c_o_n_f
754                   does not contain any `/' characters, the configuration file
755                   is expected to be found in the KKEERRNNCCOONNFFDDIIRR directory, which
756                   is typically ssyyss//aarrcchh//MMAACCHHIINNEE//ccoonnff.  The new kernel will be
757                   built in a subdirectory of KKEERRNNOOBBJJDDIIRR, which is typically
758                   ssyyss//aarrcchh//MMAACCHHIINNEE//ccoommppiillee or an associated object directory.
759
760                   This command does _n_o_t imply the ttoooollss command; run the
761                   ttoooollss command first unless it is _c_e_r_t_a_i_n that the tools
762                   already exist and are up to date.
763
764                   This command will run ``make cleandir'' on the kernel in
765                   question first unless the --uu option is given.
766
767     mmoodduulleess       This command will build kernel modules and install them
768                   into DDEESSTTDDIIRR.
769
770     rreelleeaasseekkeerrnneell=_k_c_o_n_f
771                   Install a gzip(1)ed copy of the kernel previously built by
772                   kkeerrnneell=_k_c_o_n_f into
773                   RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_k_e_r_n_e_l, usually as
774                   _n_e_t_b_s_d_-_k_c_o_n_f_._g_z, although the ``_n_e_t_b_s_d'' prefix is
775                   determined from the ``ccoonnffiigg'' directives in _k_c_o_n_f.
776
777     sseettss          Perform ``make sets''.
778
779     ssoouurrcceesseettss    Perform ``make sourcesets''.
780
781     ssyyssppkkggss       Perform ``make syspkgs''.
782
783     iissoo--iimmaaggee     Perform ``make iso-image''.
784
785     iissoo--iimmaaggee--ssoouurrccee
786                   Perform ``make iso-image-source''.
787
788     iinnssttaallll--iimmaaggee
789                   Perform ``make install-image''.
790
791     lliivvee--iimmaaggee    Perform ``make live-image''.
792
793     The following command line options alter the behaviour of the bbuuiilldd..sshh
794     operations described above:
795
796     --aa _a_r_c_h   Set the value of MMAACCHHIINNEE__AARRCCHH to _a_r_c_h.
797
798     --BB _b_u_i_l_d_i_d
799               Set the value of BBUUIILLDDIIDD to _b_u_i_l_d_i_d.  This will also append the
800               build identifier to the name of the ``make'' wrapper script so
801               that the resulting name is of the form
802               ``nnbbmmaakkee--MMAACCHHIINNEE--BBUUIILLDDIIDD''.
803
804     --CC _c_d_e_x_t_r_a_s
805               Append _c_d_e_x_t_r_a_s to the CCDDEEXXTTRRAA variable, which is a space-
806               separated list of files or directories that will be added to
807               the CD-ROM image that may be create by the ``iso-image'' or
808               ``iso-image-source'' operations.  Files will be added to the
809               root of the CD-ROM image, whereas directories will be copied
810               recursively.  If relative paths are specified, they will be
811               converted to absolute paths before being used.  Multiple paths
812               may be specified via multiple --CC options, or via a single
813               option whose argument contains multiple space-separated paths.
814
815     --DD _d_e_s_t   Set the value of DDEESSTTDDIIRR to _d_e_s_t.  If a relative path is
816               specified, it will be converted to an absolute path before
817               being used.
818
819     --EE        Set `expert' mode.  This overrides various sanity checks, and
820               allows: DDEESSTTDDIIRR does not have to be set to a non-root path for
821               builds, and MMKKUUNNPPRRIIVVEEDD==yyeess does not have to be set when
822               building as a non-root user.
823
824               _N_o_t_e: It is highly recommended that you know what you are doing
825               when you use this option.
826
827     --hh        Print a help message.
828
829     --jj _n_j_o_b   Run up to _n_j_o_b make(1) subjobs in parallel; passed through to
830               make(1).  If you see failures for reasons other than running
831               out of memory while using bbuuiilldd..sshh with --jj, please save
832               complete build logs so the failures can be analyzed.
833
834               To achieve the fastest builds, --jj values between (1 + the
835               number of CPUs) and (2 * the number of CPUs) are recommended.
836               Use lower values on machines with limited memory or I/O
837               bandwidth.
838
839     --MM _o_b_j    Set MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX to _o_b_j.  Unsets MMAAKKEEOOBBJJDDIIRR.  See ``--OO
840               --oobbjj'' for more information.
841
842               For instance, if the source directory is _/_u_s_r_/_s_r_c, a setting of
843               ``--MM _/_u_s_r_/_o_b_j'' will place build-time files under
844               _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_b_i_n, _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_l_i_b,
845               _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_u_s_r_._b_i_n, and so forth.
846
847               If a relative path is specified, it will be converted to an
848               absolute path before being used.  bbuuiilldd..sshh imposes the
849               restriction that the argument to the --MM option must not begin
850               with a ``$'' (dollar sign) character; otherwise it would be too
851               difficult to determine whether the value is an absolute or a
852               relative path.  If the directory does not already exist,
853               bbuuiilldd..sshh will create it.
854
855     --mm _m_a_c_h   Set the value of MMAACCHHIINNEE to _m_a_c_h, except in some special cases
856               listed below.  This will also override any value of
857               MMAACCHHIINNEE__AARRCCHH in the process environment with a value deduced
858               from _m_a_c_h, unless --aa is specified.  All cross builds require
859               --mm, but if unset on a NetBSD host, the host's value of MACHINE
860               will be detected and used automatically.
861
862               Some machines support multiple values for MMAACCHHIINNEE__AARRCCHH.  The
863               following special cases for the _m_a_c_h argument are defined to
864               set the listed values of MMAACCHHIINNEE and MMAACCHHIINNEE__AARRCCHH:
865
866                     mmaacchh          MMAACCHHIINNEE    MMAACCHHIINNEE__AARRCCHH
867                     evbarm        evbarm     (not set)
868                     evbarm-eb     evbarm     armeb
869                     evbarm-el     evbarm     arm
870                     evbmips       evbmips    (not set)
871                     evbmips-eb    evbmips    mipseb
872                     evbmips-el    evbmips    mipsel
873                     evbsh3        evbsh3     (not set)
874                     evbsh3-eb     evbsh3     sh3eb
875                     evbsh3-el     evbsh3     sh3el
876                     sbmips        sbmips     (not set)
877                     sbmips-eb     sbmips     mipseb
878                     sbmips-el     sbmips     mipsel
879
880     --NN _n_o_i_s_e_l_e_v_e_l
881               Set the ``noisyness'' level of the build, by setting
882               MMAAKKEEVVEERRBBOOSSEE to _n_o_i_s_e_l_e_v_e_l.
883
884     --nn        Show the commands that would be executed by bbuuiilldd..sshh, but do
885               not make any changes.  This is similar in concept to ``make
886               -n''.
887
888     --OO _o_b_j    Create an appropriate transform macro for MMAAKKEEOOBBJJDDIIRR that will
889               place the built object files under _o_b_j.  Unsets
890               MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX.
891
892               For instance, a setting of ``--OO _/_u_s_r_/_o_b_j'' will place build-
893               time files under _/_u_s_r_/_o_b_j_/_b_i_n, _/_u_s_r_/_o_b_j_/_l_i_b, _/_u_s_r_/_o_b_j_/_u_s_r_._b_i_n,
894               and so forth.
895
896               If a relative path is specified, it will be converted to an
897               absolute path before being used.  bbuuiilldd..sshh imposes the
898               restriction that the argument to the --OO option must not contain
899               a ``$'' (dollar sign) character.  If the directory does not
900               already exist, bbuuiilldd..sshh will create it.
901
902               In normal use, exactly one of the --MM or --OO options should be
903               specified.  If neither --MM nor --OO is specified, then a default
904               object directory will be chosen according to rules in
905               <bsd.obj.mk>.  Relying on this default is not recommended
906               because it is determined by complex rules that are influenced
907               by the values of several variables and by the location of the
908               source directory.
909
910     --oo        Set the value of MMKKOOBBJJDDIIRRSS to ``no''.  Otherwise, it will be
911               automatically set to ``yes''.  This default is opposite to the
912               behaviour when not using bbuuiilldd..sshh.
913
914     --RR _r_e_l    Set the value of RREELLEEAASSEEDDIIRR to _r_e_l.  If a relative path is
915               specified, it will be converted to an absolute path before
916               being used.
917
918     --rr        Remove the contents of DDEESSTTDDIIRR and TTOOOOLLDDIIRR before building
919               (provides a clean starting point).  This will skip deleting
920               DDEESSTTDDIIRR if building on a native system to the root directory.
921
922     --SS _s_e_e_d   Change the value of BBUUIILLDDSSEEEEDD to _s_e_e_d.  This should rarely be
923               necessary.
924
925     --TT _t_o_o_l_s  Set the value of TTOOOOLLDDIIRR to _t_o_o_l_s.  If a relative path is
926               specified, it will be converted to an absolute path before
927               being used.  If set, the bootstrap ``make'' will only be
928               rebuilt if the source files for make(1) have changed.
929
930     --UU        Set MMKKUUNNPPRRIIVVEEDD==yyeess.
931
932     --uu        Set MMKKUUPPDDAATTEE==yyeess.
933
934     --VV _v_a_r=[_v_a_l_u_e]
935               Set the environment variable _v_a_r to an optional _v_a_l_u_e.  This is
936               propagated to the nnbbmmaakkee wrapper.
937
938     --ww _w_r_a_p_p_e_r
939               Create the nnbbmmaakkee wrapper script (see below) in a custom
940               location, specified by _w_r_a_p_p_e_r.  This allows, for instance, to
941               place the wrapper in PPAATTHH automatically.  Note that _w_r_a_p_p_e_r is
942               the full name of the file, not just a directory name.  If a
943               relative path is specified, it will be converted to an absolute
944               path before being used.
945
946     --XX _x_1_1_s_r_c
947               Set the value of XX1111SSRRCCDDIIRR to _x_1_1_s_r_c.  If a relative path is
948               specified, it will be converted to an absolute path before
949               being used.
950
951     --xx        Set MMKKXX1111==yyeess.
952
953     --ZZ _v_a_r    Unset ("zap") the environment variable _v_a_r.  This is propagated
954               to the nnbbmmaakkee wrapper.
955
956   TThhee ""nnbbmmaakkee--MMAACCHHIINNEE"" wwrraappppeerr ssccrriipptt
957     If using the bbuuiilldd..sshh script to build NetBSD, a nnbbmmaakkee--MMAACCHHIINNEE script
958     will be created in TTOOOOLLDDIIRR//bbiinn upon the first build to assist in building
959     subtrees on a cross-compile host.
960
961     nnbbmmaakkee--MMAACCHHIINNEE can be invoked in lieu of make(1), and will instead call
962     the up-to-date version of ``nbmake'' installed into TTOOOOLLDDIIRR//bbiinn with
963     several key variables pre-set, including MMAACCHHIINNEE, MMAACCHHIINNEE__AARRCCHH, and
964     TTOOOOLLDDIIRR.  nnbbmmaakkee--MMAACCHHIINNEE will also set variables specified with --VV, and
965     unset variables specified with --ZZ.
966
967     This script can be symlinked into a directory listed in PPAATTHH, or called
968     with an absolute path.
969
970EEXXAAMMPPLLEESS
971     1.   % ./build.sh [options] tools kernel=GENERIC
972
973          Build a new toolchain, and use the new toolchain to configure and
974          build a new GENERIC kernel.
975
976     2.   % ./build.sh [options] -U distribution
977
978          Using unprivileged mode, build a complete distribution to a DDEESSTTDDIIRR
979          directory that bbuuiilldd..sshh selects (and will display).
980
981     3.   # ./build.sh [options] -U install=/
982
983          As root, install to _/ the distribution that was built by example 2.
984          Even though this is run as root, --UU is required so that the
985          permissions stored in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G are correctly applied to the
986          files as they're copied to _/.
987
988     4.   % ./build.sh [options] -U -u release
989
990          Using unprivileged mode, build a complete release to DDEESSTTDDIIRR and
991          RREELLEEAASSEEDDIIRR directories that bbuuiilldd..sshh selects (and will display).
992          MMKKUUPPDDAATTEE==yyeess (--uu) is set to prevent the ``make cleandir'', so that
993          if this is run after example 2, it doesn't need to redo that portion
994          of the release build.
995
996OOBBSSOOLLEETTEE VVAARRIIAABBLLEESS
997     NNBBUUIILLDDJJOOBBSS  Use the make(1) option --jj instead.
998
999     UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN
1000                 The new toolchain is now the default.  To disable, use
1001                 TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG==yyeess.
1002
1003SSEEEE AALLSSOO
1004     make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8),
1005     _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s
1006
1007HHIISSTTOORRYY
1008     The bbuuiilldd..sshh based build scheme was introduced for NetBSD 1.6 as
1009     UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN, and re-worked to TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG after that.
1010
1011NetBSD                         November 8, 2012                         NetBSD
1012