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