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