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