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