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