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