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