bsd.README revision 1.330
11.330Schristos#	$NetBSD: bsd.README,v 1.330 2014/04/18 00:37:46 christos Exp $
21.24Smikel#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
31.1Scgd
41.213SlukemThis is the README file for the make "include" files for the NetBSD
51.213Slukemsource tree.  The files are installed in /usr/share/mk, and are,
61.213Slukemby convention, named with the suffix ".mk".
71.1Scgd
81.1ScgdNote, this file is not intended to replace reading through the .mk
91.1Scgdfiles for anything tricky.
101.1Scgd
111.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
121.1Scgd
131.1ScgdRANDOM THINGS WORTH KNOWING:
141.1Scgd
151.1ScgdThe files are simply C-style #include files, and pretty much behave like
161.1Scgdyou'd expect.  The syntax is slightly different in that a single '.' is
171.1Scgdused instead of the hash mark, i.e. ".include <bsd.prog.mk>".
181.1Scgd
191.1ScgdOne difference that will save you lots of debugging time is that inclusion
201.1Scgdof the file is normally done at the *end* of the Makefile.  The reason for
211.1Scgdthis is because .mk files often modify variables and behavior based on the
221.1Scgdvalues of variables set in the Makefile.  To make this work, remember that
231.1Scgdthe FIRST target found is the target that is used, i.e. if the Makefile has:
241.1Scgd
251.1Scgd	a:
261.1Scgd		echo a
271.1Scgd	a:
281.1Scgd		echo a number two
291.1Scgd
301.1Scgdthe command "make a" will echo "a".  To make things confusing, the SECOND
311.1Scgdvariable assignment is the overriding one, i.e. if the Makefile has:
321.1Scgd
331.1Scgd	a=	foo
341.1Scgd	a=	bar
351.1Scgd
361.1Scgd	b:
371.1Scgd		echo ${a}
381.1Scgd
391.1Scgdthe command "make b" will echo "bar".  This is for compatibility with the
401.1Scgdway the V7 make behaved.
411.1Scgd
421.1ScgdIt's fairly difficult to make the BSD .mk files work when you're building
431.75Sagcmultiple programs in a single directory.  It's a lot easier to split up the
441.1Scgdprograms than to deal with the problem.  Most of the agony comes from making
451.36Srossthe "obj" directory stuff work right, not because we switched to a new version
461.1Scgdof make.  So, don't get mad at us, figure out a better way to handle multiple
471.1Scgdarchitectures so we can quit using the symbolic link stuff.  (Imake doesn't
481.1Scgdcount.)
491.1Scgd
501.1ScgdThe file .depend in the source directory is expected to contain dependencies
511.1Scgdfor the source files.  This file is read automatically by make after reading
521.1Scgdthe Makefile.
531.1Scgd
541.1ScgdThe variable DESTDIR works as before.  It's not set anywhere but will change
551.1Scgdthe tree where the file gets installed.
561.1Scgd
571.1ScgdThe profiled libraries are no longer built in a different directory than
581.1Scgdthe regular libraries.  A new suffix, ".po", is used to denote a profiled
591.265Snjolyobject, and ".pico" denotes a shared (position-independent) object.
601.97Sitojun
611.142SlukemThere are various make variables used during the build.
621.142Slukem
631.142SlukemMany variables support a (case sensitive) value of "no" or "yes",
641.142Slukemand are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
651.142Slukem
661.142Slukem
671.172ShubertfThe basic rule for the variable naming scheme is as follows:
681.172Shubertf
691.231SapbHOST_xxx	A command that runs on the host machine regardless of
701.231Sapb		whether or not the system is being cross compiled, or
711.231Sapb		flags for such a command.
721.231Sapb
731.172ShubertfMKxxx		Can be set to "no" to disable functionality, or
741.172Shubertf		"yes" to enable it.
751.172Shubertf		Usually defaults to "yes", although some variables
761.172Shubertf		default to "no".
771.172Shubertf		Due to make(1) implementation issues, if a temporary
781.224Slukem		command-line override of a mk.conf(5) or <bsd.own.mk>
791.214Swiz		setting is required whilst still honoring a particular
801.172Shubertf		Makefile's setting of MKxxx, use
811.172Shubertf			env MKxxx=value make
821.172Shubertf		instead of
831.172Shubertf			make MKxxx=value
841.172Shubertf
851.172ShubertfNOxxx		If defined, disables a feature.
861.172Shubertf		Not intended for users.
871.172Shubertf		This is to allow Makefiles to disable functionality
881.172Shubertf		that they don't support (such as missing man pages).
891.172Shubertf		NOxxx variables must be defined before <bsd.own.mk>
901.172Shubertf		is included.
911.172Shubertf
921.231SapbTOOL_xxx	A tool that is provided as part of the USETOOLS
931.231Sapb		framework.  When not using the USETOOLS framework,
941.231Sapb		TOOL_xxx variables should refer to tools that are
951.231Sapb		already installed on the host system.
961.231Sapb
971.172ShubertfThe following variables that control how things are made/installed that
981.172Shubertfare not set by default. These should not be set by Makefiles; they're for
991.224Slukemthe user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
1001.224Slukemor on the make(1) command line:
1011.172Shubertf
1021.172ShubertfBUILD 		If defined, 'make install' checks that the targets in the
1031.172Shubertf		source directories are up-to-date and remakes them if they
1041.172Shubertf                are out of date, instead of blindly trying to install
1051.172Shubertf                out of date or non-existent targets.
1061.172Shubertf
1071.172ShubertfMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
1081.172Shubertf		Default: 2
1091.172Shubertf		Supported values:
1101.172Shubertf		    0	Minimal output ("quiet")
1111.172Shubertf		    1	Describe what is occurring
1121.172Shubertf		    2	Describe what is occurring and echo the actual command
1131.241Sapb		    3	Ignore the effect of the "@" prefix in make commands
1141.241Sapb		    4	Trace shell commands using the shell's -x flag
1151.172Shubertf
1161.312SjmmvMKATF		If "no", don't build the Automated Testing Framework (ATF),
1171.312Sjmmv		which includes the libatf-c, libatf-c++ and libatf-sh libraries
1181.312Sjmmv		and the various command line tools.  Also, because the build of
1191.312Sjmmv		the libraries is disabled, don't build the NetBSD test suite
1201.312Sjmmv		either.
1211.210Sgmcgarry		Default: yes
1221.210Sgmcgarry
1231.252SskrllMKBFD		Obsolete, use MKBINUTILS
1241.252Sskrll
1251.266SjoergMKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
1261.266Sjoerg		libopcodes)
1271.172Shubertf		Default: yes
1281.172Shubertf
1291.266SjoergMKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
1301.266Sjoerg		the pax frontends.
1311.266Sjoerg		Default: no
1321.266Sjoerg
1331.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1341.292Sjoerg		Default: no
1351.172Shubertf
1361.234SmrgMKCOMPAT  	If "no", don't build or install the src/compat.
1371.303Sjkoshy		Default: yes on amd64/mips64/sparc64, no elsewhere.
1381.234Smrg
1391.210SgmcgarryMKCOMPLEX	If "no", don't build libm support for <complex.h>
1401.210Sgmcgarry		Default: yes
1411.210Sgmcgarry
1421.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1431.174Schristos		and also acts as "MKKERBEROS=no".
1441.172Shubertf		Default: yes
1451.172Shubertf
1461.297SspzMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5
1471.172Shubertf		Default: no
1481.172Shubertf
1491.329SozakiMKCTF		If "no", do not build and install CTF tools, and also
1501.329Sozaki		don't generate and manipulate CTF data of ELF binaries
1511.329Sozaki		during build.
1521.329Sozaki		Default: no
1531.329Sozaki
1541.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1551.172Shubertf		Default: yes
1561.172Shubertf
1571.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1581.184Slukem		into /usr/libdata/debug.
1591.184Slukem		Default: no
1601.184Slukem
1611.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1621.219Slukem		with -DDEBUG.
1631.176Schristos		Default: no
1641.176Schristos
1651.314SchristosMKDEPINCLUDES	If "yes" issue .include statements in the .depend file
1661.314Schristos		instead of inlining the contents of the .d files. Useful
1671.314Schristos		when stale dependencies are present, to list the exact
1681.314Schristos		files that need refreshing. It is off by default because
1691.314Schristos		it is possibly slower.
1701.314Schristos		Default "no"
1711.314Schristos
1721.172ShubertfMKDOC		If "no", don't build or install the documentation.
1731.172Shubertf		Default: yes
1741.172Shubertf
1751.302SjkoshyMKDTRACE	If "no", do not build and install the kernel modules,
1761.302Sjkoshy		utilities and libraries used to implement the dtrace(1)
1771.302Sjkoshy		facility.
1781.302Sjkoshy		Default: no
1791.302Sjkoshy
1801.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1811.172Shubertf		don't install certain libraries in /lib, and don't
1821.172Shubertf		install the shared linker into /libexec.
1831.172Shubertf		Default: yes
1841.172Shubertf
1851.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
1861.260Suebayasi		to cross-build programs and libraries externally added by
1871.260Suebayasi		users, and automatically enables creation of those sets.
1881.260Suebayasi		Default: no
1891.260Suebayasi
1901.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1911.186Smrg		libraries (libgcc, libobjc, libstdc++).
1921.172Shubertf		Default: yes
1931.172Shubertf
1941.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
1951.201Slukem		libraries (libgcc, libobjc, libstdc++).
1961.172Shubertf		Default: yes
1971.172Shubertf
1981.172ShubertfMKGDB		If "no", don't build gdb(1).
1991.172Shubertf		Default: yes
2001.172Shubertf
2011.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
2021.172Shubertf		(libraries and support programs).
2031.172Shubertf		Default: yes
2041.172Shubertf
2051.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
2061.172Shubertf		host, the name, release, and architecture of the host
2071.172Shubertf		operating system will be suffixed to the name of the object
2081.172Shubertf		directory created by "make obj".
2091.172Shubertf		Default: no
2101.172Shubertf
2111.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
2121.222Slukem		Default: yes
2131.172Shubertf
2141.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
2151.172Shubertf		Has no effect on most platforms.
2161.172Shubertf		Default: yes
2171.172Shubertf
2181.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
2191.225Sjoerg		Default: no
2201.225Sjoerg
2211.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2221.273Smrg		(libraries and support programs).  This option must not be
2231.273Smrg		set to "no" if MKX11 is not "no".
2241.172Shubertf		Default: yes
2251.172Shubertf
2261.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2271.172Shubertf		Texinfo source files.
2281.172Shubertf		Default: yes
2291.172Shubertf
2301.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2311.172Shubertf		Default: yes
2321.172Shubertf
2331.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2341.181Smrg		(depends on libpthread.)
2351.181Smrg		Default: yes
2361.181Smrg
2371.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2381.172Shubertf		infrastructure (libraries and support programs).
2391.172Shubertf		Default: yes
2401.172Shubertf
2411.304SjkoshyMKKMOD		If "no", disables building of kernel modules.
2421.304Sjkoshy		Default: yes
2431.304Sjkoshy
2441.312SjmmvMKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
2451.312Sjmmv		Note that setting this to "no" does not disable the build of
2461.312Sjmmv		the NetBSD test suite itself; the build of the tests is
2471.312Sjmmv		controlled by the MKATF knob.
2481.312Sjmmv		Default: no (until the import is done and validated)
2491.312Sjmmv
2501.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2511.208Slukem		(libraries and support programs).
2521.208Slukem		Default: yes
2531.208Slukem
2541.316SjoergMKLIBCXX	If not "no", build and install libc++.
2551.316Sjoerg		Default: no
2561.316Sjoerg
2571.316SjoergMKLIBSTDCXX	If not "no", build and install libstdc++.
2581.316Sjoerg		Default: yes
2591.316Sjoerg
2601.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2611.172Shubertf		Also:
2621.172Shubertf			- don't install the .a libraries
2631.172Shubertf			- don't install _pic.a libraries on PIC systems
2641.172Shubertf			- don't build .a libraries on PIC systems
2651.172Shubertf			- don't install the .so symlink on ELF systems
2661.172Shubertf		I.e, only install the shared library (and the .so.major
2671.172Shubertf		symlink on ELF).
2681.172Shubertf		Default: yes
2691.172Shubertf
2701.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2711.172Shubertf		Default: yes
2721.172Shubertf
2731.261StronMKLVM		If "no", don't build or install the logical volume manager
2741.245Sagc		and device mapper tools and libraries
2751.262Stron		Default: yes
2761.245Sagc
2771.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2781.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2791.172Shubertf		Default: yes
2801.172Shubertf
2811.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
2821.256Sjoerg		catman or html pages.  A directory can be exempted by
2831.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
2841.278Sjoerg		if NOMANDOC.${target} is set to "yes".
2851.292Sjoerg		Default: yes
2861.256Sjoerg
2871.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2881.172Shubertf		Default: no
2891.172Shubertf
2901.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
2911.253Stsarna		(libraries and support programs).
2921.253Stsarna		Default: yes
2931.253Stsarna
2941.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2951.172Shubertf		definition files.
2961.172Shubertf		Default: yes
2971.172Shubertf
2981.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
2991.275Srmind		Default: yes
3001.275Srmind
3011.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
3021.172Shubertf		and also acts as "MKOBJDIRS=no".
3031.172Shubertf		Default: yes
3041.172Shubertf
3051.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
3061.172Shubertf		Default: no
3071.172Shubertf
3081.172ShubertfMKPAM		If "no", disables building of PAM authentication
3091.172Shubertf		infrastructure (libraries and support programs).
3101.182Speter		Default: yes
3111.172Shubertf
3121.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
3131.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
3141.210Sgmcgarry		Default: no
3151.210Sgmcgarry
3161.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
3171.172Shubertf		Default: yes
3181.172Shubertf
3191.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
3201.172Shubertf		also acts as "MKPICLIB=no"
3211.301Sabs		Default: yes (for MACHINE_ARCHs that support it)
3221.172Shubertf
3231.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
3241.172Shubertf		Default: yes
3251.172Shubertf
3261.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
3271.172Shubertf		shared object libraries from the .a libraries.
3281.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
3291.172Shubertf		_pic.a library pointing to the .a library.
3301.172Shubertf		Default: yes
3311.172Shubertf
3321.198SchristosMKPIE		If "no", create regular executables. Otherwise create
3331.198Schristos		PIE (Position Independent Executables).
3341.198Schristos		Default: no
3351.198Schristos
3361.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3371.271Smrg		Default: no
3381.271Smrg
3391.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3401.172Shubertf		Default: yes
3411.172Shubertf
3421.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3431.172Shubertf		Default: yes
3441.172Shubertf
3451.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3461.295Swiz		different switches to make two builds from the same source tree
3471.295Swiz		result in the same build results.
3481.295Swiz		Default: no
3491.295Swiz
3501.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3511.172Shubertf		MKMAN=no MKNLS=no".
3521.172Shubertf		I.e, don't build catman pages, documentation, Info
3531.172Shubertf		documentation, man pages, NLS files, ...
3541.172Shubertf		Default: yes
3551.172Shubertf
3561.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3571.172Shubertf		infrastructure (libraries and support programs).
3581.172Shubertf		Default: yes
3591.172Shubertf
3601.319SadamMKSLJIT		If "no", disables building of sljit (stack-less platform
3611.309Salnsn		independent JIT compiler) private library and tests.
3621.309Salnsn		Default: yes on amd64, i386 and sparc, no elsewhere.
3631.309Salnsn
3641.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3651.172Shubertf		generate output containing library calls for floating
3661.172Shubertf		point and possibly soft-float library support.
3671.172Shubertf		Default: no
3681.172Shubertf
3691.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3701.172Shubertf		libraries.
3711.172Shubertf		Default: yes
3721.172Shubertf
3731.306SchristosMKTPM		If "no" then don't build the Trusted Platform Module
3741.306Schristos		infrastructure.
3751.306Schristos		Default: no
3761.306Schristos
3771.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3781.172Shubertf		files or directories, and keep a metadata log of what
3791.172Shubertf		the owner/group/mode should be.  This allows a
3801.172Shubertf		non-root "make install".
3811.172Shubertf		Default: no
3821.172Shubertf
3831.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
3841.172Shubertf		more recently modified in the source directories that their
3851.172Shubertf		installed counterparts.
3861.172Shubertf		Default: no
3871.172Shubertf
3881.237SmrgMKX11		If not "no", depending on the value of ${X11FLAVOUR},
3891.237Smrg		'make build' also descends into either src/x11 (XFree86) or
3901.237Smrg		src/external/mit/xorg (modular Xorg) to cross-build X11 and
3911.237Smrg		automatically enables creation of X sets.
3921.216Smrg		Default: no
3931.216Smrg
3941.251SmrgMKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
3951.251Smrg		install the X fonts.  The xfont set is still created but
3961.251Smrg		will be empty.
3971.251Smrg		Default: yes
3981.251Smrg
3991.318SmbalmerMKX11MOTIF:	If "yes" and ${X11FLAVOUR} is "Xorg", build the native X11
4001.318Smbalmer		libGLw with Motif stubs.  If Motif is not installed in the
4011.318Smbalmer		default location /usr/pkg, the location can be specified
4021.318Smbalmer		using the X11MOTIFPATH variable.
4031.318Smbalmer		Default: no
4041.318Smbalmer
4051.172ShubertfMKYP		If "no", disables building of YP (NIS)
4061.172Shubertf		infrastructure (libraries and support programs).
4071.172Shubertf		Default: yes
4081.172Shubertf
4091.301SabsMKZFS		If "no", do not build and install utilities and libraries
4101.301Sabs		used to manage ZFS file system. Do not build zfs and solaris
4111.254Shaad		compatibility kernel modules.
4121.270Sriz		Default: yes on i386/amd64, no elsewhere.
4131.254Shaad
4141.298SchristosMKRUMP		If "no", do not build and install rump related headers,
4151.298Schristos		libraries, and programs.
4161.298Schristos		Default: yes
4171.298Schristos
4181.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
4191.172Shubertf		various system utilities/libraries that support it.
4201.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
4211.172Shubertf		forced to "no".
4221.172Shubertf
4231.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
4241.172Shubertf		various system utilities/libraries that support it.
4251.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
4261.172Shubertf		forced to "no".
4271.172Shubertf
4281.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
4291.197Sad		designed for improved performance with threaded
4301.197Sad		applications.  The "phkmalloc" allocator as used up
4311.197Sad		before NetBSD-5.0 will be substituted.
4321.197Sad
4331.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
4341.172Shubertf		support into various system utilities/libraries that
4351.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
4361.172Shubertf		will also be forced to "no".
4371.172Shubertf
4381.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
4391.208Slukem		system utilities/libraries that support it.
4401.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
4411.208Slukem
4421.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
4431.172Shubertf		into various system utilities/libraries that support it.
4441.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
4451.172Shubertf
4461.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
4471.172Shubertf		support into various system utilities/libraries that
4481.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4491.172Shubertf		also be forced to "no".
4501.204Slukem		Default: no
4511.172Shubertf
4521.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4531.257Stron		detects stack overflows and aborts the program. The
4541.268Snjoly		stack protection code imposes a performance penalty
4551.259Spgoyette		of about 5%.
4561.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4571.187Schristos
4581.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
4591.246Schristos		functions that do not do bounds checking regularly, but
4601.246Schristos		they could in some cases by using the gcc
4611.301Sabs		__builtin_object_size() function to determine the buffer
4621.246Schristos		size where it is known and detect buffer overflows.
4631.246Schristos		These substitute functions are in /usr/include/ssp.
4641.257Stron		Default: depends on the part of the source tree
4651.246Schristos
4661.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4671.172Shubertf		various system utilities/libraries that support it.
4681.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4691.172Shubertf
4701.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
4711.327Sapb		Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
4721.327Sapb		and use nbpigz to compress things.
4731.274Smrg		Default: "no".
4741.274Smrg
4751.237SmrgX11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
4761.237Smrg		XFree86 or modular Xorg.  Only matters if MKX11!=no.
4771.242Smrg		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
4781.242Smrg		"XFree86" on everything else.
4791.237Smrg
4801.172ShubertfCOPTS.lib<lib>
4811.177SmrgOBJCOPTS.lib<lib>
4821.172ShubertfLDADD.lib<lib>
4831.172ShubertfCPPFLAGS.lib<lib>
4841.172ShubertfCXXFLAGS.lib<lib>
4851.172ShubertfCOPTS.<prog>
4861.177SmrgOBJCCOPTS.<prog>
4871.172ShubertfLDADD.<prog>
4881.172ShubertfCPPFLAGS.<prog>
4891.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
4901.172Shubertf		variables in a way that applies only to a particular library
4911.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
4921.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
4931.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
4941.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
4951.172Shubertf		the crypto library.
4961.118Slukem
4971.281SjoergThe active compiler is selected using the following variables:
4981.281SjoergAVAILABLE_COMPILER
4991.281Sjoerg		List of available compiler suites.  Processed in order
5001.281Sjoerg		for selecting the active compiler for each frontend.
5011.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
5021.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
5031.281SjoergUNSUPPORTED_COMPILER.xxx
5041.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
5051.281Sjoerg
5061.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
5071.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
5081.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
5091.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
5101.281Sjoerg
5111.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
5121.1Scgd
5131.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
5141.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
5151.1Scgd
5161.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
5171.1Scgd
5181.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
5191.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
5201.17Sthorpeja few global "feature configuration" parameters.
5211.1Scgd
5221.1ScgdIt has no targets.
5231.1Scgd
5241.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
5251.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
5261.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
5271.29Scjsis included.  These files may define any of the variables described below.
5281.17Sthorpej
5291.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
5301.17Sthorpej(defaults are in brackets):
5311.15Scgd
5321.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
5331.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
5341.98Slukem		otherwise BSDSRCDIR will be used as the default.
5351.98Slukem		Various makefiles within the NetBSD source tree will
5361.98Slukem		use this to reference the top level of the source tree.
5371.98Slukem
5381.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
5391.98Slukem		based on the presence of tools/ and build.sh.  This variable
5401.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
5411.98Slukem		determined once and then propagated to all sub-makes.
5421.95Slukem
5431.305Sapb_NETBSD_VERSION_DEPENDS
5441.305Sapb		A list of files which contain information about
5451.305Sapb		the version of the NetBSD being built.  This is
5461.305Sapb		defined only if the current directory appears
5471.305Sapb		to be inside a NetBSD source tree.  The list of
5481.305Sapb		files includes ${NETBSDSRCDIR}/sys/sys/param.h
5491.305Sapb		(which contains the kernel version number),
5501.305Sapb		${NETBSDSRCDIR}/sys/conf/newvers.sh and
5511.305Sapb		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
5521.305Sapb		interpret the information in sys/sys/param.h), and
5531.305Sapb		${_SRC_TOP_OBJ_}/params (which is an optional file,
5541.305Sapb		created by "make build" in ${_SRC_TOP_}/Makefile,
5551.305Sapb		containing all the variables that may influence the
5561.305Sapb		build).
5571.305Sapb
5581.305Sapb		Targets that depend on the NetBSD version, or on
5591.305Sapb		variables defined at build time, can declare a
5601.305Sapb		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
5611.305Sapb
5621.305Sapb			version.c: ${_NETBSD_VERSION_DEPENDS}
5631.305Sapb				commands to create version.c
5641.305Sapb
5651.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
5661.116Slukem		will work correctly.  [/usr/src]
5671.15Scgd
5681.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
5691.116Slukem		will work correctly.  [/usr/obj]
5701.15Scgd
5711.116SlukemBINGRP		Binary group.  [wheel]
5721.15Scgd
5731.116SlukemBINOWN		Binary owner.  [root]
5741.15Scgd
5751.116SlukemBINMODE		Binary mode.  [555]
5761.15Scgd
5771.116SlukemNONBINMODE	Mode for non-executable files.  [444]
5781.15Scgd
5791.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
5801.15Scgd
5811.116SlukemMANGRP		Manual group.  [wheel]
5821.15Scgd
5831.116SlukemMANOWN		Manual owner.  [root]
5841.15Scgd
5851.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
5861.15Scgd
5871.222SlukemMANINSTALL	Manual installation type.  Space separated list:
5881.222Slukem			catinstall, htmlinstall, maninstall
5891.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
5901.76Sfair
5911.76SfairLDSTATIC	Control program linking; if set blank, link everything
5921.129Slukem		dynamically.  If set to "-static", link everything statically.
5931.76Sfair		If not set, programs link according to their makefile.
5941.21Schristos
5951.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
5961.15Scgd
5971.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
5981.15Scgd
5991.116SlukemLIBGRP		Library group.  [${BINGRP}]
6001.15Scgd
6011.116SlukemLIBOWN		Library owner.  [${BINOWN}]
6021.15Scgd
6031.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
6041.15Scgd
6051.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
6061.116Slukem	        installation.  [/usr/share/doc]
6071.62Ssimonb
6081.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
6091.62Ssimonb		[/usr/share/doc/html]
6101.15Scgd
6111.116SlukemDOCGRP		Documentation group.  [wheel]
6121.15Scgd
6131.116SlukemDOCOWN		Documentation owner.  [root]
6141.15Scgd
6151.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
6161.15Scgd
6171.84SkleinkNLSDIR		Base path for Native Language Support files installation.
6181.15Scgd		[/usr/share/nls]
6191.1Scgd
6201.116SlukemNLSGRP		Native Language Support files group.  [wheel]
6211.1Scgd
6221.116SlukemNLSOWN		Native Language Support files owner.  [root]
6231.1Scgd
6241.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
6251.1Scgd
6261.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
6271.255Sapb		if that exists; otherwise /usr/xsrc]
6281.144Slukem
6291.221SmrgX11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
6301.144Slukem
6311.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
6321.144Slukem
6331.221SmrgX11SRCDIR.lib<package>
6341.221SmrgX11SRCDIR.<package>
6351.221Smrg		The path to the xorg src tree for the specificed package>.
6361.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
6371.221Smrg
6381.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
6391.221Smrg		[/usr/X11R7]
6401.144Slukem
6411.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
6421.144Slukem
6431.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
6441.144Slukem
6451.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
6461.144Slukem
6471.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
6481.144Slukem
6491.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
6501.144Slukem
6511.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
6521.144Slukem
6531.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
6541.1Scgd		to be stripped.  This is to be used when building your
6551.1Scgd		own install script so that the entire system can be made
6561.146Slukem		stripped/not-stripped using a single knob.  []
6571.1Scgd
6581.2ScgdCOPY		The flag passed to the install program to cause the binary
6591.2Scgd		to be copied rather than moved.  This is to be used when
6601.2Scgd		building our own install script so that the entire system
6611.2Scgd		can either be installed with copies, or with moves using
6621.116Slukem		a single knob.  [-c]
6631.15Scgd
6641.310SapbMAKEDIRTARGETENV
6651.310Sapb		Environment variables passed to the child make process
6661.310Sapb		invoked by MAKEDIRTARGET.
6671.310Sapb
6681.150SlukemMAKEDIRTARGET dir target [params]
6691.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
6701.150Slukem		displaying a "pretty" message whilst doing so.
6711.150Slukem
6721.152SclRELEASEMACHINEDIR
6731.152Scl		Subdirectory used below RELEASEDIR when building
6741.152Scl		a release.  [${MACHINE}]
6751.152Scl
6761.152SclRELEASEMACHINE	Subdirectory or path component used for the following
6771.152Scl		paths:
6781.152Scl			distrib/${RELEASEMACHINE}
6791.152Scl			distrib/notes/${RELEASEMACHINE}
6801.152Scl			etc/etc.${RELEASEMACHINE}
6811.152Scl		Used when building a release.  [${MACHINE}]
6821.150Slukem
6831.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
6841.214Swizmake configuration file to modify the behavior of the system build
6851.17Sthorpejprocess (default values are in brackets along with comments, if set by
6861.134Slukem<bsd.own.mk>):
6871.33Sjonathan
6881.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
6891.172Shubertf		be used as part of a build in progress.
6901.172Shubertf		Supported values:
6911.172Shubertf
6921.172Shubertf		yes	Use the tools from TOOLDIR.
6931.172Shubertf			Must be set to this if cross-compiling.
6941.172Shubertf
6951.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
6961.172Shubertf			build native compilation tool components that are
6971.172Shubertf			version-specific for that tool.
6981.172Shubertf
6991.172Shubertf		never	Do not use the tools from TOOLDIR, even when
7001.172Shubertf			building native tool components.  This is similar to
7011.172Shubertf			the traditional NetBSD build method, but does not
7021.172Shubertf			verify that the compilation tools in use are
7031.172Shubertf			up-to-date enough in order to build the tree
7041.172Shubertf			successfully.  This may cause build or runtime
7051.172Shubertf			problems when building the whole NetBSD source tree.
7061.172Shubertf
7071.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
7081.172Shubertf		source tree (detected automatically); "no" otherwise
7091.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
7101.172Shubertf		make(1) include files).
7111.142Slukem
7121.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
7131.199Ssimonb		use ELF -- currently all architectures].
7141.33Sjonathan
7151.103SthorpejTOOLCHAIN_MISSING
7161.142Slukem		If not "no", this indicates that the platform being built
7171.103Sthorpej		does not have a working in-tree toolchain.  If the
7181.142Slukem		${MACHINE_ARCH} in question falls into this category,
7191.301Sabs		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
7201.103Sthorpej		Otherwise, the variable is unconditionally assigned the
7211.103Sthorpej		value "no".
7221.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
7231.142Slukem		unconditionally assigned the value "no".
7241.103Sthorpej
7251.103SthorpejEXTERNAL_TOOLCHAIN
7261.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
7271.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
7281.103Sthorpej		access to this variable.  The variable should be defined
7291.103Sthorpej		either in the user's environment or in the user's mk.conf
7301.103Sthorpej		file.  If defined, this variable indicates the root of
7311.103Sthorpej		an external toolchain which will be used to build the
7321.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
7331.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
7341.103Sthorpej		cross-compile framework.
7351.103Sthorpej
7361.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
7371.142Slukem		assigned the value "no", since the external version of the
7381.142Slukem		compiler may not be able to build the library components of
7391.142Slukem		the in-tree compiler.
7401.103Sthorpej
7411.103Sthorpej		NOTE: This variable is not yet used in as many places as
7421.103Sthorpej		it should be.  Expect the exact semantics of this variable
7431.103Sthorpej		to change in the short term as parts of the cross-compile
7441.103Sthorpej		framework continue to be cleaned up.
7451.1Scgd
7461.236SapbThe following variables are defined to commands to perform the
7471.236Sapbappropriate operation, with the default in [brackets].  Note that
7481.236Sapbthe defaults change if USETOOLS == "yes":
7491.236Sapb
7501.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
7511.236Sapb
7521.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
7531.236Sapb
7541.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
7551.236Sapb
7561.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
7571.236Sapb
7581.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
7591.236Sapb
7601.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
7611.236Sapb
7621.236SapbTOOL_CAT		Concatenate and print files.  [cat]
7631.236Sapb
7641.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
7651.236Sapb
7661.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
7671.236Sapb
7681.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
7691.236Sapb
7701.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
7711.236Sapb
7721.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
7731.236Sapb
7741.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
7751.236Sapb
7761.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
7771.236Sapb
7781.236SapbTOOL_EQN		Format equations for groff.  [eqn]
7791.236Sapb
7801.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
7811.236Sapb
7821.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
7831.236Sapb
7841.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
7851.236Sapb
7861.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
7871.236Sapb
7881.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
7891.236Sapb
7901.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
7911.247Ssketch
7921.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
7931.236Sapb
7941.327SapbTOOL_GZIP		Compression/decompression tool.  [gzip]
7951.327Sapb
7961.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
7971.236Sapb
7981.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
7991.236Sapb
8001.328SskrllTOOL_HPPAMKBOOT		Make bootable image for hppa.  [hppa-mkboot]
8011.236Sapb
8021.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
8031.236Sapb
8041.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
8051.236Sapb
8061.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
8071.236Sapb
8081.236SapbTOOL_JOIN		Relational database operator.  [join]
8091.236Sapb
8101.236SapbTOOL_M4			M4 macro language processor.  [m4]
8111.236Sapb
8121.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
8131.236Sapb
8141.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
8151.236Sapb
8161.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
8171.236Sapb
8181.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
8191.236Sapb
8201.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
8211.236Sapb
8221.236SapbTOOL_MENUC		Menu compiler.  [menuc]
8231.236Sapb
8241.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
8251.236Sapb			[mips-elf2ecoff]
8261.236Sapb
8271.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
8281.236Sapb
8291.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
8301.236Sapb
8311.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
8321.236Sapb
8331.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
8341.236Sapb
8351.311SjmcneillTOOL_MKNOD		Make device special file.  [mknod]
8361.311Sjmcneill
8371.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
8381.236Sapb
8391.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
8401.236Sapb
8411.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
8421.236Sapb
8431.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
8441.236Sapb
8451.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
8461.236Sapb
8471.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
8481.273Smrg
8491.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
8501.236Sapb
8511.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
8521.236Sapb
8531.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
8541.236Sapb
8551.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
8561.236Sapb
8571.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
8581.236Sapb
8591.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
8601.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
8611.236Sapb
8621.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
8631.236Sapb
8641.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
8651.236Sapb
8661.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
8671.236Sapb
8681.236SapbTOOL_SED		Stream editor.  [sed]
8691.236Sapb
8701.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
8711.236Sapb
8721.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
8731.236Sapb			[sparkcrc]
8741.236Sapb
8751.236SapbTOOL_STAT		Display file status.  [stat]
8761.236Sapb
8771.236SapbTOOL_STRFILE		Create a random access file for storing strings.
8781.236Sapb			[strfile]
8791.236Sapb
8801.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
8811.236Sapb
8821.236SapbTOOL_TBL		Format tables for groff.  [tbl]
8831.236Sapb
8841.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
8851.236Sapb
8861.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
8871.236Sapb
8881.236SapbTOOL_ZIC		Time zone compiler.  [zic]
8891.236Sapb
8901.323SmattFor each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
8911.323Smattlist of what ports can be built for it.  This keeps those definitions in
8921.323Smattcentralized place.
8931.323Smatt
8941.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
8951.1Scgdthey use the same default owners etc. as the rest of the tree.
8961.131Slukem
8971.131Slukem
8981.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
8991.286Sapb
9001.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
9011.286Sapbtargets.  It uses the following variables:
9021.286Sapb
9031.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
9041.286Sapb
9051.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
9061.286Sapb		the clean target.
9071.286Sapb
9081.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
9091.287Sapb		will delete files from both the object directory,
9101.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
9111.287Sapb
9121.287Sapb		If MKCLEANSRC is set to "no", then the file names in
9131.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
9141.287Sapb		to the object directory, ${.OBJDIR}.  This is the
9151.287Sapb		traditional behaviour.
9161.287Sapb
9171.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
9181.287Sapb		is performed relative to both the object directory,
9191.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
9201.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
9211.287Sapb		Deleting files from ${.CURDIR} is intended to remove
9221.287Sapb		stray output files that had been left in the source
9231.287Sapb		directory by an earlier build that did not use object
9241.287Sapb		directories.
9251.287Sapb
9261.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
9271.287Sapb		separate object directories, and you are sure that there
9281.287Sapb		are no stray files in the source directories, then you
9291.287Sapb		may set MKCLEANSRC=no to save some time.
9301.287Sapb
9311.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
9321.287Sapb		will verify that files have been deleted.
9331.287Sapb
9341.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
9351.287Sapb		be deleted using a "rm -f" command, and its success or
9361.287Sapb		failure will be ignored.
9371.287Sapb
9381.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
9391.287Sapb		the "rm -f" command will be verified using an "ls"
9401.287Sapb		command.
9411.287Sapb
9421.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
9431.287Sapb		there will be no problems caused by file permissions,
9441.287Sapb		read-only file systems, or the like, then you may set
9451.287Sapb		MKCLEANVERIFY=no to save some time.
9461.286Sapb
9471.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
9481.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
9491.286Sapbor CLEANDIRFILES variables.  For example:
9501.286Sapb
9511.286Sapb	    CLEANFILES+= a.out
9521.286Sapb	    CLEANDIRFILES+= .depend
9531.286Sapb
9541.286Sapb	    .include <bsd.clean.mk>
9551.286Sapb
9561.308SapbThe files listed in CLEANFILES and CLEANDIRFILES must not be
9571.308Sapbdirectories, because the potential risk from running "rm -rf" commands
9581.308Sapbin bsd.clean.mk is considered too great.  If you want to recursively
9591.308Sapbdelete a directory as part of "make clean" or "make cleandir" then you
9601.308Sapbneed to provide your own target.
9611.286Sapb
9621.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
9631.131Slukem
9641.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
9651.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
9661.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
9671.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
9681.133Slukemdependencies for the .d files.  In order for this to function correctly,
9691.132Slukemit should be .included after all other .mk files and directives that may
9701.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
9711.132Slukem
9721.132SlukemSRCS		List of source files to build the program.
9731.132Slukem
9741.132SlukemDPSRCS		List of source files which are needed for generating
9751.132Slukem		dependencies, but are not needed in ${SRCS}.
9761.1Scgd
9771.1Scgd
9781.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
9791.106Sthorpej
9801.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
9811.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
9821.124Slukem
9831.124SlukemFILES		The list of files to install.
9841.124Slukem
9851.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
9861.153Slukem		are installed by the `configinstall' target,
9871.153Slukem		not the `install' target.
9881.153Slukem		The FILES* variables documented below also apply.
9891.153Slukem
9901.124SlukemFILESOWN	File owner.  [${BINOWN}]
9911.124Slukem
9921.124SlukemFILESGRP	File group.  [${BINGRP}]
9931.124Slukem
9941.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
9951.124Slukem
9961.124SlukemFILESDIR	The location to install the files.
9971.124Slukem
9981.124SlukemFILESNAME	Optional name to install each file as.
9991.124Slukem
10001.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
10011.153Slukem
10021.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
10031.153Slukem
10041.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
10051.153Slukem
10061.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
10071.153Slukem
10081.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
10091.124Slukem
10101.285SapbFILESBUILD	If this variable is defined, then its value will be
10111.285Sapb		used as the default for all FILESBUILD_<fn> variables.
10121.285Sapb		Otherwise, the default will be "no".
10131.285Sapb
10141.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
10151.243Scube		targets to be built by `realall'.  Users of that variable
10161.243Scube		should provide a target to build the file.
10171.243Scube
10181.135Slukem
10191.139SlukemBUILDSYMLINKS	List of two word items:
10201.135Slukem			lnsrc lntgt
10211.135Slukem		For each lnsrc item, create a symlink named lntgt.
10221.135Slukem		The lntgt symlinks are removed by the cleandir target.
10231.106Sthorpej
10241.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
10251.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
10261.301Sabs		The source files have a `.uue' suffix, the generated files do
10271.148Sjmc		not.
10281.149Sjmc
10291.202SuweUUDECODE_FILES_RENAME_<fn>
10301.202Suwe		Rename the output from the decode to the provided name.
10311.148Sjmc		
10321.148Sjmc		*NOTE: These files are simply decoded, with no install or other
10331.148Sjmc		       rule applying implicitly except being added to the clean
10341.148Sjmc		       target.
10351.106Sthorpej
10361.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
10371.113Sthorpej
10381.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
10391.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
10401.134Slukembefore <bsd.gcc.mk>.
10411.113Sthorpej
10421.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
10431.113Sthorpejof which need to know where to find certain GCC support libraries.
10441.113Sthorpej
10451.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
10461.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
10471.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
10481.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
10491.113Sthorpej
10501.134Slukem<bsd.gcc.mk> sets the following variables:
10511.113Sthorpej
10521.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
10531.118Slukem
10541.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
10551.118Slukem
10561.118Slukem_GCC_CRTEND	The full path name to crtend.o.
10571.118Slukem
10581.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
10591.118Slukem
10601.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
10611.118Slukem
10621.118Slukem
10631.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
10641.118Slukem
10651.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
10661.118Slukemvariables:
10671.118Slukem
10681.124SlukemINCS		The list of include files.
10691.118Slukem
10701.118SlukemINCSDIR		The location to install the include files.
10711.118Slukem
10721.118SlukemINCSNAME	Target name of the include file, if only one; same as
10731.118Slukem		FILESNAME, but for include files.
10741.118Slukem
10751.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
10761.134Slukem		are installed in the 'includes' target and not the
10771.134Slukem		(much later) 'install' target.
10781.134Slukem
10791.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
10801.118Slukem		same as FILESNAME_<file>, but for include files.
10811.118Slukem
10821.118Slukem
10831.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
10841.118Slukem
10851.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
10861.118Slukemdocumentation from respective Texinfo source files.  It defines three
10871.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
10881.118Slukemfollowing variables:
10891.118Slukem
10901.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
10911.118Slukem		consist of single files with the extension replaced by
10921.118Slukem		.info.
10931.118Slukem
10941.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
10951.118Slukem
10961.118Slukem
10971.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
10981.118Slukem
10991.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
11001.118Slukemlocation of kernel sources and object directories.
11011.118Slukem
11021.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
11031.124Slukem		[${_SRC_TOP_}/sys]
11041.118Slukem
11051.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
11061.124Slukem		[arch/${MACHINE}]
11071.120Slukem
11081.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
11091.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
11101.118Slukem
11111.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
11121.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
11131.118Slukem		The default value is
11141.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
11151.118Slukem		if it exists or the target 'obj' is being made.
11161.118Slukem		Otherwise the default is
11171.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
11181.118Slukem
11191.118SlukemIt is important that Makefiles (such as those under src/distrib) that
11201.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
11211.118Slukemrather than make assumptions about the location of the compiled kernel.
11221.118Slukem
11231.118Slukem
11241.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
11251.118Slukem
11261.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
11271.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
11281.118Slukeminclude file installation.  It is intended to be included alone, by
11291.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
11301.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
11311.134Slukemin that file up to date.
11321.118Slukem
11331.325Schristos=-=-=-=-=   bsd.syscall.mk =-=-=-=-=
11341.325Schristos
11351.325SchristosThe include file <bsd.syscall.mk> contains the logic to create syscall
11361.325Schristosfiles for various emulations. It includes <bsd.kinc.mk> to handle the
11371.325Schristosrest of the targets.
11381.118Slukem
11391.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
11401.118Slukem
11411.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
11421.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
11431.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
11441.118Slukemwhich checks for installed shared object libraries whose version is greater
11451.118Slukemthat the version of the source. It has a limited number of suffixes,
11461.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
11471.118Slukem<bsd.shlib.mk> to get shared library parameters.
11481.118Slukem
11491.118SlukemIt sets/uses the following variables:
11501.118Slukem
11511.118SlukemLIB		The name of the library to build.
11521.118Slukem
11531.118SlukemLIBDIR		Target directory for libraries.
11541.118Slukem
11551.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
11561.248Sperry		permissions in files inside its archives to those of
11571.248Sperry		the file it was fed. This leads to non-reproduceable
11581.324Sapb		builds. If MKARZERO is set to "yes" (default is the
11591.324Sapb		same as MKREPRO, or "no" if MKREPRO is not defined),
11601.248Sperry		then the "D" flag is passed to ar, causing the
11611.248Sperry		timestamp, uid and gid to be zeroed and the file
11621.248Sperry		permissions to be set to 644. This allows .a files
11631.248Sperry		from different builds to be bit identical.
11641.248Sperry
11651.300SjoergSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
11661.300Sjoerg		is not "no".
11671.300Sjoerg
11681.263SabsSHLIB_MAJOR
11691.263SabsSHLIB_MINOR
11701.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
11711.263Sabs
11721.300SjoergUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
11731.118Slukem		as the path to install shared libraries to.
11741.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
11751.130Slukem		Default: no
11761.118Slukem
11771.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
11781.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
11791.218Slukem		MKPROFILE=no MKSTATICLIB=no".
11801.218Slukem		Default: no
11811.218Slukem
11821.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
11831.211Slukem		MKPROFILE=no", and don't install the (.a) library.
11841.154Slukem		This is useful for "build only" helper libraries.
11851.154Slukem		Default: no
11861.154Slukem
11871.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
11881.244Smrg		shared libraries.
11891.244Smrg		This is useful for C++ libraries.
11901.244Smrg		Default: no
11911.244Smrg
11921.118SlukemLINTLIBDIR	Target directory for lint libraries.
11931.118Slukem
11941.118SlukemLIBGRP		Library group.
11951.118Slukem
11961.118SlukemLIBOWN		Library owner.
11971.118Slukem
11981.118SlukemLIBMODE		Library mode.
11991.118Slukem
12001.118SlukemLDADD		Additional loader objects.
12011.118Slukem
12021.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12031.118Slukem
12041.118SlukemNOCHECKVER_<library>
12051.118SlukemNOCHECKVER	If set, disables checking for installed shared object
12061.118Slukem		libraries with versions greater than the source.  A
12071.118Slukem		particular library name, without the "lib" prefix, may
12081.118Slukem		be appended to the variable name to disable the check for
12091.118Slukem		only that library.
12101.118Slukem
12111.118SlukemSRCS		List of source files to build the library.  Suffix types
12121.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
12131.118Slukem		to .c files of the same name.  (This is not the default for
12141.118Slukem		versions of make.)
12151.118Slukem
12161.157SlukemLIBDPLIBS	A list of the tuples:
12171.157Slukem			libname  path-to-srcdir-of-libname
12181.157Slukem
12191.157Slukem		For each tuple;
12201.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
12211.157Slukem			`libname', and if it is not set it is determined
12221.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
12231.157Slukem			latter is to allow for build time optimization).
12241.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
12251.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
12261.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
12271.157Slukem
12281.307Spooka		The special value "_external" for LIBDO.lib makes the
12291.307Spooka		build system to assume the library comes from outside
12301.307Spooka		of the NetBSD source tree and only causes -llibname
12311.307Spooka		to be added to LDADD.
12321.307Spooka
12331.157Slukem		This variable may be used for individual libraries, as
12341.301Sabs		well as in parent directories to cache common libraries
12351.157Slukem		as a build-time optimization.
12361.157Slukem
12371.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
12381.118Slukemif it exists, as well as the include file <bsd.man.mk>.
12391.118Slukem
12401.118SlukemIt has rules for building profiled objects; profiled libraries are
12411.118Slukembuilt by default.
12421.118Slukem
12431.118SlukemLibraries are ranlib'd when made.
12441.118Slukem
12451.118Slukem
12461.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
12471.118Slukem
12481.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
12491.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
12501.134Slukem
12511.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
12521.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
12531.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
12541.249Sapbby a method for explicitly recording hard links in a metadata log.
12551.249Sapb
12561.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
12571.134Slukem			source-file target-file
12581.134Slukem		${DESTDIR} is prepended to both paths before linking.
12591.134Slukem		For example, to link /bin/test and /bin/[, use:
12601.134Slukem			LINKS=/bin/test /bin/[
12611.134Slukem
12621.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
12631.153Slukem		are installed by the `configinstall' target,
12641.153Slukem		not the `install' target.
12651.153Slukem
12661.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
12671.134Slukem			source-file target-file
12681.134Slukem		${DESTDIR} is only prepended to target-file before linking.
12691.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
12701.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
12711.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
12721.118Slukem
12731.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
12741.153Slukem		are installed by the `configinstall' target,
12751.153Slukem		not the `install' target.
12761.153Slukem
12771.249SapbLINKSOWN	Link owner.  [${BINOWN}]
12781.249Sapb
12791.249SapbLINKSGRP	Link group.  [${BINGRP}]
12801.249Sapb
12811.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
12821.249Sapb
12831.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
12841.249Sapb
12851.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
12861.249Sapb
12871.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
12881.249Sapb
12891.118Slukem
12901.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
12911.118Slukem
12921.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
12931.118Slukemlinks.
12941.118Slukem
12951.222SlukemIt has a three targets:
12961.118Slukem
12971.222Slukem	catinstall:
12981.222Slukem		Install the preformatted manual pages and their links.
12991.222Slukem	htmlinstall:
13001.222Slukem		Install the HTML manual pages and their links.
13011.118Slukem	maninstall:
13021.118Slukem		Install the manual page sources and their links.
13031.118Slukem
13041.118SlukemIt sets/uses the following variables:
13051.118Slukem
13061.118SlukemMANDIR		Base path for manual installation.
13071.118Slukem
13081.118SlukemMANGRP		Manual group.
13091.118Slukem
13101.118SlukemMANOWN		Manual owner.
13111.118Slukem
13121.118SlukemMANMODE		Manual mode.
13131.118Slukem
13141.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
13151.118Slukem		or "/tahoe" for machine specific manual pages.
13161.118Slukem
13171.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
13181.118Slukem
13191.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
13201.118Slukem		linked-to file must come first, the linked file second,
13211.276Sreed		and there may be multiple pairs.
13221.118Slukem
13231.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
13241.118Slukemit exists.
13251.118Slukem
13261.118Slukem
13271.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
13281.118Slukem
13291.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
13301.118Slukemand use of separated object and source directories.
13311.118Slukem
13321.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
13331.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
13341.118Slukemit exists.  Otherwise make(1) looks for the existence of a
13351.118Slukemsubdirectory (or a symlink to a directory) of the source directory
13361.118Slukeminto which built targets should be placed.  If an environment variable
13371.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
13381.118Slukemobject directory; failing that, make first looks for a subdirectory
13391.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
13401.118Slukem
13411.118SlukemObject directories are not created automatically by make(1) if they
13421.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
13431.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
13441.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
13451.118Slukemand this is determined by a simple string prefix comparison -- object
13461.118Slukemdirectories are created in a separate object directory tree, and a
13471.118Slukemsymlink to the object directory in that tree is created in the source
13481.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
13491.118Slukemsource tree and that it's not safe to use a separate object tree.
13501.118Slukem
13511.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
13521.118Slukemdirectories and links get created during a "make obj":
13531.118Slukem
13541.118SlukemMAKEOBJDIR	If set, this is the component name of the object
13551.118Slukem		directory.
13561.118Slukem
13571.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
13581.118Slukem		object directories or links named "obj.${MACHINE}";
13591.118Slukem		otherwise, just creates ones named "obj".
13601.118Slukem
13611.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
13621.118Slukem		${BSDSRCDIR}, create object directory in the
13631.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
13641.118Slukem		otherwise, create it in the corresponding subdirectory
13651.118Slukem		of ${BSDOBJDIR}
13661.113Sthorpej
13671.118SlukemBUILDID		If set, the contents of this variable are appended
13681.118Slukem		to the object directory name.  If OBJMACHINE is also
13691.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
13701.113Sthorpej
13711.106Sthorpej
13721.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
13731.106Sthorpej
13741.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
13751.1Scgdmore source files, along with their manual pages.  It has a limited number
13761.301Sabsof suffixes, consistent with the current needs of the BSD tree.
13771.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
13781.1Scgd
13791.16SjtcIt has eight targets:
13801.1Scgd
13811.1Scgd	all:
13821.102Sthorpej		build the program and its manual page.  This also
13831.102Sthorpej		creates a GDB initialization file (.gdbinit) in
13841.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
13851.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
13861.1Scgd	clean:
13871.1Scgd		remove the program, any object files and the files a.out,
13881.24Smikel		Errs, errs, mklog, and ${PROG}.core.
13891.1Scgd	cleandir:
13901.1Scgd		remove all of the files removed by the target clean, as
13911.1Scgd		well as .depend, tags, and any manual pages.
13921.42Slukem		`distclean' is a synonym for `cleandir'.
13931.1Scgd	depend:
13941.1Scgd		make the dependencies for the source files, and store
13951.1Scgd		them in the file .depend.
13961.16Sjtc	includes:
13971.16Sjtc		install any header files.
13981.1Scgd	install:
13991.1Scgd		install the program and its manual pages; if the Makefile
14001.1Scgd		does not itself define the target install, the targets
14011.1Scgd		beforeinstall and afterinstall may also be used to cause
14021.1Scgd		actions immediately before and after the install target
14031.1Scgd		is executed.
14041.1Scgd	lint:
14051.1Scgd		run lint on the source files
14061.1Scgd	tags:
14071.1Scgd		create a tags file for the source files.
14081.1Scgd
14091.1ScgdIt sets/uses the following variables:
14101.1Scgd
14111.1ScgdBINGRP		Binary group.
14121.1Scgd
14131.1ScgdBINOWN		Binary owner.
14141.1Scgd
14151.1ScgdBINMODE		Binary mode.
14161.1Scgd
14171.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
14181.286Sapb
14191.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
14201.1Scgd
14211.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
14221.112Sthorpej
14231.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
14241.125Slukem		C objects for <fn>.
14251.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14261.125Slukem
14271.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
14281.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
14291.35Slukem
14301.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
14311.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14321.125Slukem
14331.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
14341.125Slukem
14351.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
14361.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14371.102Sthorpej
14381.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
14391.102Sthorpej		directives in the .gdbinit file that is created in the
14401.102Sthorpej		objdir.
14411.1Scgd
14421.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
14431.1Scgd		For example, to load with the compatibility and utility
14441.1Scgd		libraries, use:
14451.1Scgd
14461.5Sjtc			LDADD+=-lutil -lcompat
14471.1Scgd
14481.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
14491.1Scgd
14501.134SlukemLINKS		See <bsd.links.mk>
14511.134Slukem
14521.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
14531.177Smrg
14541.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
14551.177Smrg		ObjC objects for <fn>.
14561.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
14571.177Smrg
14581.134SlukemSYMLINKS	See <bsd.links.mk>
14591.1Scgd
14601.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
14611.8Scgd		defined, "MAN=${PROG}.1" is assumed.
14621.1Scgd
14631.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
14641.212Slukem		time, with the value of this variable as args to paxctl(1).
14651.193Sperry
14661.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
14671.193Sperry
14681.1ScgdPROG		The name of the program to build.  If not supplied, nothing
14691.1Scgd		is built.
14701.1Scgd
14711.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
14721.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
14731.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
14741.88Sthorpej		the value of PROG if PROG is also set.
14751.87Sthorpej
14761.21SchristosPROGNAME	The name that the above program will be installed as, if
14771.21Schristos		different from ${PROG}.
14781.21Schristos
14791.37StvSRCS		List of source files to build the program.  If SRCS is not
14801.1Scgd		defined, it's assumed to be ${PROG}.c.
14811.108Sjwise
14821.108SjwiseDPSRCS		List of source files which are needed for generating
14831.108Sjwise		dependencies, but are not needed in ${SRCS}.
14841.1Scgd
14851.1ScgdDPADD		Additional dependencies for the program.  Usually used for
14861.1Scgd		libraries.  For example, to depend on the compatibility and
14871.1Scgd		utility libraries use:
14881.1Scgd
14891.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
14901.1Scgd
14911.288Schristos		The following system libraries are predefined for DPADD:
14921.1Scgd
14931.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
14941.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
14951.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
14961.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
14971.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
14981.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
14991.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
15001.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
15011.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
15021.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
15031.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
15041.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
15051.322Sjoerg		LIBCRTI?=	${DESTDIR}/usr/lib/crti.o
15061.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
15071.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
15081.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
15091.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
15101.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
15111.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
15121.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
15131.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
15141.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
15151.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
15161.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
15171.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
15181.315Schristos		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
15191.315Schristos		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
15201.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
15211.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
15221.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
15231.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
15241.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
15251.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
15261.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
15271.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
15281.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
15291.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
15301.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
15311.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
15321.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
15331.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
15341.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
15351.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
15361.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
15371.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
15381.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
15391.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
15401.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
15411.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
15421.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
15431.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
15441.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
15451.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
15461.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
15471.313Sjmmv		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
15481.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
15491.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
15501.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
15511.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
15521.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
15531.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
15541.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
15551.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
15561.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
15571.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
15581.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
15591.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
15601.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
15611.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
15621.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
15631.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
15641.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
15651.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
15661.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
15671.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
15681.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
15691.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
15701.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
15711.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
15721.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
15731.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
15741.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
15751.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
15761.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
15771.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
15781.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
15791.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
15801.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
15811.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
15821.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
15831.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
15841.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
15851.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
15861.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
15871.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
15881.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
15891.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
15901.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
15911.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
15921.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
15931.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
15941.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
15951.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
15961.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
15971.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
15981.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
15991.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
16001.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
16011.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
16021.1Scgd
16031.288Schristos		The following X-Windows libraries are predefined for DPADD:
16041.288Schristos
16051.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
16061.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
16071.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
16081.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
16091.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
16101.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
16111.317Smrg		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
16121.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
16131.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
16141.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
16151.320Schristos		LIBXCB?=	${DESTDIR}/usr/X11R7/lib/libxcb.a
16161.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
16171.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
16181.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
16191.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
16201.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
16211.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
16221.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
16231.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
16241.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
16251.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
16261.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
16271.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
16281.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
16291.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
16301.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
16311.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
16321.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
16331.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
16341.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
16351.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
16361.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
16371.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
16381.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
16391.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
16401.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
16411.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
16421.288Schristos
16431.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
16441.12Schristos		strings, using xstr(1). Note that this will not work with
16451.12Schristos		parallel makes.
16461.1Scgd
16471.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
16481.1Scgd		to be stripped.
16491.1Scgd
16501.1ScgdSUBDIR		A list of subdirectories that should be built as well.
16511.1Scgd		Each of the targets will execute the same target in the
16521.1Scgd		subdirectories.
16531.1Scgd
16541.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
16551.21Schristos		These are installed exactly like programs.
16561.21Schristos
16571.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
16581.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
16591.166Srtr
16601.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
16611.21Schristos		different from ${SCRIPTS}. These can be further specialized
16621.21Schristos		by setting SCRIPTSNAME_<script>.
16631.21Schristos
16641.124SlukemFILES		See description of <bsd.files.mk>.
16651.21Schristos
16661.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
16671.106Sthorpej		<bsd.own.mk> for additional information about this variable.
16681.130Slukem
16691.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
16701.1Scgdif it exists, as well as the include file <bsd.man.mk>.
16711.1Scgd
16721.1ScgdSome simple examples:
16731.1Scgd
16741.1ScgdTo build foo from foo.c with a manual page foo.1, use:
16751.1Scgd
16761.1Scgd	PROG=	foo
16771.1Scgd
16781.1Scgd	.include <bsd.prog.mk>
16791.1Scgd
16801.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
16811.1Scgd
16821.9Scgd	MAN=	foo.2
16831.1Scgd
16841.1ScgdIf foo does not have a manual page at all, add the line:
16851.1Scgd
16861.75Sagc	MKMAN=	no
16871.1Scgd
16881.1ScgdIf foo has multiple source files, add the line:
16891.1Scgd
16901.1Scgd	SRCS=	a.c b.c c.c d.c
16911.1Scgd
16921.1Scgd
16931.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
16941.118Slukem
16951.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
16961.118Slukemconstruct source files built by rpcgen.
16971.72Ssommerfe
16981.118SlukemThe following macros may be defined in makefiles which include
16991.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
17001.118Slukemare to be built:
17011.21Schristos
17021.118SlukemRPC_INCS:	construct .h file from .x file
17031.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
17041.118Slukem		(for marshalling/unmarshalling data types)
17051.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
17061.118Slukem		(server-side stubs)
17071.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
17081.21Schristos
17091.118SlukemRPC_XDIR:	Directory containing .x/.h files
17101.23Schristos
17111.23Schristos
17121.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
17131.21Schristos
17141.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
17151.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
17161.134Slukemincluded before <bsd.shlib.mk>.
17171.21Schristos
17181.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
17191.118Slukem(defaults are in brackets):
17201.21Schristos
17211.300SjoergSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
17221.300Sjoerg		instead of ${LIBDIR} as the base path for shared library
17231.300Sjoerg		installation.  [/lib]
17241.300Sjoerg
17251.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
17261.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
17271.118Slukem		for all others.]
17281.81Swiz
17291.300Sjoerg_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
17301.118Slukem		otherwise set to ${LIBDIR}
17311.81Swiz
17321.300SjoergSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
17331.300Sjoerg
17341.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
17351.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
17361.118Slukem		all others.]
17371.39Scgd
17381.13Schristos
17391.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
17401.13Schristos
17411.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
17421.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
17431.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
17441.233Sapbfollowing variables:
17451.233Sapb
17461.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
17471.233Sapb		will be ignored and subdirectories will not be processed.
17481.233Sapb
17491.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
17501.233Sapb		specified directory will be visited and the target made.
17511.233Sapb
17521.233Sapb		As a special case, the use of a token .WAIT as an
17531.233Sapb		entry in SUBDIR acts as a synchronization barrier
17541.233Sapb		when multiple make jobs are run; subdirs before the
17551.233Sapb		.WAIT must complete before any subdirs after .WAIT are
17561.233Sapb		started.  See make(1) for some caveats on use of .WAIT
17571.233Sapb		and other special sources.
17581.47Stv
17591.47Stv
17601.326Schristos=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
17611.326Schristos
17621.326SchristosThe include file <bsd.x11.mk> contains parameters and targets for
17631.326Schristoscross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
17641.326SchristosIt should be included after the general Makefile contents but before
17651.326Schristosthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
17661.326Schristos
17671.326SchristosIt provides the following targets:
17681.326Schristos	.man.1 .man.3 .man.4 .man.5 .man.7:
17691.326Schristos		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
17701.326Schristos		these rules convert from X11's manual page source
17711.326Schristos		into an mdoc.old source file.
17721.326Schristos
17731.326SchristosIt sets the following variables:
17741.326Schristos
17751.326SchristosBINDIR			Set to ${X11BINDIR}.
17761.326Schristos			To override, define after including <bsd.x11.mk>
17771.326Schristos
17781.326SchristosLIBDIR			Set to ${X11USRLIBDIR}.
17791.326Schristos			To override, define after including <bsd.x11.mk>
17801.326Schristos
17811.326SchristosMANDIR			Set to ${X11MANDIR}.
17821.326Schristos			To override, define after including <bsd.x11.mk>
17831.326Schristos
17841.326SchristosCPPFLAGS		Appended with definitions to include from
17851.326Schristos			${DESTDIR}${X11INCDIR}
17861.326Schristos
17871.326SchristosLDFLAGS			Appended with definitions to link from
17881.326Schristos			${DESTDIR}${X11USRLIBDIR}
17891.326Schristos
17901.326SchristosX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
17911.326Schristos
17921.326SchristosX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
17931.326Schristos
17941.326SchristosX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
17951.326Schristos
17961.326SchristosX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
17971.326Schristos
17981.326SchristosX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
17991.326Schristos
18001.326SchristosX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18011.326Schristos
18021.326SchristosX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
18031.326Schristos
18041.326SchristosX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
18051.326Schristos
18061.326SchristosX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
18071.326Schristos
18081.326SchristosX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
18091.326Schristos
18101.326SchristosIt uses the following variables:
18111.326Schristos
18121.326SchristosAPPDEFS			List of app-default files to install.
18131.326Schristos
18141.326SchristosCPPSCRIPTS		List of files/scripts to run through cpp(1)
18151.326Schristos			and then ${X11TOOL_UNXCOMM}.  The source files
18161.326Schristos			have a `.cpp' suffix, the generated files do not.
18171.326Schristos
18181.326SchristosCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
18191.326Schristos
18201.326SchristosCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
18211.326Schristos
18221.326Schristos
18231.326Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
18241.326Schristos
18251.326SchristosThe following files are described here for completion, but they are not
18261.326Schristossupposed to be included directly from other Makefiles; they are used
18271.326Schristosinternally by other system files.
18281.326Schristos
18291.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
18301.47Stv
18311.326SchristosThe include file <bsd.sys.mk> is used by other system mk files and
18321.326Schristosit is not intended to be included standalone. It contains rules and
18331.326Schristossystem build variables. It requires bsd.own.mk to be included first.
18341.326SchristosIt contains overrides that are used when building the NetBSD source tree.
18351.133Slukem
18361.133SlukemThe following variables control how various files are compiled/built.
18371.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
18381.133Slukem
18391.133SlukemAR		Create, modify, and extract from archives.  [ar]
18401.133Slukem
18411.133SlukemARFLAGS		Options to ${AR}.  [rl]
18421.133Slukem
18431.151SlukemAS		Assembler.  [as]
18441.151Slukem
18451.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
18461.211Slukem		assembly source files.  []
18471.151Slukem
18481.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
18491.217Sjoerg		If this option is present, seed the random number
18501.217Sjoerg		generator based on the value, source file names and
18511.217Sjoerg		the output file name to make builds more deterministic.
18521.217Sjoerg		Additional information is available in the GCC
18531.217Sjoerg		documentation of -frandom-seed.
18541.217Sjoerg
18551.133SlukemCC		C compiler.  [cc]
18561.133Slukem
18571.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
18581.133Slukem
18591.133SlukemCPP		C Pre-Processor.  [cpp]
18601.133Slukem
18611.133SlukemCPPFLAGS	Options to ${CPP}.  []
18621.133Slukem
18631.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
18641.133Slukem
18651.133SlukemCXX		C++ compiler.  [c++]
18661.133Slukem
18671.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
18681.133Slukem
18691.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
18701.133Slukem
18711.133SlukemFC		Fortran compiler.  [f77]
18721.133Slukem
18731.133SlukemFFLAGS		Options to {$FC}.  [-O]
18741.133Slukem
18751.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
18761.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
18771.235Sapb
18781.133SlukemINSTALL		install(1) command.  [install]
18791.133Slukem
18801.133SlukemLEX		Lexical analyzer.  [lex]
18811.133Slukem
18821.133SlukemLFLAGS		Options to ${LEX}.  []
18831.133Slukem
18841.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
18851.145Sjwise
18861.133SlukemLD		Linker.  [ld]
18871.133Slukem
18881.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
18891.133Slukem
18901.133SlukemLINT		C program verifier.  [lint]
18911.133Slukem
18921.330SchristosLINTFLAGS	Options to ${LINT}.  [-chapbxzgFS]
18931.133Slukem
18941.133SlukemLORDER		List dependencies for object files.  [lorder]
18951.133Slukem
18961.133SlukemMAKE		make(1).  [make]
18971.133Slukem
18981.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
18991.133Slukem
19001.321SmrgMKDEPCXX	Construct Makefile dependency list for C++ files.  [mkdep]
19011.321Smrg
19021.133SlukemNM		List symbols from object files.  [nm]
19031.133Slukem
19041.133SlukemPC		Pascal compiler.  [pc]  (Not present)
19051.133Slukem
19061.133SlukemPFLAGS		Options to ${PC}.  []
19071.133Slukem
19081.133SlukemOBJC		Objective C compiler.  [${CC}]
19091.133Slukem
19101.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
19111.133Slukem
19121.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
19131.133Slukem
19141.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
19151.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
19161.291Schristos
19171.168SrizOBJDUMP		Display information from object files.  [objdump]
19181.168Sriz
19191.133SlukemRANLIB		Generate index to archive.  [ranlib]
19201.133Slukem
19211.133SlukemSIZE		List section sizes and total size.  [size]
19221.133Slukem
19231.133SlukemSTRIP		Discard symbols from object files.  [strip]
19241.133Slukem
19251.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
19261.133Slukem
19271.133SlukemYACC		LALR(1) parser generator.  [yacc]
19281.133Slukem
19291.133SlukemYFLAGS		Options to ${YACC}.  []
19301.133Slukem
19311.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
19321.133Slukem		from <file>.y to <file>.h and <file>.c, and add
19331.133Slukem		<foo>.h to CLEANFILES.
19341.133Slukem
19351.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
19361.133Slukem
19371.116Slukem
19381.69SsommerfeOther variables of note (incomplete list):
19391.69Ssommerfe
19401.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
19411.213Slukem		that cause warnings to be fatal, such as:
19421.213Slukem			-Werror -Wa,--fatal-warnings
19431.213Slukem		(The latter being for as(1).)
19441.212Slukem
19451.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
19461.283Sjoerg		passed to it.
19471.283Sjoerg
19481.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
19491.82Slukem			WARNS=1
19501.82Slukem			WARNS=2
19511.82Slukem			WARNS=3
19521.164Smatt			WARNS=4
19531.296Splunky			WARNS=5
19541.69Ssommerfe
19551.326Schristos=-=-=-=-=   bsd.host.mk  =-=-=-=-=
19561.144Slukem
19571.326SchristosThis file is automatically included from bsd.own.mk. It contains settings
19581.326Schristosfor all the HOST_* variables that are used in host programs and libraries.
19591.144Slukem
19601.326SchristosHOST_AR			The host archive processing command
19611.144Slukem
19621.326SchristosHOST_CC			The host c compiler
19631.144Slukem
19641.326SchristosHOST_CFLAGS		The host c compiler flags
19651.144Slukem
19661.326SchristosHOST_COMPILE.c		The host c compiler line with flags
19671.144Slukem
19681.326SchristosHOST_COMPILE.cc		The host c++ compiler line with flags
19691.144Slukem
19701.326SchristosHOST_CPP		The host c pre-processor
19711.144Slukem
19721.326SchristosHOST_CPPFLAGS		The cost c pre-processor flags
19731.144Slukem
19741.326SchristosHOST_CXX		The host c++ compiler
19751.144Slukem
19761.326SchristosHOST_CXXFLAGS		The host c++ compiler flags
19771.144Slukem
19781.326SchristosHOST_INSTALL_DIR	The host command to install a directory
19791.144Slukem
19801.326SchristosHOST_INSTALL_FILE	The host command to install a file
19811.144Slukem
19821.326SchristosHOST_INSTALL_SYMLINK	The host command to install a symlink
19831.144Slukem
19841.326SchristosHOST_LD			The host linker command
19851.144Slukem
19861.326SchristosHOST_LDFLAGS		The host linker flags
19871.144Slukem
19881.326SchristosHOST_LINK.c		The host c linker line with flags
19891.221Smrg
19901.326SchristosHOST_LINK.cc		The host c++ linker line with flags
19911.144Slukem
19921.326SchristosHOST_LN			The host command to link two files
19931.144Slukem
19941.326SchristosHOST_MKDEP		The host command to create dependencies for c programs
19951.144Slukem
19961.326SchristosHOST_MKDEPCXX		The host command to create dependencies for c++ programs
19971.144Slukem
19981.326SchristosHOST_OSTYPE		The host OSNAME-RELEASE-ARCH tupple
19991.144Slukem
20001.326SchristosHOST_RANLIB		The host command to create random access archives
20011.144Slukem
20021.326SchristosHOST_SH			The host Bourne shell interpreter name (absolute path)
20031.144Slukem
20041.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2005