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