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