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