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