bsd.README revision 1.381
1#	$NetBSD: bsd.README,v 1.381 2018/07/25 23:30:22 kamil Exp $
2#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
3
4This is the README file for the make "include" files for the NetBSD
5source tree.  The files are installed in /usr/share/mk, and are,
6by convention, named with the suffix ".mk".
7
8Note, this file is not intended to replace reading through the .mk
9files for anything tricky.
10
11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
12
13RANDOM THINGS WORTH KNOWING:
14
15The files are simply C-style #include files, and pretty much behave like
16you'd expect.  The syntax is slightly different in that a single '.' is
17used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
18
19One difference that will save you lots of debugging time is that inclusion
20of the file is normally done at the *end* of the Makefile.  The reason for
21this is because .mk files often modify variables and behavior based on the
22values of variables set in the Makefile.  To make this work, remember that
23the FIRST target found is the target that is used, i.e. if the Makefile has:
24
25	a:
26		echo a
27	a:
28		echo a number two
29
30the command "make a" will echo "a".  To make things confusing, the SECOND
31variable assignment is the overriding one, i.e. if the Makefile has:
32
33	a=	foo
34	a=	bar
35
36	b:
37		echo ${a}
38
39the command "make b" will echo "bar".  This is for compatibility with the
40way the V7 make behaved.
41
42It's fairly difficult to make the BSD .mk files work when you're building
43multiple programs in a single directory.  It's a lot easier to split up the
44programs than to deal with the problem.  Most of the agony comes from making
45the "obj" directory stuff work right, not because we switched to a new version
46of make.  So, don't get mad at us, figure out a better way to handle multiple
47architectures so we can quit using the symbolic link stuff.  (Imake doesn't
48count.)
49
50The file .depend in the source directory is expected to contain dependencies
51for the source files.  This file is read automatically by make after reading
52the Makefile.
53
54The variable DESTDIR works as before.  It's not set anywhere but will change
55the tree where the file gets installed.
56
57The profiled libraries are no longer built in a different directory than
58the regular libraries.  A new suffix, ".po", is used to denote a profiled
59object, and ".pico" denotes a shared (position-independent) object.
60
61There are various make variables used during the build.
62
63Many variables support a (case sensitive) value of "no" or "yes",
64and are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
65
66
67The basic rule for the variable naming scheme is as follows:
68
69HOST_xxx	A command that runs on the host machine regardless of
70		whether or not the system is being cross compiled, or
71		flags for such a command.
72
73MKxxx		Can be set to "no" to disable functionality, or
74		"yes" to enable it.
75		Usually defaults to "yes", although some variables
76		default to "no".
77		Due to make(1) implementation issues, if a temporary
78		command-line override of a mk.conf(5) or <bsd.own.mk>
79		setting is required whilst still honoring a particular
80		Makefile's setting of MKxxx, use
81			env MKxxx=value make
82		instead of
83			make MKxxx=value
84
85NOxxx		If defined, disables a feature.
86		Not intended for users.
87		This is to allow Makefiles to disable functionality
88		that they don't support (such as missing man pages).
89		NOxxx variables must be defined before <bsd.own.mk>
90		is included.
91
92TOOL_xxx	A tool that is provided as part of the USETOOLS
93		framework.  When not using the USETOOLS framework,
94		TOOL_xxx variables should refer to tools that are
95		already installed on the host system.
96
97The following variables that control how things are made/installed that
98are not set by default. These should not be set by Makefiles; they're for
99the user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
100or on the make(1) command line:
101
102BUILD 		If defined, 'make install' checks that the targets in the
103		source directories are up-to-date and remakes them if they
104                are out of date, instead of blindly trying to install
105                out of date or non-existent targets.
106
107MAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
108		Default: 2
109		Supported values:
110		    0	Minimal output ("quiet")
111		    1	Describe what is occurring
112		    2	Describe what is occurring and echo the actual command
113		    3	Ignore the effect of the "@" prefix in make commands
114		    4	Trace shell commands using the shell's -x flag
115
116MKATF		If "no", don't build the Automated Testing Framework (ATF),
117		which includes the libatf-c, libatf-c++ and libatf-sh libraries
118		and the various command line tools.  Also, because the build of
119		the libraries is disabled, don't build the NetBSD test suite
120		either.
121		Default: yes
122
123MKBFD		Obsolete, use MKBINUTILS
124
125MKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
126		libopcodes)
127		Default: yes
128
129MKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
130		the pax frontends.
131		Default: no
132
133MKCATPAGES	If "no", don't build or install the catman pages.
134		Default: no
135
136MKCOMPAT  	If "no", don't build or install the src/compat.
137		Default: yes on amd64/mips64/sparc64, no elsewhere.
138
139MKCOMPATTESTS  	If "yes", build and install the NetBSD test suite when
140		building and installing src/compat.
141		Default: no
142
143MKCOMPATX11  	If "yes", build and install the X11 libraries when
144		building and installing src/compat.
145		Default: no
146
147MKCOMPLEX	If "no", don't build libm support for <complex.h>
148		Default: yes
149
150MKCTF		If "no", do not build and install CTF tools, and also
151		don't generate and manipulate CTF data of ELF binaries
152		during build.
153		Default: no
154
155NOCTF		Don't generate and manipulate CTF data of ELF binaries
156		during build. It is set internally for standalone programs.
157
158MKCVS		If "no", don't build or install cvs(1).
159		Default: yes
160
161MKDEBUG		If "no", don't build and install separate debugging symbols
162		into /usr/libdata/debug.
163		Default: no
164
165NODEBUG		Don't compile with debugging symbols during build.
166		It is set internally for standalone programs.
167
168MKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
169		with -DDEBUG.
170		Default: no
171
172MKDEPINCLUDES	If "yes" issue .include statements in the .depend file
173		instead of inlining the contents of the .d files. Useful
174		when stale dependencies are present, to list the exact
175		files that need refreshing. It is off by default because
176		it is possibly slower.
177		Default "no"
178
179MKDOC		If "no", don't build or install the documentation.
180		Default: yes
181
182MKDTRACE	If "no", do not build and install the kernel modules,
183		utilities and libraries used to implement the dtrace(1)
184		facility.
185		Default: no
186
187MKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
188		don't install certain libraries in /lib, and don't
189		install the shared linker into /libexec.
190		Default: yes
191
192MKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
193		to cross-build programs and libraries externally added by
194		users, and automatically enables creation of those sets.
195		Default: no
196
197MKFIRMWARE      If not "no", install the /libdata/firmware directory,
198		which is necessary for several drivers: athn(4), bwfm(4),
199		ipw(4), iwi(4), iwm(4), iwn(4), otus(4), rtwn(4), urtwn(4),
200		wpi(4), ral(4), rum(4), run(4), zyd(4), bcm43xx(4), and
201		the Tegra 124 SoC.
202		Default: yes on amd64, cobalt, evbarm evbmips, evbppc, hpcarm,
203		hppa, i386, mac68k, macppc, sandpoint, and sparc64, no elsewhere.
204
205MKGCC		If "no", don't build gcc(1) or any of the GCC-related
206		libraries (libgcc, libobjc, libstdc++).
207		Default: yes
208
209MKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
210		libraries (libgcc, libobjc, libstdc++).
211		Default: yes
212
213MKGDB		If "no", don't build gdb(1).
214		Default: yes
215
216MKGROFFHTMLDOC	If "no", avoid trying to use groff to generate html for
217		miscellaneous articles, as this seems to sometimes want
218		to run software not in base. Does not affect html man
219		pages.
220		Default: no
221
222MKHESIOD	If "no", disables building of Hesiod infrastructure
223		(libraries and support programs).
224		Default: yes
225
226MKHOSTOBJ	If not "no", for programs intended to be run on the compile
227		host, the name, release, and architecture of the host
228		operating system will be suffixed to the name of the object
229		directory created by "make obj".
230		Default: no
231
232MKHTML		If "no", don't build or install the HTML man pages.
233		Default: yes
234
235MKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
236		Has no effect on most platforms.
237		Default: yes
238
239MKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
240		Default: no
241
242MKINET6		If "no", disables building of INET6 (IPv6) infrastructure
243		(libraries and support programs).  This option must not be
244		set to "no" if MKX11 is not "no".
245		Default: yes
246
247MKINFO		If "no", don't build or install Info documentation from
248		Texinfo source files.
249		Default: yes
250
251MKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
252		Default: yes
253
254MKISCSI		If "no", don't build or install iSCSI library or applications
255		(depends on libpthread.)
256		Default: yes
257
258MKKDEBUG	If "yes", force building of kernel symbol info and creation
259		of netbsd.gdb in all kernel builds, independently of the
260		settings for "makeoptions DEBUG" in the kernel config file.
261
262MKKERBEROS	If "no", disables building of Kerberos v5
263		infrastructure (libraries and support programs).
264		Default: yes
265
266MKKMOD		If "no", disables building of kernel modules.
267		Default: yes
268
269MKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
270		Note that setting this to "no" does not disable the build of
271		the NetBSD test suite itself; the build of the tests is
272		controlled by the MKATF knob.
273		Default: no (until the import is done and validated)
274
275MKLDAP		If "no", disables building of LDAP infrastructure
276		(libraries and support programs).
277		Default: yes
278
279MKLIBCSANITIZER	If "yes", use the selected sanitizer inside libc to compile
280		userland programs and libraries as defined in
281		USE_LIBCSANITIZER, which defaults to "undefined".
282
283		The undefined behavior detector is currently the only supported
284		sanitizer in this mode. Its runtime differs from the UBSan
285		available in MKSANITIZER, and it is reimplemented from scratch
286		as micro-UBSan in the user mode (uUBSan). Its code is shared
287		with the kernel mode variation (kUBSan). The runtime is
288		stripped down from C++ features, in particular -fsanitize=vptr
289		is not supported and explicitly disabled. The only runtime
290		configuration is restricted to the LIBC_UBSAN environment
291		variable, that is designed to be safe for hardening.
292
293		The USE_LIBCSANITIZER value is passed to the -fsanitize=
294		argument to the compiler in CFLAGS and CXXFLAGS, but not in
295		LDFLAGS, as the runtime part is located inside libc.
296
297		Additional sanitizer arguments can be passed through
298		LIBCSANITIZERFLAGS.
299		Default: no
300
301MKLIBCXX	If not "no", build and install libc++.
302		Default: no
303
304MKLIBSTDCXX	If not "no", build and install libstdc++.
305		Default: yes
306
307MKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
308		Also:
309			- don't install the .a libraries
310			- don't install _pic.a libraries on PIC systems
311			- don't build .a libraries on PIC systems
312			- don't install the .so symlink on ELF systems
313		I.e, only install the shared library (and the .so.major
314		symlink on ELF).
315		Default: yes
316
317MKLINT		If "no", don't build or install the lint libraries.
318		Default: yes
319
320MKLVM		If "no", don't build or install the logical volume manager
321		and device mapper tools and libraries
322		Default: yes
323
324MKMAN		If "no", don't build or install the man or catman pages,
325		and also acts as "MKCATPAGES=no MKHTML=no".
326		Default: yes
327
328MKMANDOC	If "yes", mandoc is built as tool and used to compile
329		catman or html pages.  A directory can be exempted by
330		defining NOMANDOC.  Individual man pages are exempted
331		if NOMANDOC.${target} is set to "yes".
332		Default: yes
333
334MKMANZ		If not "no", compress manual pages at installation time.
335		Default: no
336
337MKMDNS		If "no", disables building of mDNS infrastructure
338		(libraries and support programs).
339		Default: yes
340
341MKNLS		If "no", don't build or install the NLS files and locale
342		definition files.
343		Default: yes
344
345MKNPF		If "no", don't build or install the NPF and its modules.
346		Default: yes
347
348MKNSD		If "no", don't build or install the "nsd" DNS authoritative
349		server.
350		Default: no
351
352MKOBJ		If "no", don't enable the rule which creates objdirs,
353		and also acts as "MKOBJDIRS=no".
354		Default: yes
355
356MKOBJDIRS	If "no", don't create objdirs during a "make build".
357		Default: no
358
359MKPAM		If "no", disables building of PAM authentication
360		infrastructure (libraries and support programs).
361		Default: yes
362
363MKPCC		If "no", don't build pcc(1) or any of the PCC-related
364		libraries (libpcc, libpccsoftfloat).
365		Default: no
366
367MKPF		If "no", don't build or install the pf programs and LKM.
368		Default: yes
369
370MKPIC		If "no", don't build or install shared libraries, and
371		also acts as "MKPICLIB=no"
372		Default: yes (for MACHINE_ARCHs that support it)
373
374MKPICINSTALL	If "no", don't install the *_pic.a libraries.
375		Default: yes
376
377MKPICLIB	If "no", don't build *_pic.a libraries, and build the
378		shared object libraries from the .a libraries.
379		A symlink is installed in ${DESTDIR}/usr/lib for the
380		_pic.a library pointing to the .a library.
381		Default: yes
382
383MKPIE		If "no", create regular executables. Otherwise create
384		PIE (Position Independent Executables).
385		Default: no
386
387NOPIE		Don't create PIE (Position Independent Executables)
388		It is set internally for standalone programs.
389
390MKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
391		Default: no
392
393MKPOSTFIX	If "no", don't build or install postfix(1).
394		Default: yes
395
396MKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
397		Default: yes
398
399MKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory,
400		which is necessary for the radeon DRM driver.
401		Default: yes on i386 and amd64, no elsewhere.
402
403MKRELRO		If "partial", set the non-PLT GOT to read-only. If "full"
404		also force immediate symbol binding.
405		Default: no
406	
407MKREPRO         If "yes", create reproducible builds. This enables
408		different switches to make two builds from the same source tree
409		result in the same build results.
410		Default: no
411
412MKSANITIZER	if "yes", use the selected sanitizer to compile userland
413		programs as defined in USE_SANITIZER, which defaults to
414		"address". A selection of available sanitizers:
415			address:	A memory error detector (default)
416			thread:		A data race detector
417			memory:		An uninitialized memory read detector
418			undefined:	An undefined behavior detector
419			leak:		A memory leak detector
420			dataflow:	A general data flow analysis
421			cfi:		A control flow detector
422			safe-stack:	Protect against stack-based corruption
423			scudo:		The Scudo Hardened allocator
424		It's possible to specify multiple sanitizers within the
425		USE_SANITIZER option (comma separated). The USE_SANITIZER value
426		is passed to the -fsanitize= argument to the compiler.
427		Additional arguments can be passed through SANITIZERFLAGS.
428		The list of supported features and their valid combinations
429		depends on the compiler version and target CPU architecture.
430		Default: no
431
432MKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
433		MKMAN=no MKNLS=no".
434		I.e, don't build catman pages, documentation, Info
435		documentation, man pages, NLS files, ...
436		Default: yes
437
438MKSKEY		If "no", disables building of S/key authentication
439		infrastructure (libraries and support programs).
440		Default: yes
441
442MKSLJIT		If "no", disables building of sljit (stack-less platform
443		independent JIT compiler) private library and tests.
444		Default: yes on amd64, i386 and sparc, no elsewhere.
445
446MKSOFTFLOAT	If not "no", build with options to enable the compiler to
447		generate output containing library calls for floating
448		point and possibly soft-float library support.
449		Default: no
450
451MKSTATICLIB	If "no", don't build or install the normal static (*.a)
452		libraries.
453		Default: yes
454
455MKSTATICPIE	Compile in support for static pie binaries. These binaries
456		use a special support in crt0.o for resolving relative
457		relocations and require linker support.
458		Default: yes on platforms that support it.
459
460MKSTRIPSYM	If "yes", strip all local symbols from shared libraries;
461		the affect is equivalent to -x option of ld(1). If "no",
462		strip only temporary local symbols; the affect is equivalent
463		to -X option of ld(1). Keeping non-temporary local symbols
464		such as static function names is useful on using DTrace for
465		userland libraries and getting a backtrace from a rump kernel
466		loading shared libraries.
467		Default: yes
468
469MKTEGRAFIRMWARE	If "no", install the /libdata/firmware/nvidia directory,
470		which is necessary for the NVIDIA Tegra XHCI driver.
471		Default: yes on evbarm, no elsewhere.
472
473MKTOOLSDEBUG	If "yes" build the tools with debugging symbols.
474		Default: no
475
476MKTPM		If "no" then don't build the Trusted Platform Module
477		infrastructure.
478		Default: no
479
480MKUNBOUND	If not "no", build and install the "unbound" DNS resolver.
481		Default: yes
482
483MKUNPRIVED	If not "no", don't set the owner/group/mode when installing
484		files or directories, and keep a metadata log of what
485		the owner/group/mode should be.  This allows a
486		non-root "make install".
487		Default: no
488
489MKUPDATE 	If not "no", 'make install' only installs targets that are
490		more recently modified in the source directories that their
491		installed counterparts.
492		Default: no
493
494MKX11		If not "no", 'make build' also descends into 
495		src/external/mit/xorg to cross-build X11 and automatically
496		enables creation of X sets.
497		Default: no
498
499MKX11FONTS	If not "no", do not build or install the X fonts.  The xfont
500		set is still created but will be empty.
501		Default: yes
502
503MKX11MOTIF:	If "yes", build the native X11 libGLw with Motif stubs.  If
504		Motif is not installed in the default location /usr/pkg, the
505		location can be specified using the X11MOTIFPATH variable.
506		Default: no
507
508MKYP		If "no", disables building of YP (NIS)
509		infrastructure (libraries and support programs).
510		Default: yes
511
512MKZFS		If "no", do not build and install utilities and libraries
513		used to manage ZFS file system. Do not build zfs and solaris
514		compatibility kernel modules.  Note: ZFS requires 64bit
515		atomic operations.
516		Default: yes on amd64, no elsewhere.
517
518MKRUMP		If "no", do not build and install rump related headers,
519		libraries, and programs.
520		Default: yes
521
522USE_HESIOD	If "no", disables building Hesiod support into
523		various system utilities/libraries that support it.
524		If ${MKHESIOD} is "no", USE_HESIOD will also be
525		forced to "no".
526
527USE_INET6	If "no", disables building INET6 (IPv6) support into
528		various system utilities/libraries that support it.
529		If ${MKINET6} is "no", USE_INET6 will also be
530		forced to "no".
531
532USE_JEMALLOC	If "no", disables building the "jemalloc" allocator
533		designed for improved performance with threaded
534		applications.  The "phkmalloc" allocator as used up
535		before NetBSD-5.0 will be substituted.
536
537USE_KERBEROS	If "no", disables building Kerberos v5
538		support into various system utilities/libraries that
539		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
540		will also be forced to "no".
541
542USE_LDAP	If "no", disables building LDAP support into various
543		system utilities/libraries that support it.
544		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
545
546USE_PAM		If "no", disables building PAM authentication support
547		into various system utilities/libraries that support it.
548		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
549
550USE_SKEY	If "no", disables building S/key authentication
551		support into various system utilities/libraries that
552		support it.  If ${MKSKEY} is "no", USE_SKEY will
553		also be forced to "no".
554		Default: no
555
556USE_SSP		If "no", disables GCC stack protection code, which
557		detects stack overflows and aborts the program. The
558		stack protection code imposes a performance penalty
559		of about 5%.
560		Default: "no", unless "USE_FORT" is set to "yes"
561
562NOSSP		Don't compile with stack protector during build.
563		It is set internally for standalone programs.
564
565USE_FORT 	If "yes" turns on substitute wrappers for commonly used
566		functions that do not do bounds checking regularly, but
567		they could in some cases by using the gcc
568		__builtin_object_size() function to determine the buffer
569		size where it is known and detect buffer overflows.
570		These substitute functions are in /usr/include/ssp.
571		Default: depends on the part of the source tree
572
573NOFORT		Don't compile with substitute wrappers during build.
574		It is set internally for standalone programs.
575
576USE_YP		If "no", disables building YP (NIS) support into
577		various system utilities/libraries that support it.
578		If ${MKYP} is "no", USE_YP will also be forced to "no".
579
580USE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
581		Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
582		and use nbpigz to compress things.
583		Default: "no".
584
585COPTS.lib<lib>
586OBJCOPTS.lib<lib>
587LDADD.lib<lib>
588CPPFLAGS.lib<lib>
589CXXFLAGS.lib<lib>
590COPTS.<prog>
591OBJCCOPTS.<prog>
592LDADD.<prog>
593CPPFLAGS.<prog>
594CXXFLAGS.<prog>	These provide a way to specify additions to the associated
595		variables in a way that applies only to a particular library
596		or program.  <lib> corresponds to the LIB variable set in
597		the library's makefile.  <prog> corresponds to either PROG
598		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
599		set to "-g", "-g" will be added to COPTS only when compiling
600		the crypto library.
601
602The active compiler is selected using the following variables:
603AVAILABLE_COMPILER
604		List of available compiler suites.  Processed in order
605		for selecting the active compiler for each frontend.
606HAVE_PCC	If defined, PCC is present and enabled.
607HAVE_LLVM	If defined, LLVM/Clang is present and enabled.
608UNSUPPORTED_COMPILER.xxx
609		If defined, the support for compiler "xxx" is disabled.
610
611For the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
612ACTIVE_CC	Active compile suite for the CC frontend.
613SUPPORTED_CC	Compile suite with support for the CC frontend.
614TOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
615
616=-=-=-=-=   sys.mk   =-=-=-=-=
617
618The include file <sys.mk> has the default rules for all makes, in the BSD
619environment or otherwise.  You probably don't want to touch this file.
620
621=-=-=-=-=   bsd.own.mk   =-=-=-=-=
622
623The include file <bsd.own.mk> contains source tree configuration parameters,
624such as the owners, groups, etc. for both manual pages and binaries, and
625a few global "feature configuration" parameters.
626
627It has no targets.
628
629To get system-specific configuration parameters, <bsd.own.mk> will try to
630include the file specified by the "MAKECONF" variable.  If MAKECONF is not
631set, or no such file exists, the system make configuration file, /etc/mk.conf
632is included.  These files may define any of the variables described below.
633
634<bsd.own.mk> sets the following variables, if they are not already defined
635(defaults are in brackets):
636
637NETBSDSRCDIR	Top of the NetBSD source tree.
638		If _SRC_TOP_ != "", that will be used as the default,
639		otherwise BSDSRCDIR will be used as the default.
640		Various makefiles within the NetBSD source tree will
641		use this to reference the top level of the source tree.
642
643_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
644		based on the presence of tools/ and build.sh.  This variable
645		is "internal" to <bsd.own.mk>, although its value is only
646		determined once and then propagated to all sub-makes.
647
648_NETBSD_VERSION_DEPENDS
649		A list of files which contain information about
650		the version of the NetBSD being built.  This is
651		defined only if the current directory appears
652		to be inside a NetBSD source tree.  The list of
653		files includes ${NETBSDSRCDIR}/sys/sys/param.h
654		(which contains the kernel version number),
655		${NETBSDSRCDIR}/sys/conf/newvers.sh and
656		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
657		interpret the information in sys/sys/param.h), and
658		${_SRC_TOP_OBJ_}/params (which is an optional file,
659		created by "make build" in ${_SRC_TOP_}/Makefile,
660		containing all the variables that may influence the
661		build).
662
663		Targets that depend on the NetBSD version, or on
664		variables defined at build time, can declare a
665		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
666
667			version.c: ${_NETBSD_VERSION_DEPENDS}
668				commands to create version.c
669
670BSDSRCDIR	The real path to the system sources, so that 'make obj'
671		will work correctly.  [/usr/src]
672
673BSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
674		will work correctly.  [/usr/obj]
675
676BINGRP		Binary group.  [wheel]
677
678BINOWN		Binary owner.  [root]
679
680BINMODE		Binary mode.  [555]
681
682NONBINMODE	Mode for non-executable files.  [444]
683
684MANDIR		Base path for manual installation.  [/usr/share/man/cat]
685
686MANGRP		Manual group.  [wheel]
687
688MANOWN		Manual owner.  [root]
689
690MANMODE		Manual mode.  [${NONBINMODE}]
691
692MANINSTALL	Manual installation type.  Space separated list:
693			catinstall, htmlinstall, maninstall
694		Default value derived from MKCATPAGES and MKHTML.
695
696LDSTATIC	Control program linking; if set blank, link everything
697		dynamically.  If set to "-static", link everything statically.
698		If not set, programs link according to their makefile.
699
700LIBDIR		Base path for library installation.  [/usr/lib]
701
702LINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
703
704LIBGRP		Library group.  [${BINGRP}]
705
706LIBOWN		Library owner.  [${BINOWN}]
707
708LIBMODE		Library mode.  [${NONBINMODE}]
709
710DOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
711	        installation.  [/usr/share/doc]
712
713DOCGRP		Documentation group.  [wheel]
714
715DOCOWN		Documentation owner.  [root]
716
717DOCMODE		Documentation mode.  [${NONBINMODE}]
718
719GZIP_N_FLAG	Flags to pass to TOOL_GZIP to prevent it from inserting
720		file names or timestamps in the compressed output.
721		[-n, or -nT when TOOL_GZIP is really TOOL_PIGZ]
722
723NLSDIR		Base path for Native Language Support files installation.
724		[/usr/share/nls]
725
726NLSGRP		Native Language Support files group.  [wheel]
727
728NLSOWN		Native Language Support files owner.  [root]
729
730NLSMODE		Native Language Support files mode.  [${NONBINMODE}]
731
732X11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
733		if that exists; otherwise /usr/xsrc]
734
735X11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
736
737X11SRCDIR.lib<package>
738X11SRCDIR.<package>
739		The path to the xorg src tree for the specificed package>.
740		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
741
742X11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R7]
743
744X11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
745
746X11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
747
748X11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
749
750X11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
751
752X11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
753
754X11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
755
756STRIPFLAG	The flag passed to the install program to cause the binary
757		to be stripped.  This is to be used when building your
758		own install script so that the entire system can be made
759		stripped/not-stripped using a single knob.  []
760
761COPY		The flag passed to the install program to cause the binary
762		to be copied rather than moved.  This is to be used when
763		building our own install script so that the entire system
764		can either be installed with copies, or with moves using
765		a single knob.  [-c]
766
767MAKEDIRTARGETENV
768		Environment variables passed to the child make process
769		invoked by MAKEDIRTARGET.
770
771MAKEDIRTARGET dir target [params]
772		Runs "cd $${dir} && ${MAKE} [params] $${target}",
773		displaying a "pretty" message whilst doing so.
774
775RELEASEMACHINEDIR
776		Subdirectory used below RELEASEDIR when building
777		a release.  [${MACHINE}]
778
779RELEASEMACHINE	Subdirectory or path component used for the following
780		paths:
781			distrib/${RELEASEMACHINE}
782			distrib/notes/${RELEASEMACHINE}
783			etc/etc.${RELEASEMACHINE}
784		Used when building a release.  [${MACHINE}]
785
786Additionally, the following variables may be set by <bsd.own.mk> or in a
787make configuration file to modify the behavior of the system build
788process (default values are in brackets along with comments, if set by
789<bsd.own.mk>):
790
791USETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
792		be used as part of a build in progress.
793		Supported values:
794
795		yes	Use the tools from TOOLDIR.
796			Must be set to this if cross-compiling.
797
798		no	Do not use the tools from TOOLDIR, but refuse to
799			build native compilation tool components that are
800			version-specific for that tool.
801
802		never	Do not use the tools from TOOLDIR, even when
803			building native tool components.  This is similar to
804			the traditional NetBSD build method, but does not
805			verify that the compilation tools in use are
806			up-to-date enough in order to build the tree
807			successfully.  This may cause build or runtime
808			problems when building the whole NetBSD source tree.
809
810		Default: "yes" if building all or part of a whole NetBSD
811		source tree (detected automatically); "no" otherwise
812		(to preserve traditional semantics of the <bsd.*.mk>
813		make(1) include files).
814
815OBJECT_FMT	Object file format.  [set to "ELF" on architectures that
816		use ELF -- currently all architectures].
817
818TOOLCHAIN_MISSING
819		If not "no", this indicates that the platform being built
820		does not have a working in-tree toolchain.  If the
821		${MACHINE_ARCH} in question falls into this category,
822		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
823		Otherwise, the variable is unconditionally assigned the
824		value "no".
825		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
826		unconditionally assigned the value "no".
827
828EXTERNAL_TOOLCHAIN
829		This variable is not directly set by <bsd.own.mk>, but
830		including <bsd.own.mk> is the canonical way to gain
831		access to this variable.  The variable should be defined
832		either in the user's environment or in the user's mk.conf
833		file.  If defined, this variable indicates the root of
834		an external toolchain which will be used to build the
835		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
836		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
837		cross-compile framework.
838
839		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
840		assigned the value "no", since the external version of the
841		compiler may not be able to build the library components of
842		the in-tree compiler.
843
844		This variable should be used in conjunction with an appropiate
845		HAVE_GCC or HAVE_LLVM setting to control the compiler flags.
846
847		NOTE: This variable is not yet used in as many places as
848		it should be.  Expect the exact semantics of this variable
849		to change in the short term as parts of the cross-compile
850		framework continue to be cleaned up.
851
852The following variables are defined to commands to perform the
853appropriate operation, with the default in [brackets].  Note that
854the defaults change if USETOOLS == "yes":
855
856TOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
857
858TOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
859
860TOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
861
862TOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
863
864TOOL_AWK		Pattern-directed scanning/processing language.  [awk]
865
866TOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
867
868TOOL_CAT		Concatenate and print files.  [cat]
869
870TOOL_CKSUM		Display file checksums.  [cksum]
871
872TOOL_COMPILE_ET		Error table compiler.  [compile_et]
873
874TOOL_CONFIG		Build kernel compilation directories.  [config]
875
876TOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
877
878TOOL_CTAGS		Create a tags file.  [ctags]
879
880TOOL_DB			Manipulate db(3) databases.  [db]
881
882TOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
883
884TOOL_EQN		Format equations for groff.  [eqn]
885
886TOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
887
888TOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
889
890TOOL_GENASSYM		Generate constants for assembly files.  [genassym]
891
892TOOL_GENCAT		Generate NLS message catalogs.  [gencat]
893
894TOOL_GMAKE		GNU make utility.  [gmake]
895
896TOOL_GREP		Print lines matching a pattern.  [grep]
897
898TOOL_GROFF		Front end for groff document formatting system.  [groff]
899
900TOOL_GZIP		Compression/decompression tool.  [gzip]
901
902TOOL_GZIP_N		Same as TOOL_GZIP, plus a command line option to
903			prevent it from inserting file names or timestamps
904			into the compressed output.
905			[${TOOL_GZIP} ${GZIP_N_FLAG}]
906
907TOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
908
909TOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
910
911TOOL_HPPAMKBOOT		Make bootable image for hppa.  [hppa-mkboot]
912
913TOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
914
915TOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
916
917TOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
918
919TOOL_JOIN		Relational database operator.  [join]
920
921TOOL_M4			M4 macro language processor.  [m4]
922
923TOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
924
925TOOL_MAKEFS		Create file system image from directory tree.  [makefs]
926
927TOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
928
929TOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
930
931TOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
932
933TOOL_MENUC		Menu compiler.  [menuc]
934
935TOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
936			[mips-elf2ecoff]
937
938TOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
939
940TOOL_MKESDB		Make encoding scheme database.  [mkesdb]
941
942TOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
943
944TOOL_MKMAGIC		Create database for file(1).  [file]
945
946TOOL_MKNOD		Make device special file.  [mknod]
947
948TOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
949
950TOOL_MSGC		Simple message list compiler.  [msgc]
951
952TOOL_MTREE		Map a directory hierarchy.  [mtree]
953
954TOOL_NCDCS		Turn ELF kernel into a NCD firmware image. [ncdcs]
955
956TOOL_PAX		Manipulate file archives and copy directories.  [pax]
957
958TOOL_PIC		Compile pictures for groff.  [pic]
959
960TOOL_PIGZ		Parallel compressor.  [pigz]
961
962TOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
963
964TOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
965
966TOOL_REFER		Preprocess bibliographic references for groff.  [refer]
967
968TOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
969
970TOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
971
972TOOL_ROFF_HTML		Generate HTML groff output.
973			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
974
975TOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
976
977TOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
978
979TOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
980
981TOOL_SED		Stream editor.  [sed]
982
983TOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
984
985TOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
986			[sparkcrc]
987
988TOOL_STAT		Display file status.  [stat]
989
990TOOL_STRFILE		Create a random access file for storing strings.
991			[strfile]
992
993TOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
994
995TOOL_TBL		Format tables for groff.  [tbl]
996
997TOOL_UUDECODE		Uudecode a binary file.  [uudecode]
998
999TOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
1000
1001TOOL_ZIC		Time zone compiler.  [zic]
1002
1003For each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
1004list of what ports can be built for it.  This keeps those definitions in
1005centralized place.
1006
1007<bsd.own.mk> is generally useful when building your own Makefiles so that
1008they use the same default owners etc. as the rest of the tree.
1009
1010
1011=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
1012
1013The include file <bsd.clean.mk> defines the clean and cleandir
1014targets.  It uses the following variables:
1015
1016CLEANFILES	Files to remove for both the clean and cleandir targets.
1017
1018CLEANDIRFILES	Files to remove for the cleandir target, but not for
1019		the clean target.
1020
1021MKCLEANSRC	Controls whether or not the clean and cleandir targets
1022		will delete files from both the object directory,
1023		${.OBJDIR}, and the source directory, ${.CURDIR}.
1024
1025		If MKCLEANSRC is set to "no", then the file names in
1026		CLEANFILES or CLEANDIRFILES are interpreted relative
1027		to the object directory, ${.OBJDIR}.  This is the
1028		traditional behaviour.
1029
1030		If MKCLEANSRC is set to "yes", then the file deletion
1031		is performed relative to both the object directory,
1032		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
1033		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
1034		Deleting files from ${.CURDIR} is intended to remove
1035		stray output files that had been left in the source
1036		directory by an earlier build that did not use object
1037		directories.
1038
1039		The default is MKCLEANSRC=yes.  If you always build with
1040		separate object directories, and you are sure that there
1041		are no stray files in the source directories, then you
1042		may set MKCLEANSRC=no to save some time.
1043
1044MKCLEANVERIFY	Controls whether or not the clean and cleandir targets
1045		will verify that files have been deleted.
1046
1047		If MKCLEANVERIFY is set to "no", then the files will
1048		be deleted using a "rm -f" command, and its success or
1049		failure will be ignored.
1050
1051		If MKCLEANVERIFY is set to "yes", then the success of
1052		the "rm -f" command will be verified using an "ls"
1053		command.
1054
1055		The default is MKCLEANVERIFY=yes.  If you are sure that
1056		there will be no problems caused by file permissions,
1057		read-only file systems, or the like, then you may set
1058		MKCLEANVERIFY=no to save some time.
1059
1060To use the clean and cleandir targets defined in <bsd.clean.mk>, other
1061Makefiles or bsd.*.mk files should append file names to the CLEANFILES
1062or CLEANDIRFILES variables.  For example:
1063
1064	    CLEANFILES+= a.out
1065	    CLEANDIRFILES+= .depend
1066
1067	    .include <bsd.clean.mk>
1068
1069The files listed in CLEANFILES and CLEANDIRFILES must not be
1070directories, because the potential risk from running "rm -rf" commands
1071in bsd.clean.mk is considered too great.  If you want to recursively
1072delete a directory as part of "make clean" or "make cleandir" then you
1073need to provide your own target.
1074
1075=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
1076
1077The include file <bsd.dep.mk> contains the default targets for building
1078.depend files.  It creates .d files from entries in SRCS and DPSRCS
1079that are C, C++, or Objective C source files, and builds .depend from the
1080.d files.  All other files in SRCS and all of DPSRCS will be used as
1081dependencies for the .d files.  In order for this to function correctly,
1082it should be .included after all other .mk files and directives that may
1083modify SRCS or DPSRCS.  It uses the following variables:
1084
1085SRCS		List of source files to build the program.
1086
1087DPSRCS		List of source files which are needed for generating
1088		dependencies, but are not needed in ${SRCS}.
1089
1090
1091=-=-=-=-=   bsd.files.mk   =-=-=-=-=
1092
1093The include file <bsd.files.mk> handles the FILES variables and is included
1094from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
1095
1096FILES		The list of files to install.
1097
1098CONFIGFILES	Similar semantics to FILES, except that the files
1099		are installed by the `configinstall' target,
1100		not the `install' target.
1101		The FILES* variables documented below also apply.
1102
1103FILESOWN	File owner.  [${BINOWN}]
1104
1105FILESGRP	File group.  [${BINGRP}]
1106
1107FILESMODE	File mode.  [${NONBINMODE}]
1108
1109FILESDIR	The location to install the files.
1110
1111FILESNAME	Optional name to install each file as.
1112
1113FILESOWN_<fn>	File owner of the specific file <fn>.
1114
1115FILESGRP_<fn>	File group of the specific file <fn>.
1116
1117FILESMODE_<fn>	File mode of the specific file <fn>.
1118
1119FILESDIR_<fn>	The location to install the specific file <fn>.
1120
1121FILESNAME_<fn>	Optional name to install <fn> as.
1122
1123FILESBUILD	If this variable is defined, then its value will be
1124		used as the default for all FILESBUILD_<fn> variables.
1125		Otherwise, the default will be "no".
1126
1127FILESBUILD_<fn>	A value different from "no" will add the file to the list of
1128		targets to be built by `realall'.  Users of that variable
1129		should provide a target to build the file.
1130
1131
1132BUILDSYMLINKS	List of two word items:
1133			lnsrc lntgt
1134		For each lnsrc item, create a symlink named lntgt.
1135		The lntgt symlinks are removed by the cleandir target.
1136
1137UUDECODE_FILES	List of files which are stored as <file>.uue in the source
1138		tree. Each one will be decoded with ${TOOL_UUDECODE}.
1139		The source files have a `.uue' suffix, the generated files do
1140		not.
1141
1142UUDECODE_FILES_RENAME_<fn>
1143		Rename the output from the decode to the provided name.
1144		
1145		*NOTE: These files are simply decoded, with no install or other
1146		       rule applying implicitly except being added to the clean
1147		       target.
1148
1149=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
1150
1151The include file <bsd.gcc.mk> computes various parameters related to GCC
1152support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
1153before <bsd.gcc.mk>.
1154
1155The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
1156of which need to know where to find certain GCC support libraries.
1157
1158The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
1159which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
1160the compiler is asked where to find the support libraries, otherwise the
1161support libraries are found in ${DESTDIR}/usr/lib.
1162
1163<bsd.gcc.mk> sets the following variables:
1164
1165_GCC_CRTBEGIN	The full path name to crtbegin.o.
1166
1167_GCC_CRTBEGINS	The full path name to crtbeginS.o.
1168
1169_GCC_CRTEND	The full path name to crtend.o.
1170
1171_GCC_CRTENDS	The full path name to crtendS.o.
1172
1173_GCC_LIBGCCDIR	The directory where libgcc.a is located.
1174
1175
1176=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
1177
1178The include file <bsd.inc.mk> defines the includes target and uses the
1179variables:
1180
1181INCS		The list of include files.
1182
1183INCSDIR		The location to install the include files.
1184
1185INCSNAME	Target name of the include file, if only one; same as
1186		FILESNAME, but for include files.
1187
1188INCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
1189		are installed in the 'includes' target and not the
1190		(much later) 'install' target.
1191
1192INCSNAME_<file>	The name file <file> should be installed as, if not <file>,
1193		same as FILESNAME_<file>, but for include files.
1194
1195
1196=-=-=-=-=   bsd.info.mk   =-=-=-=-=
1197
1198The include file <bsd.info.mk> is used to generate and install GNU Info
1199documentation from respective Texinfo source files.  It defines three
1200implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
1201following variables:
1202
1203TEXINFO		List of Texinfo source files.  Info documentation will
1204		consist of single files with the extension replaced by
1205		.info.
1206
1207INFOFLAGS	Flags to pass to makeinfo.  []
1208
1209
1210=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
1211
1212The include file <bsd.kernobj.mk> defines variables related to the
1213location of kernel sources and object directories.
1214
1215KERNSRCDIR	Is the location of the top of the kernel src.
1216		[${_SRC_TOP_}/sys]
1217
1218KERNARCHDIR	Is the location of the machine dependent kernel sources.
1219		[arch/${MACHINE}]
1220
1221KERNCONFDIR	Is where the configuration files for kernels are found.
1222		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
1223
1224KERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
1225		instance will be compiled in ${KERNOBJDIR}/GENERIC.
1226		The default value is
1227		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
1228		if it exists or the target 'obj' is being made.
1229		Otherwise the default is
1230		${KERNSRCDIR}/${KERNARCHDIR}/compile.
1231
1232It is important that Makefiles (such as those under src/distrib) that
1233wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
1234rather than make assumptions about the location of the compiled kernel.
1235
1236
1237=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
1238
1239The include file <bsd.kinc.mk> defines the many targets (includes,
1240subdirectories, etc.), and is used by kernel makefiles to handle
1241include file installation.  It is intended to be included alone, by
1242kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
1243Please see <bsd.kinc.mk> for more details, and keep the documentation
1244in that file up to date.
1245
1246=-=-=-=-=   bsd.syscall.mk =-=-=-=-=
1247
1248The include file <bsd.syscall.mk> contains the logic to create syscall
1249files for various emulations. It includes <bsd.kinc.mk> to handle the
1250rest of the targets.
1251
1252=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
1253
1254The include file <bsd.lib.mk> has support for building libraries.  It has
1255the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
1256includes, install, lint, and tags.  Additionally, it has a checkver target
1257which checks for installed shared object libraries whose version is greater
1258that the version of the source. It has a limited number of suffixes,
1259consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
1260<bsd.shlib.mk> to get shared library parameters.
1261
1262It sets/uses the following variables:
1263
1264LIB		The name of the library to build.
1265
1266LIBDIR		Target directory for libraries.
1267
1268MKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
1269		permissions in files inside its archives to those of
1270		the file it was fed. This leads to non-reproducible
1271		builds. If MKARZERO is set to "yes" (default is the
1272		same as MKREPRO, or "no" if MKREPRO is not defined),
1273		then the "D" flag is passed to ar, causing the
1274		timestamp, uid and gid to be zeroed and the file
1275		permissions to be set to 644. This allows .a files
1276		from different builds to be bit identical.
1277
1278SHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
1279		is not "no".
1280
1281SHLIB_MAJOR
1282SHLIB_MINOR
1283SHLIB_TEENY	Major, minor, and teeny version numbers of shared library
1284
1285USE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
1286		as the path to install shared libraries to.
1287		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
1288		Default: no
1289
1290LIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
1291		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
1292		MKPROFILE=no MKSTATICLIB=no".
1293		Default: no
1294
1295LIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
1296		MKPROFILE=no", and don't install the (.a) library.
1297		This is useful for "build only" helper libraries.
1298		Default: no
1299
1300LIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
1301		shared libraries.
1302		This is useful for C++ libraries.
1303		Default: no
1304
1305LINTLIBDIR	Target directory for lint libraries.
1306
1307LIBGRP		Library group.
1308
1309LIBOWN		Library owner.
1310
1311LIBMODE		Library mode.
1312
1313LDADD		Additional loader objects.
1314
1315MAN		The manual pages to be installed (use a .1 - .9 suffix).
1316
1317NOCHECKVER_<library>
1318NOCHECKVER	If set, disables checking for installed shared object
1319		libraries with versions greater than the source.  A
1320		particular library name, without the "lib" prefix, may
1321		be appended to the variable name to disable the check for
1322		only that library.
1323
1324SRCS		List of source files to build the library.  Suffix types
1325		.s, .c, and .f are supported.  Note, .s files are preferred
1326		to .c files of the same name.  (This is not the default for
1327		versions of make.)
1328
1329LIBDPLIBS	A list of the tuples:
1330			libname  path-to-srcdir-of-libname
1331
1332		For each tuple;
1333		     *	LIBDO.libname contains the .OBJDIR of the library
1334			`libname', and if it is not set it is determined
1335			from the srcdir and added to MAKEOVERRIDES (the
1336			latter is to allow for build time optimization).
1337		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
1338		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
1339				    ${LIBDO.libname}/liblibname.a   added.
1340
1341		The special value "_external" for LIBDO.lib makes the
1342		build system to assume the library comes from outside
1343		of the NetBSD source tree and only causes -llibname
1344		to be added to LDADD.
1345
1346		This variable may be used for individual libraries, as
1347		well as in parent directories to cache common libraries
1348		as a build-time optimization.
1349
1350The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
1351if it exists, as well as the include file <bsd.man.mk>.
1352
1353It has rules for building profiled objects; profiled libraries are
1354built by default.
1355
1356Libraries are ranlib'd when made.
1357
1358
1359=-=-=-=-=   bsd.links.mk   =-=-=-=-=
1360
1361The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
1362and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
1363
1364LINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
1365is used. The defaults may be modified by other bsd.*.mk files which
1366include bsd.links.mk.  In the future, these variables may be replaced
1367by a method for explicitly recording hard links in a metadata log.
1368
1369LINKS		The list of hard links, consisting of pairs of paths:
1370			source-file target-file
1371		${DESTDIR} is prepended to both paths before linking.
1372		For example, to link /bin/test and /bin/[, use:
1373			LINKS=/bin/test /bin/[
1374
1375CONFIGLINKS	Similar semantics to LINKS, except that the links
1376		are installed by the `configinstall' target,
1377		not the `install' target.
1378
1379SYMLINKS	The list of symbolic links, consisting of pairs of paths:
1380			source-file target-file
1381		${DESTDIR} is only prepended to target-file before linking.
1382		For example, to symlink /usr/bin/tar to /bin/tar resulting
1383		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
1384			SYMLINKS=/bin/tar /usr/bin/tar
1385
1386CONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
1387		are installed by the `configinstall' target,
1388		not the `install' target.
1389
1390LINKSOWN	Link owner.  [${BINOWN}]
1391
1392LINKSGRP	Link group.  [${BINGRP}]
1393
1394LINKSMODE	Link mode.  [${NONBINMODE}]
1395
1396LINKSOWN_<fn>	Link owner of the specific file <fn>.
1397
1398LINKSGRP_<fn>	Link group of the specific file <fn>.
1399
1400LINKSMODE_<fn>	Link mode of the specific file <fn>.
1401
1402
1403=-=-=-=-=   bsd.man.mk   =-=-=-=-=
1404
1405The include file <bsd.man.mk> handles installing manual pages and their
1406links.
1407
1408It has a three targets:
1409
1410	catinstall:
1411		Install the preformatted manual pages and their links.
1412	htmlinstall:
1413		Install the HTML manual pages and their links.
1414	maninstall:
1415		Install the manual page sources and their links.
1416
1417It sets/uses the following variables:
1418
1419MANDIR		Base path for manual installation.
1420
1421MANGRP		Manual group.
1422
1423MANOWN		Manual owner.
1424
1425MANMODE		Manual mode.
1426
1427MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
1428		or "/tahoe" for machine specific manual pages.
1429
1430MAN		The manual pages to be installed (use a .1 - .9 suffix).
1431
1432MLINKS		List of manual page links (using a .1 - .9 suffix).  The
1433		linked-to file must come first, the linked file second,
1434		and there may be multiple pairs.
1435
1436The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
1437it exists.
1438
1439
1440=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
1441
1442The include file <bsd.obj.mk> defines targets related to the creation
1443and use of separated object and source directories.
1444
1445If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
1446${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
1447it exists.  Otherwise make(1) looks for the existence of a
1448subdirectory (or a symlink to a directory) of the source directory
1449into which built targets should be placed.  If an environment variable
1450named MAKEOBJDIR is set, make(1) uses its value as the name of the
1451object directory; failing that, make first looks for a subdirectory
1452named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
1453
1454Object directories are not created automatically by make(1) if they
1455don't exist; you need to run a separate "make obj".  (This will happen
1456during a top-level build if "MKOBJDIRS" is set to a value other than
1457"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
1458and this is determined by a simple string prefix comparison -- object
1459directories are created in a separate object directory tree, and a
1460symlink to the object directory in that tree is created in the source
1461directory; otherwise, "make obj" assumes that you're not in the main
1462source tree and that it's not safe to use a separate object tree.
1463
1464Several variables used by <bsd.obj.mk> control exactly what
1465directories and links get created during a "make obj":
1466
1467MAKEOBJDIR	If set, this is the component name of the object
1468		directory.
1469
1470OBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
1471		object directories or links named "obj.${MACHINE}";
1472		otherwise, just creates ones named "obj".
1473
1474USR_OBJMACHINE  If set, and the current directory is a subdirectory of
1475		${BSDSRCDIR}, create object directory in the
1476		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
1477		otherwise, create it in the corresponding subdirectory
1478		of ${BSDOBJDIR}
1479
1480BUILDID		If set, the contents of this variable are appended
1481		to the object directory name.  If OBJMACHINE is also
1482		set, ".${BUILDID}" is added after ".${MACHINE}".
1483
1484
1485=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
1486
1487The include file <bsd.prog.mk> handles building programs from one or
1488more source files, along with their manual pages.  It has a limited number
1489of suffixes, consistent with the current needs of the BSD tree.
1490<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
1491
1492It has eight targets:
1493
1494	all:
1495		build the program and its manual page.  This also
1496		creates a GDB initialization file (.gdbinit) in
1497		the objdir.  The .gdbinit file sets the shared library
1498		prefix to ${DESTDIR} to facilitate cross-debugging.
1499	clean:
1500		remove the program, any object files and the files a.out,
1501		Errs, errs, mklog, and ${PROG}.core.
1502	cleandir:
1503		remove all of the files removed by the target clean, as
1504		well as .depend, tags, and any manual pages.
1505		`distclean' is a synonym for `cleandir'.
1506	depend:
1507		make the dependencies for the source files, and store
1508		them in the file .depend.
1509	includes:
1510		install any header files.
1511	install:
1512		install the program and its manual pages; if the Makefile
1513		does not itself define the target install, the targets
1514		beforeinstall and afterinstall may also be used to cause
1515		actions immediately before and after the install target
1516		is executed.
1517	lint:
1518		run lint on the source files
1519	tags:
1520		create a tags file for the source files.
1521
1522It sets/uses the following variables:
1523
1524BINGRP		Binary group.
1525
1526BINOWN		Binary owner.
1527
1528BINMODE		Binary mode.
1529
1530CLEANDIRFILES	Additional files to remove for the cleandir target.
1531
1532CLEANFILES	Additional files to remove for the clean and cleandir targets.
1533
1534CONFIGOPTS	Additional flags to config(1) when building kernels.
1535
1536COPTS		Additional flags to the compiler when creating C objects.
1537
1538COPTS.<fn>	Additional flags to the compiler when creating the
1539		C objects for <fn>.
1540		For <fn>.[ly], "<fn>.c" must be used.
1541
1542CPUFLAGS	Additional flags to the compiler/assembler to select
1543		CPU instruction set options, CPU tuning options, etc.
1544
1545CPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
1546		For <fn>.[ly], "<fn>.c" must be used.
1547
1548CPPFLAGS	Additional flags to the C pre-processor.
1549
1550CPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
1551		For <fn>.[ly], "<fn>.c" must be used.
1552
1553GDBINIT		List of GDB initialization files to add to "source"
1554		directives in the .gdbinit file that is created in the
1555		objdir.
1556
1557LDADD		Additional loader objects.  Usually used for libraries.
1558		For example, to load with the compatibility and utility
1559		libraries, use:
1560
1561			LDADD+=-lutil -lcompat
1562
1563LDFLAGS		Additional linker flags (passed to ${CC} during link).
1564
1565LINKS		See <bsd.links.mk>
1566
1567OBJCOPTS	Additional flags to the compiler when creating ObjC objects.
1568
1569OBJCOPTS.<fn>	Additional flags to the compiler when creating the
1570		ObjC objects for <fn>.
1571		For <fn>.[ly], "<fn>.c" must be used.
1572
1573SYMLINKS	See <bsd.links.mk>
1574
1575MAN		Manual pages (should end in .1 - .9).  If no MAN variable is
1576		defined, "MAN=${PROG}.1" is assumed.
1577
1578PAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
1579		time, with the value of this variable as args to paxctl(1).
1580
1581PAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
1582
1583PROG		The name of the program to build.  If not supplied, nothing
1584		is built.
1585
1586PROG_CXX	If defined, the name of the program to build.  Also
1587		causes <bsd.prog.mk> to link the program with the C++
1588		compiler rather than the C compiler.  PROG_CXX overrides
1589		the value of PROG if PROG is also set.
1590
1591PROGNAME	The name that the above program will be installed as, if
1592		different from ${PROG}.
1593
1594SRCS		List of source files to build the program.  If SRCS is not
1595		defined, it's assumed to be ${PROG}.c.
1596
1597DPSRCS		List of source files which are needed for generating
1598		dependencies, but are not needed in ${SRCS}.
1599
1600DPADD		Additional dependencies for the program.  Usually used for
1601		libraries.  For example, to depend on the compatibility and
1602		utility libraries use:
1603
1604			DPADD+=${LIBCOMPAT} ${LIBUTIL}
1605
1606		The following system libraries are predefined for DPADD:
1607
1608		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
1609		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
1610		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
1611		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
1612		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
1613		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
1614		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
1615		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
1616		LIBC?=		${DESTDIR}/usr/lib/libc.a
1617		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
1618		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
1619		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
1620		LIBCRTI?=	${DESTDIR}/usr/lib/crti.o
1621		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
1622		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
1623		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
1624		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
1625		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
1626		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
1627		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
1628		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
1629		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
1630		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
1631		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
1632		LIBEXECINFO?=	${DESTDIR}/usr/lib/libexecinfo.a
1633		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
1634		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
1635		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
1636		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
1637		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
1638		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
1639		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
1640		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
1641		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
1642		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
1643		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
1644		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
1645		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
1646		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
1647		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
1648		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
1649		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
1650		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
1651		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
1652		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
1653		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
1654		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
1655		LIBL?=		${DESTDIR}/usr/lib/libl.a
1656		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
1657		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
1658		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
1659		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
1660		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
1661		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
1662		LIBM?=		${DESTDIR}/usr/lib/libm.a
1663		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
1664		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
1665		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
1666		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
1667		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
1668		LIBPANEL?=	${DESTDIR}/usr/lib/libpanel.a
1669		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
1670		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
1671		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
1672		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
1673		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
1674		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
1675		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
1676		LIBREFUSE?=	${DESTDIR}/usr/lib/librefuse.a
1677		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
1678		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
1679		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
1680		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
1681		LIBRT?=		${DESTDIR}/usr/lib/librt.a
1682		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
1683		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
1684		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
1685		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
1686		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
1687		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
1688		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
1689		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
1690		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
1691		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
1692		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
1693		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
1694		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
1695		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
1696		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
1697		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
1698		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
1699		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
1700		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
1701		LIBSS?=		${DESTDIR}/usr/lib/libss.a
1702		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
1703		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
1704		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
1705		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
1706		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
1707		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
1708		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
1709		LIBUNBOUND?=	${DESTDIR}/usr/lib/libunbound.a
1710		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
1711		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
1712		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
1713		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
1714		LIBY?=		${DESTDIR}/usr/lib/liby.a
1715		LIBZ?=		${DESTDIR}/usr/lib/libz.a
1716
1717		The following X-Windows libraries are predefined for DPADD:
1718
1719		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
1720		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
1721		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
1722		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
1723		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
1724		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
1725		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
1726		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
1727		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
1728		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
1729		LIBXCB?=	${DESTDIR}/usr/X11R7/lib/libxcb.a
1730		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
1731		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
1732		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
1733		LIBXFONT2?=	${DESTDIR}/usr/X11R7/lib/libXfont2.a
1734		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
1735		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
1736		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
1737		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
1738		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
1739		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
1740		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
1741		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
1742		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
1743		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
1744		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
1745		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
1746		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
1747		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
1748		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
1749		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
1750		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
1751		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
1752		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
1753		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
1754		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
1755		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
1756
1757SHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
1758		strings, using xstr(1). Note that this will not work with
1759		parallel makes.
1760
1761STRIPFLAG	The flag passed to the install program to cause the binary
1762		to be stripped.
1763
1764SUBDIR		A list of subdirectories that should be built as well.
1765		Each of the targets will execute the same target in the
1766		subdirectories.
1767
1768SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
1769		These are installed exactly like programs.
1770
1771SCRIPTSDIR	The location to install the scripts.  Each script can be
1772		installed to a separate path by setting SCRIPTSDIR_<script>.
1773
1774SCRIPTSNAME	The name that the above program will be installed as, if
1775		different from ${SCRIPTS}. These can be further specialized
1776		by setting SCRIPTSNAME_<script>.
1777
1778FILES		See description of <bsd.files.mk>.
1779
1780SHLINKDIR	Target directory for shared linker.  See description of
1781		<bsd.own.mk> for additional information about this variable.
1782
1783The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
1784if it exists, as well as the include file <bsd.man.mk>.
1785
1786Some simple examples:
1787
1788To build foo from foo.c with a manual page foo.1, use:
1789
1790	PROG=	foo
1791
1792	.include <bsd.prog.mk>
1793
1794To build foo from foo.c with a manual page foo.2, add the line:
1795
1796	MAN=	foo.2
1797
1798If foo does not have a manual page at all, add the line:
1799
1800	MKMAN=	no
1801
1802If foo has multiple source files, add the line:
1803
1804	SRCS=	a.c b.c c.c d.c
1805
1806
1807=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
1808
1809The include file <bsd.rpc.mk> contains a makefile fragment used to
1810construct source files built by rpcgen.
1811
1812The following macros may be defined in makefiles which include
1813<bsd.rpc.mk> in order to control which files get built and how they
1814are to be built:
1815
1816RPC_INCS:	construct .h file from .x file
1817RPC_XDRFILES:	construct _xdr.c from .x file
1818		(for marshalling/unmarshalling data types)
1819RPC_SVCFILES:	construct _svc.c from .x file
1820		(server-side stubs)
1821RPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
1822
1823RPC_XDIR:	Directory containing .x/.h files
1824
1825
1826=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1827
1828The include file <bsd.shlib.mk> computes parameters for shared library
1829installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1830included before <bsd.shlib.mk>.
1831
1832<bsd.own.mk> sets the following variables, if they are not already defined
1833(defaults are in brackets):
1834
1835SHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
1836		instead of ${LIBDIR} as the base path for shared library
1837		installation.  [/lib]
1838
1839SHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
1840		a program.  [/lib for programs in /bin and /sbin, /usr/lib
1841		for all others.]
1842
1843_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1844		otherwise set to ${LIBDIR}
1845
1846SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1847
1848SHLINKDIR	Path to use for shared linker when building a program.
1849		[/libexec for programs in /bin and /sbin, /usr/libexec for
1850		all others.]
1851
1852
1853=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1854
1855The include file <bsd.subdir.mk> contains the default targets for building
1856subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1857clean, cleandir, depend, includes, install, lint, and tags.  It uses the
1858following variables:
1859
1860NOSUBDIR	If this variable is defined, then the SUBDIR variable
1861		will be ignored and subdirectories will not be processed.
1862
1863SUBDIR		For all of the directories listed in ${SUBDIR}, the
1864		specified directory will be visited and the target made.
1865
1866		As a special case, the use of a token .WAIT as an
1867		entry in SUBDIR acts as a synchronization barrier
1868		when multiple make jobs are run; subdirs before the
1869		.WAIT must complete before any subdirs after .WAIT are
1870		started.  See make(1) for some caveats on use of .WAIT
1871		and other special sources.
1872
1873
1874=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
1875
1876The include file <bsd.x11.mk> contains parameters and targets for
1877cross-building X11 from ${X11SRCDIR.<package>}.  It should be included
1878after the general Makefile contents but before the include files such as
1879<bsd.prog.mk> and <bsd.lib.mk>.
1880
1881It provides the following targets:
1882	.man.1 .man.3 .man.4 .man.5 .man.7:
1883		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1884		these rules convert from X11's manual page source
1885		into an mdoc.old source file.
1886
1887It sets the following variables:
1888
1889BINDIR			Set to ${X11BINDIR}.
1890			To override, define after including <bsd.x11.mk>
1891
1892LIBDIR			Set to ${X11USRLIBDIR}.
1893			To override, define after including <bsd.x11.mk>
1894
1895MANDIR			Set to ${X11MANDIR}.
1896			To override, define after including <bsd.x11.mk>
1897
1898CPPFLAGS		Appended with definitions to include from
1899			${DESTDIR}${X11INCDIR}
1900
1901LDFLAGS			Appended with definitions to link from
1902			${DESTDIR}${X11USRLIBDIR}
1903
1904X11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
1905
1906X11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
1907
1908X11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
1909
1910X11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
1911
1912X11FLAGS.SERVER		Equivalent to X11's ServerDefines.
1913
1914X11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
1915
1916X11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
1917
1918X11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
1919
1920X11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
1921
1922X11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
1923
1924It uses the following variables:
1925
1926APPDEFS			List of app-default files to install.
1927
1928CPPSCRIPTS		List of files/scripts to run through cpp(1)
1929			and then ${X11TOOL_UNXCOMM}.  The source files
1930			have a `.cpp' suffix, the generated files do not.
1931
1932CPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
1933
1934CPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
1935
1936
1937=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1938
1939The following files are described here for completion, but they are not
1940supposed to be included directly from other Makefiles; they are used
1941internally by other system files.
1942
1943=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1944
1945The include file <bsd.sys.mk> is used by other system mk files and
1946it is not intended to be included standalone. It contains rules and
1947system build variables. It requires bsd.own.mk to be included first.
1948It contains overrides that are used when building the NetBSD source tree.
1949
1950The following variables control how various files are compiled/built.
1951(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1952
1953AR		Create, modify, and extract from archives.  [ar]
1954
1955ARFLAGS		Options to ${AR}.  [rl]
1956
1957AS		Assembler.  [as]
1958
1959AFLAGS		Options to ${CC} when compiling or linking .s or .S
1960		assembly source files.  []
1961
1962BUILDSEED	GCC uses random numbers when compiling C++ code.
1963		If this option is present, seed the random number
1964		generator based on the value, source file names and
1965		the output file name to make builds more deterministic.
1966		Additional information is available in the GCC
1967		documentation of -frandom-seed.
1968
1969CC		C compiler.  [cc]
1970
1971CFLAGS		Options to ${CC}.  [Usually -O or -O2]
1972
1973CPP		C Pre-Processor.  [cpp]
1974
1975CPPFLAGS	Options to ${CPP}.  []
1976
1977CPUFLAGS	Optimization flags for ${CC}.  []
1978
1979CXX		C++ compiler.  [c++]
1980
1981CXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
1982
1983ELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
1984
1985FC		Fortran compiler.  [f77]
1986
1987FFLAGS		Options to {$FC}.  [-O]
1988
1989HOST_SH		Shell.	This must be an absolute path, because it may be
1990		substituted into "#!" lines in scripts.	 [/bin/sh]
1991
1992INSTALL		install(1) command.  [install]
1993
1994LEX		Lexical analyzer.  [lex]
1995
1996LFLAGS		Options to ${LEX}.  []
1997
1998LPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
1999
2000LD		Linker.  [ld]
2001
2002LDFLAGS		Options to ${CC} during the link process.  []
2003
2004LINT		C program verifier.  [lint]
2005
2006LINTFLAGS	Options to ${LINT}.  [-chapbxzgFS]
2007
2008LORDER		List dependencies for object files.  [lorder]
2009
2010MAKE		make(1).  [make]
2011
2012MKDEP		Construct Makefile dependency list.  [mkdep]
2013
2014MKDEPCXX	Construct Makefile dependency list for C++ files.  [mkdep]
2015
2016NM		List symbols from object files.  [nm]
2017
2018PC		Pascal compiler.  [pc]  (Not present)
2019
2020PFLAGS		Options to ${PC}.  []
2021
2022OBJC		Objective C compiler.  [${CC}]
2023
2024OBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
2025
2026OBJCOPY		Copy and translate object files.  [objcopy]
2027
2028OBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
2029		being built. [${.TARGET} =~ "*.po" ? -X : -x]
2030
2031OBJDUMP		Display information from object files.  [objdump]
2032
2033RANLIB		Generate index to archive.  [ranlib]
2034
2035READELF		Display information from ELF object files.  [readelf]
2036
2037SIZE		List section sizes and total size.  [size]
2038
2039STRINGS		Display printable character sequences in files.  [strings]
2040
2041STRIP		Discard symbols from object files.  [strip]
2042
2043TSORT		Topological sort of a directed graph.  [tsort -q]
2044
2045YACC		LALR(1) parser generator.  [yacc]
2046
2047YFLAGS		Options to ${YACC}.  []
2048
2049YHEADER		If defined, add "-d" to YFLAGS, and add dependencies
2050		from <file>.y to <file>.h and <file>.c, and add
2051		<foo>.h to CLEANFILES.
2052
2053YPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
2054
2055
2056Other variables of note (incomplete list):
2057
2058NOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
2059		that cause warnings to be fatal, such as:
2060			-Werror -Wa,--fatal-warnings
2061		(The latter being for as(1).)
2062
2063NOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
2064		passed to it.
2065
2066WARNS		Crank up compiler warning options; the distinct levels are:
2067			WARNS=1
2068			WARNS=2
2069			WARNS=3
2070			WARNS=4
2071			WARNS=5
2072			WARNS=6
2073
2074=-=-=-=-=   bsd.host.mk  =-=-=-=-=
2075
2076This file is automatically included from bsd.own.mk. It contains settings
2077for all the HOST_* variables that are used in host programs and libraries.
2078
2079HOST_AR			The host archive processing command
2080
2081HOST_CC			The host c compiler
2082
2083HOST_CFLAGS		The host c compiler flags
2084
2085HOST_COMPILE.c		The host c compiler line with flags
2086
2087HOST_COMPILE.cc		The host c++ compiler line with flags
2088
2089HOST_CPP		The host c pre-processor
2090
2091HOST_CPPFLAGS		The cost c pre-processor flags
2092
2093HOST_CXX		The host c++ compiler
2094
2095HOST_CXXFLAGS		The host c++ compiler flags
2096
2097HOST_INSTALL_DIR	The host command to install a directory
2098
2099HOST_INSTALL_FILE	The host command to install a file
2100
2101HOST_INSTALL_SYMLINK	The host command to install a symlink
2102
2103HOST_LD			The host linker command
2104
2105HOST_LDFLAGS		The host linker flags
2106
2107HOST_LINK.c		The host c linker line with flags
2108
2109HOST_LINK.cc		The host c++ linker line with flags
2110
2111HOST_LN			The host command to link two files
2112
2113HOST_MKDEP		The host command to create dependencies for c programs
2114
2115HOST_MKDEPCXX		The host command to create dependencies for c++ programs
2116
2117HOST_OSTYPE		The host OSNAME-RELEASE-ARCH tupple
2118
2119HOST_RANLIB		The host command to create random access archives
2120
2121HOST_SH			The host Bourne shell interpreter name (absolute path)
2122
2123=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2124