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