bsd.README revision 1.317
11.317Smrg#	$NetBSD: bsd.README,v 1.317 2013/05/31 06:48:43 mrg 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.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1501.172Shubertf		Default: yes
1511.172Shubertf
1521.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1531.184Slukem		into /usr/libdata/debug.
1541.184Slukem		Default: no
1551.184Slukem
1561.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1571.219Slukem		with -DDEBUG.
1581.176Schristos		Default: no
1591.176Schristos
1601.314SchristosMKDEPINCLUDES	If "yes" issue .include statements in the .depend file
1611.314Schristos		instead of inlining the contents of the .d files. Useful
1621.314Schristos		when stale dependencies are present, to list the exact
1631.314Schristos		files that need refreshing. It is off by default because
1641.314Schristos		it is possibly slower.
1651.314Schristos		Default "no"
1661.314Schristos
1671.172ShubertfMKDOC		If "no", don't build or install the documentation.
1681.172Shubertf		Default: yes
1691.172Shubertf
1701.302SjkoshyMKDTRACE	If "no", do not build and install the kernel modules,
1711.302Sjkoshy		utilities and libraries used to implement the dtrace(1)
1721.302Sjkoshy		facility.
1731.302Sjkoshy		Default: no
1741.302Sjkoshy
1751.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1761.172Shubertf		don't install certain libraries in /lib, and don't
1771.172Shubertf		install the shared linker into /libexec.
1781.172Shubertf		Default: yes
1791.172Shubertf
1801.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
1811.260Suebayasi		to cross-build programs and libraries externally added by
1821.260Suebayasi		users, and automatically enables creation of those sets.
1831.260Suebayasi		Default: no
1841.260Suebayasi
1851.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1861.186Smrg		libraries (libgcc, libobjc, libstdc++).
1871.172Shubertf		Default: yes
1881.172Shubertf
1891.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
1901.201Slukem		libraries (libgcc, libobjc, libstdc++).
1911.172Shubertf		Default: yes
1921.172Shubertf
1931.172ShubertfMKGDB		If "no", don't build gdb(1).
1941.172Shubertf		Default: yes
1951.172Shubertf
1961.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
1971.172Shubertf		(libraries and support programs).
1981.172Shubertf		Default: yes
1991.172Shubertf
2001.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
2011.172Shubertf		host, the name, release, and architecture of the host
2021.172Shubertf		operating system will be suffixed to the name of the object
2031.172Shubertf		directory created by "make obj".
2041.172Shubertf		Default: no
2051.172Shubertf
2061.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
2071.222Slukem		Default: yes
2081.172Shubertf
2091.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
2101.172Shubertf		Has no effect on most platforms.
2111.172Shubertf		Default: yes
2121.172Shubertf
2131.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
2141.225Sjoerg		Default: no
2151.225Sjoerg
2161.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2171.273Smrg		(libraries and support programs).  This option must not be
2181.273Smrg		set to "no" if MKX11 is not "no".
2191.172Shubertf		Default: yes
2201.172Shubertf
2211.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2221.172Shubertf		Texinfo source files.
2231.172Shubertf		Default: yes
2241.172Shubertf
2251.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2261.172Shubertf		Default: yes
2271.172Shubertf
2281.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2291.181Smrg		(depends on libpthread.)
2301.181Smrg		Default: yes
2311.181Smrg
2321.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2331.172Shubertf		infrastructure (libraries and support programs).
2341.172Shubertf		Default: yes
2351.172Shubertf
2361.304SjkoshyMKKMOD		If "no", disables building of kernel modules.
2371.304Sjkoshy		Default: yes
2381.304Sjkoshy
2391.312SjmmvMKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
2401.312Sjmmv		Note that setting this to "no" does not disable the build of
2411.312Sjmmv		the NetBSD test suite itself; the build of the tests is
2421.312Sjmmv		controlled by the MKATF knob.
2431.312Sjmmv		Default: no (until the import is done and validated)
2441.312Sjmmv
2451.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2461.208Slukem		(libraries and support programs).
2471.208Slukem		Default: yes
2481.208Slukem
2491.316SjoergMKLIBCXX	If not "no", build and install libc++.
2501.316Sjoerg		Default: no
2511.316Sjoerg
2521.316SjoergMKLIBSTDCXX	If not "no", build and install libstdc++.
2531.316Sjoerg		Default: yes
2541.316Sjoerg
2551.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2561.172Shubertf		Also:
2571.172Shubertf			- don't install the .a libraries
2581.172Shubertf			- don't install _pic.a libraries on PIC systems
2591.172Shubertf			- don't build .a libraries on PIC systems
2601.172Shubertf			- don't install the .so symlink on ELF systems
2611.172Shubertf		I.e, only install the shared library (and the .so.major
2621.172Shubertf		symlink on ELF).
2631.172Shubertf		Default: yes
2641.172Shubertf
2651.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2661.172Shubertf		Default: yes
2671.172Shubertf
2681.261StronMKLVM		If "no", don't build or install the logical volume manager
2691.245Sagc		and device mapper tools and libraries
2701.262Stron		Default: yes
2711.245Sagc
2721.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2731.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2741.172Shubertf		Default: yes
2751.172Shubertf
2761.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
2771.256Sjoerg		catman or html pages.  A directory can be exempted by
2781.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
2791.278Sjoerg		if NOMANDOC.${target} is set to "yes".
2801.292Sjoerg		Default: yes
2811.256Sjoerg
2821.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2831.172Shubertf		Default: no
2841.172Shubertf
2851.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
2861.253Stsarna		(libraries and support programs).
2871.253Stsarna		Default: yes
2881.253Stsarna
2891.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2901.172Shubertf		definition files.
2911.172Shubertf		Default: yes
2921.172Shubertf
2931.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
2941.275Srmind		Default: yes
2951.275Srmind
2961.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2971.172Shubertf		and also acts as "MKOBJDIRS=no".
2981.172Shubertf		Default: yes
2991.172Shubertf
3001.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
3011.172Shubertf		Default: no
3021.172Shubertf
3031.172ShubertfMKPAM		If "no", disables building of PAM authentication
3041.172Shubertf		infrastructure (libraries and support programs).
3051.182Speter		Default: yes
3061.172Shubertf
3071.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
3081.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
3091.210Sgmcgarry		Default: no
3101.210Sgmcgarry
3111.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
3121.172Shubertf		Default: yes
3131.172Shubertf
3141.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
3151.172Shubertf		also acts as "MKPICLIB=no"
3161.301Sabs		Default: yes (for MACHINE_ARCHs that support it)
3171.172Shubertf
3181.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
3191.172Shubertf		Default: yes
3201.172Shubertf
3211.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
3221.172Shubertf		shared object libraries from the .a libraries.
3231.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
3241.172Shubertf		_pic.a library pointing to the .a library.
3251.172Shubertf		Default: yes
3261.172Shubertf
3271.198SchristosMKPIE		If "no", create regular executables. Otherwise create
3281.198Schristos		PIE (Position Independent Executables).
3291.198Schristos		Default: no
3301.198Schristos
3311.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3321.271Smrg		Default: no
3331.271Smrg
3341.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3351.172Shubertf		Default: yes
3361.172Shubertf
3371.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3381.172Shubertf		Default: yes
3391.172Shubertf
3401.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3411.295Swiz		different switches to make two builds from the same source tree
3421.295Swiz		result in the same build results.
3431.295Swiz		Default: no
3441.295Swiz
3451.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3461.172Shubertf		MKMAN=no MKNLS=no".
3471.172Shubertf		I.e, don't build catman pages, documentation, Info
3481.172Shubertf		documentation, man pages, NLS files, ...
3491.172Shubertf		Default: yes
3501.172Shubertf
3511.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3521.172Shubertf		infrastructure (libraries and support programs).
3531.172Shubertf		Default: yes
3541.172Shubertf
3551.309SalnsnMKSLJIT		If "no", disables buildin of sljit (stack-less platform
3561.309Salnsn		independent JIT compiler) private library and tests.
3571.309Salnsn		Default: yes on amd64, i386 and sparc, no elsewhere.
3581.309Salnsn
3591.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3601.172Shubertf		generate output containing library calls for floating
3611.172Shubertf		point and possibly soft-float library support.
3621.172Shubertf		Default: no
3631.172Shubertf
3641.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3651.172Shubertf		libraries.
3661.172Shubertf		Default: yes
3671.172Shubertf
3681.306SchristosMKTPM		If "no" then don't build the Trusted Platform Module
3691.306Schristos		infrastructure.
3701.306Schristos		Default: no
3711.306Schristos
3721.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3731.172Shubertf		files or directories, and keep a metadata log of what
3741.172Shubertf		the owner/group/mode should be.  This allows a
3751.172Shubertf		non-root "make install".
3761.172Shubertf		Default: no
3771.172Shubertf
3781.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
3791.172Shubertf		more recently modified in the source directories that their
3801.172Shubertf		installed counterparts.
3811.172Shubertf		Default: no
3821.172Shubertf
3831.237SmrgMKX11		If not "no", depending on the value of ${X11FLAVOUR},
3841.237Smrg		'make build' also descends into either src/x11 (XFree86) or
3851.237Smrg		src/external/mit/xorg (modular Xorg) to cross-build X11 and
3861.237Smrg		automatically enables creation of X sets.
3871.216Smrg		Default: no
3881.216Smrg
3891.251SmrgMKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
3901.251Smrg		install the X fonts.  The xfont set is still created but
3911.251Smrg		will be empty.
3921.251Smrg		Default: yes
3931.251Smrg
3941.172ShubertfMKYP		If "no", disables building of YP (NIS)
3951.172Shubertf		infrastructure (libraries and support programs).
3961.172Shubertf		Default: yes
3971.172Shubertf
3981.301SabsMKZFS		If "no", do not build and install utilities and libraries
3991.301Sabs		used to manage ZFS file system. Do not build zfs and solaris
4001.254Shaad		compatibility kernel modules.
4011.270Sriz		Default: yes on i386/amd64, no elsewhere.
4021.254Shaad
4031.298SchristosMKRUMP		If "no", do not build and install rump related headers,
4041.298Schristos		libraries, and programs.
4051.298Schristos		Default: yes
4061.298Schristos
4071.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
4081.172Shubertf		various system utilities/libraries that support it.
4091.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
4101.172Shubertf		forced to "no".
4111.172Shubertf
4121.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
4131.172Shubertf		various system utilities/libraries that support it.
4141.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
4151.172Shubertf		forced to "no".
4161.172Shubertf
4171.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
4181.197Sad		designed for improved performance with threaded
4191.197Sad		applications.  The "phkmalloc" allocator as used up
4201.197Sad		before NetBSD-5.0 will be substituted.
4211.197Sad
4221.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
4231.172Shubertf		support into various system utilities/libraries that
4241.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
4251.172Shubertf		will also be forced to "no".
4261.172Shubertf
4271.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
4281.208Slukem		system utilities/libraries that support it.
4291.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
4301.208Slukem
4311.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
4321.172Shubertf		into various system utilities/libraries that support it.
4331.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
4341.172Shubertf
4351.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
4361.172Shubertf		support into various system utilities/libraries that
4371.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4381.172Shubertf		also be forced to "no".
4391.204Slukem		Default: no
4401.172Shubertf
4411.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4421.257Stron		detects stack overflows and aborts the program. The
4431.268Snjoly		stack protection code imposes a performance penalty
4441.259Spgoyette		of about 5%.
4451.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4461.187Schristos
4471.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
4481.246Schristos		functions that do not do bounds checking regularly, but
4491.246Schristos		they could in some cases by using the gcc
4501.301Sabs		__builtin_object_size() function to determine the buffer
4511.246Schristos		size where it is known and detect buffer overflows.
4521.246Schristos		These substitute functions are in /usr/include/ssp.
4531.257Stron		Default: depends on the part of the source tree
4541.246Schristos
4551.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4561.172Shubertf		various system utilities/libraries that support it.
4571.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4581.172Shubertf
4591.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
4601.274Smrg		Otherwise, build tools/pigz and use nbpigz to compress
4611.284Smatt		things.
4621.274Smrg		Default: "no".
4631.274Smrg
4641.237SmrgX11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
4651.237Smrg		XFree86 or modular Xorg.  Only matters if MKX11!=no.
4661.242Smrg		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
4671.242Smrg		"XFree86" on everything else.
4681.237Smrg
4691.172ShubertfCOPTS.lib<lib>
4701.177SmrgOBJCOPTS.lib<lib>
4711.172ShubertfLDADD.lib<lib>
4721.172ShubertfCPPFLAGS.lib<lib>
4731.172ShubertfCXXFLAGS.lib<lib>
4741.172ShubertfCOPTS.<prog>
4751.177SmrgOBJCCOPTS.<prog>
4761.172ShubertfLDADD.<prog>
4771.172ShubertfCPPFLAGS.<prog>
4781.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
4791.172Shubertf		variables in a way that applies only to a particular library
4801.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
4811.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
4821.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
4831.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
4841.172Shubertf		the crypto library.
4851.118Slukem
4861.281SjoergThe active compiler is selected using the following variables:
4871.281SjoergAVAILABLE_COMPILER
4881.281Sjoerg		List of available compiler suites.  Processed in order
4891.281Sjoerg		for selecting the active compiler for each frontend.
4901.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
4911.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
4921.281SjoergUNSUPPORTED_COMPILER.xxx
4931.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
4941.281Sjoerg
4951.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
4961.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
4971.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
4981.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
4991.281Sjoerg
5001.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
5011.1Scgd
5021.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
5031.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
5041.1Scgd
5051.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
5061.1Scgd
5071.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
5081.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
5091.17Sthorpeja few global "feature configuration" parameters.
5101.1Scgd
5111.1ScgdIt has no targets.
5121.1Scgd
5131.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
5141.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
5151.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
5161.29Scjsis included.  These files may define any of the variables described below.
5171.17Sthorpej
5181.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
5191.17Sthorpej(defaults are in brackets):
5201.15Scgd
5211.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
5221.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
5231.98Slukem		otherwise BSDSRCDIR will be used as the default.
5241.98Slukem		Various makefiles within the NetBSD source tree will
5251.98Slukem		use this to reference the top level of the source tree.
5261.98Slukem
5271.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
5281.98Slukem		based on the presence of tools/ and build.sh.  This variable
5291.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
5301.98Slukem		determined once and then propagated to all sub-makes.
5311.95Slukem
5321.305Sapb_NETBSD_VERSION_DEPENDS
5331.305Sapb		A list of files which contain information about
5341.305Sapb		the version of the NetBSD being built.  This is
5351.305Sapb		defined only if the current directory appears
5361.305Sapb		to be inside a NetBSD source tree.  The list of
5371.305Sapb		files includes ${NETBSDSRCDIR}/sys/sys/param.h
5381.305Sapb		(which contains the kernel version number),
5391.305Sapb		${NETBSDSRCDIR}/sys/conf/newvers.sh and
5401.305Sapb		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
5411.305Sapb		interpret the information in sys/sys/param.h), and
5421.305Sapb		${_SRC_TOP_OBJ_}/params (which is an optional file,
5431.305Sapb		created by "make build" in ${_SRC_TOP_}/Makefile,
5441.305Sapb		containing all the variables that may influence the
5451.305Sapb		build).
5461.305Sapb
5471.305Sapb		Targets that depend on the NetBSD version, or on
5481.305Sapb		variables defined at build time, can declare a
5491.305Sapb		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
5501.305Sapb
5511.305Sapb			version.c: ${_NETBSD_VERSION_DEPENDS}
5521.305Sapb				commands to create version.c
5531.305Sapb
5541.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
5551.116Slukem		will work correctly.  [/usr/src]
5561.15Scgd
5571.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
5581.116Slukem		will work correctly.  [/usr/obj]
5591.15Scgd
5601.116SlukemBINGRP		Binary group.  [wheel]
5611.15Scgd
5621.116SlukemBINOWN		Binary owner.  [root]
5631.15Scgd
5641.116SlukemBINMODE		Binary mode.  [555]
5651.15Scgd
5661.116SlukemNONBINMODE	Mode for non-executable files.  [444]
5671.15Scgd
5681.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
5691.15Scgd
5701.116SlukemMANGRP		Manual group.  [wheel]
5711.15Scgd
5721.116SlukemMANOWN		Manual owner.  [root]
5731.15Scgd
5741.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
5751.15Scgd
5761.222SlukemMANINSTALL	Manual installation type.  Space separated list:
5771.222Slukem			catinstall, htmlinstall, maninstall
5781.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
5791.76Sfair
5801.76SfairLDSTATIC	Control program linking; if set blank, link everything
5811.129Slukem		dynamically.  If set to "-static", link everything statically.
5821.76Sfair		If not set, programs link according to their makefile.
5831.21Schristos
5841.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
5851.15Scgd
5861.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
5871.15Scgd
5881.116SlukemLIBGRP		Library group.  [${BINGRP}]
5891.15Scgd
5901.116SlukemLIBOWN		Library owner.  [${BINOWN}]
5911.15Scgd
5921.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
5931.15Scgd
5941.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
5951.116Slukem	        installation.  [/usr/share/doc]
5961.62Ssimonb
5971.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
5981.62Ssimonb		[/usr/share/doc/html]
5991.15Scgd
6001.116SlukemDOCGRP		Documentation group.  [wheel]
6011.15Scgd
6021.116SlukemDOCOWN		Documentation owner.  [root]
6031.15Scgd
6041.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
6051.15Scgd
6061.84SkleinkNLSDIR		Base path for Native Language Support files installation.
6071.15Scgd		[/usr/share/nls]
6081.1Scgd
6091.116SlukemNLSGRP		Native Language Support files group.  [wheel]
6101.1Scgd
6111.116SlukemNLSOWN		Native Language Support files owner.  [root]
6121.1Scgd
6131.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
6141.1Scgd
6151.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
6161.255Sapb		if that exists; otherwise /usr/xsrc]
6171.144Slukem
6181.221SmrgX11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
6191.144Slukem
6201.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
6211.144Slukem
6221.221SmrgX11SRCDIR.lib<package>
6231.221SmrgX11SRCDIR.<package>
6241.221Smrg		The path to the xorg src tree for the specificed package>.
6251.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
6261.221Smrg
6271.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
6281.221Smrg		[/usr/X11R7]
6291.144Slukem
6301.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
6311.144Slukem
6321.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
6331.144Slukem
6341.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
6351.144Slukem
6361.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
6371.144Slukem
6381.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
6391.144Slukem
6401.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
6411.144Slukem
6421.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
6431.1Scgd		to be stripped.  This is to be used when building your
6441.1Scgd		own install script so that the entire system can be made
6451.146Slukem		stripped/not-stripped using a single knob.  []
6461.1Scgd
6471.2ScgdCOPY		The flag passed to the install program to cause the binary
6481.2Scgd		to be copied rather than moved.  This is to be used when
6491.2Scgd		building our own install script so that the entire system
6501.2Scgd		can either be installed with copies, or with moves using
6511.116Slukem		a single knob.  [-c]
6521.15Scgd
6531.310SapbMAKEDIRTARGETENV
6541.310Sapb		Environment variables passed to the child make process
6551.310Sapb		invoked by MAKEDIRTARGET.
6561.310Sapb
6571.150SlukemMAKEDIRTARGET dir target [params]
6581.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
6591.150Slukem		displaying a "pretty" message whilst doing so.
6601.150Slukem
6611.152SclRELEASEMACHINEDIR
6621.152Scl		Subdirectory used below RELEASEDIR when building
6631.152Scl		a release.  [${MACHINE}]
6641.152Scl
6651.152SclRELEASEMACHINE	Subdirectory or path component used for the following
6661.152Scl		paths:
6671.152Scl			distrib/${RELEASEMACHINE}
6681.152Scl			distrib/notes/${RELEASEMACHINE}
6691.152Scl			etc/etc.${RELEASEMACHINE}
6701.152Scl		Used when building a release.  [${MACHINE}]
6711.150Slukem
6721.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
6731.214Swizmake configuration file to modify the behavior of the system build
6741.17Sthorpejprocess (default values are in brackets along with comments, if set by
6751.134Slukem<bsd.own.mk>):
6761.33Sjonathan
6771.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
6781.172Shubertf		be used as part of a build in progress.
6791.172Shubertf		Supported values:
6801.172Shubertf
6811.172Shubertf		yes	Use the tools from TOOLDIR.
6821.172Shubertf			Must be set to this if cross-compiling.
6831.172Shubertf
6841.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
6851.172Shubertf			build native compilation tool components that are
6861.172Shubertf			version-specific for that tool.
6871.172Shubertf
6881.172Shubertf		never	Do not use the tools from TOOLDIR, even when
6891.172Shubertf			building native tool components.  This is similar to
6901.172Shubertf			the traditional NetBSD build method, but does not
6911.172Shubertf			verify that the compilation tools in use are
6921.172Shubertf			up-to-date enough in order to build the tree
6931.172Shubertf			successfully.  This may cause build or runtime
6941.172Shubertf			problems when building the whole NetBSD source tree.
6951.172Shubertf
6961.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
6971.172Shubertf		source tree (detected automatically); "no" otherwise
6981.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
6991.172Shubertf		make(1) include files).
7001.142Slukem
7011.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
7021.199Ssimonb		use ELF -- currently all architectures].
7031.33Sjonathan
7041.103SthorpejTOOLCHAIN_MISSING
7051.142Slukem		If not "no", this indicates that the platform being built
7061.103Sthorpej		does not have a working in-tree toolchain.  If the
7071.142Slukem		${MACHINE_ARCH} in question falls into this category,
7081.301Sabs		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
7091.103Sthorpej		Otherwise, the variable is unconditionally assigned the
7101.103Sthorpej		value "no".
7111.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
7121.142Slukem		unconditionally assigned the value "no".
7131.103Sthorpej
7141.103SthorpejEXTERNAL_TOOLCHAIN
7151.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
7161.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
7171.103Sthorpej		access to this variable.  The variable should be defined
7181.103Sthorpej		either in the user's environment or in the user's mk.conf
7191.103Sthorpej		file.  If defined, this variable indicates the root of
7201.103Sthorpej		an external toolchain which will be used to build the
7211.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
7221.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
7231.103Sthorpej		cross-compile framework.
7241.103Sthorpej
7251.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
7261.142Slukem		assigned the value "no", since the external version of the
7271.142Slukem		compiler may not be able to build the library components of
7281.142Slukem		the in-tree compiler.
7291.103Sthorpej
7301.103Sthorpej		NOTE: This variable is not yet used in as many places as
7311.103Sthorpej		it should be.  Expect the exact semantics of this variable
7321.103Sthorpej		to change in the short term as parts of the cross-compile
7331.103Sthorpej		framework continue to be cleaned up.
7341.1Scgd
7351.236SapbThe following variables are defined to commands to perform the
7361.236Sapbappropriate operation, with the default in [brackets].  Note that
7371.236Sapbthe defaults change if USETOOLS == "yes":
7381.236Sapb
7391.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
7401.236Sapb
7411.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
7421.236Sapb
7431.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
7441.236Sapb
7451.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
7461.236Sapb
7471.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
7481.236Sapb
7491.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
7501.236Sapb
7511.236SapbTOOL_CAT		Concatenate and print files.  [cat]
7521.236Sapb
7531.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
7541.236Sapb
7551.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
7561.236Sapb
7571.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
7581.236Sapb
7591.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
7601.236Sapb
7611.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
7621.236Sapb
7631.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
7641.236Sapb
7651.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
7661.236Sapb
7671.236SapbTOOL_EQN		Format equations for groff.  [eqn]
7681.236Sapb
7691.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
7701.236Sapb
7711.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
7721.236Sapb
7731.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
7741.236Sapb
7751.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
7761.236Sapb
7771.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
7781.236Sapb
7791.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
7801.247Ssketch
7811.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
7821.236Sapb
7831.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
7841.236Sapb
7851.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
7861.236Sapb
7871.236SapbTOOL_HP700MKBOOT	Make bootable image for hp700.  [hp700-mkboot]
7881.236Sapb
7891.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
7901.236Sapb
7911.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
7921.236Sapb
7931.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
7941.236Sapb
7951.236SapbTOOL_JOIN		Relational database operator.  [join]
7961.236Sapb
7971.236SapbTOOL_M4			M4 macro language processor.  [m4]
7981.236Sapb
7991.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
8001.236Sapb
8011.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
8021.236Sapb
8031.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
8041.236Sapb
8051.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
8061.236Sapb
8071.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
8081.236Sapb
8091.236SapbTOOL_MENUC		Menu compiler.  [menuc]
8101.236Sapb
8111.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
8121.236Sapb			[mips-elf2ecoff]
8131.236Sapb
8141.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
8151.236Sapb
8161.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
8171.236Sapb
8181.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
8191.236Sapb
8201.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
8211.236Sapb
8221.311SjmcneillTOOL_MKNOD		Make device special file.  [mknod]
8231.311Sjmcneill
8241.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
8251.236Sapb
8261.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
8271.236Sapb
8281.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
8291.236Sapb
8301.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
8311.236Sapb
8321.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
8331.236Sapb
8341.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
8351.273Smrg
8361.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
8371.236Sapb
8381.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
8391.236Sapb
8401.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
8411.236Sapb
8421.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
8431.236Sapb
8441.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
8451.236Sapb
8461.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
8471.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
8481.236Sapb
8491.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
8501.236Sapb
8511.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
8521.236Sapb
8531.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
8541.236Sapb
8551.236SapbTOOL_SED		Stream editor.  [sed]
8561.236Sapb
8571.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
8581.236Sapb
8591.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
8601.236Sapb			[sparkcrc]
8611.236Sapb
8621.236SapbTOOL_STAT		Display file status.  [stat]
8631.236Sapb
8641.236SapbTOOL_STRFILE		Create a random access file for storing strings.
8651.236Sapb			[strfile]
8661.236Sapb
8671.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
8681.236Sapb
8691.236SapbTOOL_TBL		Format tables for groff.  [tbl]
8701.236Sapb
8711.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
8721.236Sapb
8731.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
8741.236Sapb
8751.236SapbTOOL_ZIC		Time zone compiler.  [zic]
8761.236Sapb
8771.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
8781.1Scgdthey use the same default owners etc. as the rest of the tree.
8791.131Slukem
8801.131Slukem
8811.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
8821.286Sapb
8831.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
8841.286Sapbtargets.  It uses the following variables:
8851.286Sapb
8861.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
8871.286Sapb
8881.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
8891.286Sapb		the clean target.
8901.286Sapb
8911.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
8921.287Sapb		will delete files from both the object directory,
8931.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
8941.287Sapb
8951.287Sapb		If MKCLEANSRC is set to "no", then the file names in
8961.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
8971.287Sapb		to the object directory, ${.OBJDIR}.  This is the
8981.287Sapb		traditional behaviour.
8991.287Sapb
9001.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
9011.287Sapb		is performed relative to both the object directory,
9021.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
9031.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
9041.287Sapb		Deleting files from ${.CURDIR} is intended to remove
9051.287Sapb		stray output files that had been left in the source
9061.287Sapb		directory by an earlier build that did not use object
9071.287Sapb		directories.
9081.287Sapb
9091.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
9101.287Sapb		separate object directories, and you are sure that there
9111.287Sapb		are no stray files in the source directories, then you
9121.287Sapb		may set MKCLEANSRC=no to save some time.
9131.287Sapb
9141.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
9151.287Sapb		will verify that files have been deleted.
9161.287Sapb
9171.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
9181.287Sapb		be deleted using a "rm -f" command, and its success or
9191.287Sapb		failure will be ignored.
9201.287Sapb
9211.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
9221.287Sapb		the "rm -f" command will be verified using an "ls"
9231.287Sapb		command.
9241.287Sapb
9251.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
9261.287Sapb		there will be no problems caused by file permissions,
9271.287Sapb		read-only file systems, or the like, then you may set
9281.287Sapb		MKCLEANVERIFY=no to save some time.
9291.286Sapb
9301.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
9311.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
9321.286Sapbor CLEANDIRFILES variables.  For example:
9331.286Sapb
9341.286Sapb	    CLEANFILES+= a.out
9351.286Sapb	    CLEANDIRFILES+= .depend
9361.286Sapb
9371.286Sapb	    .include <bsd.clean.mk>
9381.286Sapb
9391.308SapbThe files listed in CLEANFILES and CLEANDIRFILES must not be
9401.308Sapbdirectories, because the potential risk from running "rm -rf" commands
9411.308Sapbin bsd.clean.mk is considered too great.  If you want to recursively
9421.308Sapbdelete a directory as part of "make clean" or "make cleandir" then you
9431.308Sapbneed to provide your own target.
9441.286Sapb
9451.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
9461.131Slukem
9471.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
9481.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
9491.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
9501.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
9511.133Slukemdependencies for the .d files.  In order for this to function correctly,
9521.132Slukemit should be .included after all other .mk files and directives that may
9531.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
9541.132Slukem
9551.132SlukemSRCS		List of source files to build the program.
9561.132Slukem
9571.132SlukemDPSRCS		List of source files which are needed for generating
9581.132Slukem		dependencies, but are not needed in ${SRCS}.
9591.1Scgd
9601.1Scgd
9611.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
9621.106Sthorpej
9631.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
9641.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
9651.124Slukem
9661.124SlukemFILES		The list of files to install.
9671.124Slukem
9681.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
9691.153Slukem		are installed by the `configinstall' target,
9701.153Slukem		not the `install' target.
9711.153Slukem		The FILES* variables documented below also apply.
9721.153Slukem
9731.124SlukemFILESOWN	File owner.  [${BINOWN}]
9741.124Slukem
9751.124SlukemFILESGRP	File group.  [${BINGRP}]
9761.124Slukem
9771.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
9781.124Slukem
9791.124SlukemFILESDIR	The location to install the files.
9801.124Slukem
9811.124SlukemFILESNAME	Optional name to install each file as.
9821.124Slukem
9831.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
9841.153Slukem
9851.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
9861.153Slukem
9871.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
9881.153Slukem
9891.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
9901.153Slukem
9911.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
9921.124Slukem
9931.285SapbFILESBUILD	If this variable is defined, then its value will be
9941.285Sapb		used as the default for all FILESBUILD_<fn> variables.
9951.285Sapb		Otherwise, the default will be "no".
9961.285Sapb
9971.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
9981.243Scube		targets to be built by `realall'.  Users of that variable
9991.243Scube		should provide a target to build the file.
10001.243Scube
10011.135Slukem
10021.139SlukemBUILDSYMLINKS	List of two word items:
10031.135Slukem			lnsrc lntgt
10041.135Slukem		For each lnsrc item, create a symlink named lntgt.
10051.135Slukem		The lntgt symlinks are removed by the cleandir target.
10061.106Sthorpej
10071.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
10081.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
10091.301Sabs		The source files have a `.uue' suffix, the generated files do
10101.148Sjmc		not.
10111.149Sjmc
10121.202SuweUUDECODE_FILES_RENAME_<fn>
10131.202Suwe		Rename the output from the decode to the provided name.
10141.148Sjmc		
10151.148Sjmc		*NOTE: These files are simply decoded, with no install or other
10161.148Sjmc		       rule applying implicitly except being added to the clean
10171.148Sjmc		       target.
10181.106Sthorpej
10191.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
10201.113Sthorpej
10211.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
10221.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
10231.134Slukembefore <bsd.gcc.mk>.
10241.113Sthorpej
10251.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
10261.113Sthorpejof which need to know where to find certain GCC support libraries.
10271.113Sthorpej
10281.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
10291.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
10301.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
10311.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
10321.113Sthorpej
10331.134Slukem<bsd.gcc.mk> sets the following variables:
10341.113Sthorpej
10351.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
10361.118Slukem
10371.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
10381.118Slukem
10391.118Slukem_GCC_CRTEND	The full path name to crtend.o.
10401.118Slukem
10411.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
10421.118Slukem
10431.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
10441.118Slukem
10451.118Slukem
10461.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
10471.118Slukem
10481.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
10491.118Slukemvariables:
10501.118Slukem
10511.124SlukemINCS		The list of include files.
10521.118Slukem
10531.118SlukemINCSDIR		The location to install the include files.
10541.118Slukem
10551.118SlukemINCSNAME	Target name of the include file, if only one; same as
10561.118Slukem		FILESNAME, but for include files.
10571.118Slukem
10581.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
10591.134Slukem		are installed in the 'includes' target and not the
10601.134Slukem		(much later) 'install' target.
10611.134Slukem
10621.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
10631.118Slukem		same as FILESNAME_<file>, but for include files.
10641.118Slukem
10651.118Slukem
10661.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
10671.118Slukem
10681.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
10691.118Slukemdocumentation from respective Texinfo source files.  It defines three
10701.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
10711.118Slukemfollowing variables:
10721.118Slukem
10731.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
10741.118Slukem		consist of single files with the extension replaced by
10751.118Slukem		.info.
10761.118Slukem
10771.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
10781.118Slukem
10791.118Slukem
10801.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
10811.118Slukem
10821.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
10831.118Slukemlocation of kernel sources and object directories.
10841.118Slukem
10851.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
10861.124Slukem		[${_SRC_TOP_}/sys]
10871.118Slukem
10881.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
10891.124Slukem		[arch/${MACHINE}]
10901.120Slukem
10911.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
10921.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
10931.118Slukem
10941.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
10951.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
10961.118Slukem		The default value is
10971.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
10981.118Slukem		if it exists or the target 'obj' is being made.
10991.118Slukem		Otherwise the default is
11001.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
11011.118Slukem
11021.118SlukemIt is important that Makefiles (such as those under src/distrib) that
11031.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
11041.118Slukemrather than make assumptions about the location of the compiled kernel.
11051.118Slukem
11061.118Slukem
11071.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
11081.118Slukem
11091.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
11101.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
11111.118Slukeminclude file installation.  It is intended to be included alone, by
11121.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
11131.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
11141.134Slukemin that file up to date.
11151.118Slukem
11161.118Slukem
11171.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
11181.118Slukem
11191.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
11201.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
11211.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
11221.118Slukemwhich checks for installed shared object libraries whose version is greater
11231.118Slukemthat the version of the source. It has a limited number of suffixes,
11241.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
11251.118Slukem<bsd.shlib.mk> to get shared library parameters.
11261.118Slukem
11271.118SlukemIt sets/uses the following variables:
11281.118Slukem
11291.118SlukemLIB		The name of the library to build.
11301.118Slukem
11311.118SlukemLIBDIR		Target directory for libraries.
11321.118Slukem
11331.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
11341.248Sperry		permissions in files inside its archives to those of
11351.248Sperry		the file it was fed. This leads to non-reproduceable
11361.248Sperry		builds. If MKARZERO is set to "yes" (default is "no")
11371.248Sperry		then the "D" flag is passed to ar, causing the
11381.248Sperry		timestamp, uid and gid to be zeroed and the file
11391.248Sperry		permissions to be set to 644. This allows .a files
11401.248Sperry		from different builds to be bit identical.
11411.248Sperry
11421.300SjoergSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
11431.300Sjoerg		is not "no".
11441.300Sjoerg
11451.263SabsSHLIB_MAJOR
11461.263SabsSHLIB_MINOR
11471.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
11481.263Sabs
11491.300SjoergUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
11501.118Slukem		as the path to install shared libraries to.
11511.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
11521.130Slukem		Default: no
11531.118Slukem
11541.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
11551.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
11561.218Slukem		MKPROFILE=no MKSTATICLIB=no".
11571.218Slukem		Default: no
11581.218Slukem
11591.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
11601.211Slukem		MKPROFILE=no", and don't install the (.a) library.
11611.154Slukem		This is useful for "build only" helper libraries.
11621.154Slukem		Default: no
11631.154Slukem
11641.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
11651.244Smrg		shared libraries.
11661.244Smrg		This is useful for C++ libraries.
11671.244Smrg		Default: no
11681.244Smrg
11691.118SlukemLINTLIBDIR	Target directory for lint libraries.
11701.118Slukem
11711.118SlukemLIBGRP		Library group.
11721.118Slukem
11731.118SlukemLIBOWN		Library owner.
11741.118Slukem
11751.118SlukemLIBMODE		Library mode.
11761.118Slukem
11771.118SlukemLDADD		Additional loader objects.
11781.118Slukem
11791.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
11801.118Slukem
11811.118SlukemNOCHECKVER_<library>
11821.118SlukemNOCHECKVER	If set, disables checking for installed shared object
11831.118Slukem		libraries with versions greater than the source.  A
11841.118Slukem		particular library name, without the "lib" prefix, may
11851.118Slukem		be appended to the variable name to disable the check for
11861.118Slukem		only that library.
11871.118Slukem
11881.118SlukemSRCS		List of source files to build the library.  Suffix types
11891.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
11901.118Slukem		to .c files of the same name.  (This is not the default for
11911.118Slukem		versions of make.)
11921.118Slukem
11931.157SlukemLIBDPLIBS	A list of the tuples:
11941.157Slukem			libname  path-to-srcdir-of-libname
11951.157Slukem
11961.157Slukem		For each tuple;
11971.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
11981.157Slukem			`libname', and if it is not set it is determined
11991.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
12001.157Slukem			latter is to allow for build time optimization).
12011.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
12021.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
12031.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
12041.157Slukem
12051.307Spooka		The special value "_external" for LIBDO.lib makes the
12061.307Spooka		build system to assume the library comes from outside
12071.307Spooka		of the NetBSD source tree and only causes -llibname
12081.307Spooka		to be added to LDADD.
12091.307Spooka
12101.157Slukem		This variable may be used for individual libraries, as
12111.301Sabs		well as in parent directories to cache common libraries
12121.157Slukem		as a build-time optimization.
12131.157Slukem
12141.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
12151.118Slukemif it exists, as well as the include file <bsd.man.mk>.
12161.118Slukem
12171.118SlukemIt has rules for building profiled objects; profiled libraries are
12181.118Slukembuilt by default.
12191.118Slukem
12201.118SlukemLibraries are ranlib'd when made.
12211.118Slukem
12221.118Slukem
12231.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
12241.118Slukem
12251.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
12261.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
12271.134Slukem
12281.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
12291.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
12301.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
12311.249Sapbby a method for explicitly recording hard links in a metadata log.
12321.249Sapb
12331.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
12341.134Slukem			source-file target-file
12351.134Slukem		${DESTDIR} is prepended to both paths before linking.
12361.134Slukem		For example, to link /bin/test and /bin/[, use:
12371.134Slukem			LINKS=/bin/test /bin/[
12381.134Slukem
12391.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
12401.153Slukem		are installed by the `configinstall' target,
12411.153Slukem		not the `install' target.
12421.153Slukem
12431.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
12441.134Slukem			source-file target-file
12451.134Slukem		${DESTDIR} is only prepended to target-file before linking.
12461.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
12471.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
12481.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
12491.118Slukem
12501.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
12511.153Slukem		are installed by the `configinstall' target,
12521.153Slukem		not the `install' target.
12531.153Slukem
12541.249SapbLINKSOWN	Link owner.  [${BINOWN}]
12551.249Sapb
12561.249SapbLINKSGRP	Link group.  [${BINGRP}]
12571.249Sapb
12581.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
12591.249Sapb
12601.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
12611.249Sapb
12621.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
12631.249Sapb
12641.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
12651.249Sapb
12661.118Slukem
12671.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
12681.118Slukem
12691.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
12701.118Slukemlinks.
12711.118Slukem
12721.222SlukemIt has a three targets:
12731.118Slukem
12741.222Slukem	catinstall:
12751.222Slukem		Install the preformatted manual pages and their links.
12761.222Slukem	htmlinstall:
12771.222Slukem		Install the HTML manual pages and their links.
12781.118Slukem	maninstall:
12791.118Slukem		Install the manual page sources and their links.
12801.118Slukem
12811.118SlukemIt sets/uses the following variables:
12821.118Slukem
12831.118SlukemMANDIR		Base path for manual installation.
12841.118Slukem
12851.118SlukemMANGRP		Manual group.
12861.118Slukem
12871.118SlukemMANOWN		Manual owner.
12881.118Slukem
12891.118SlukemMANMODE		Manual mode.
12901.118Slukem
12911.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
12921.118Slukem		or "/tahoe" for machine specific manual pages.
12931.118Slukem
12941.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12951.118Slukem
12961.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
12971.118Slukem		linked-to file must come first, the linked file second,
12981.276Sreed		and there may be multiple pairs.
12991.118Slukem
13001.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
13011.118Slukemit exists.
13021.118Slukem
13031.118Slukem
13041.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
13051.118Slukem
13061.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
13071.118Slukemand use of separated object and source directories.
13081.118Slukem
13091.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
13101.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
13111.118Slukemit exists.  Otherwise make(1) looks for the existence of a
13121.118Slukemsubdirectory (or a symlink to a directory) of the source directory
13131.118Slukeminto which built targets should be placed.  If an environment variable
13141.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
13151.118Slukemobject directory; failing that, make first looks for a subdirectory
13161.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
13171.118Slukem
13181.118SlukemObject directories are not created automatically by make(1) if they
13191.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
13201.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
13211.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
13221.118Slukemand this is determined by a simple string prefix comparison -- object
13231.118Slukemdirectories are created in a separate object directory tree, and a
13241.118Slukemsymlink to the object directory in that tree is created in the source
13251.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
13261.118Slukemsource tree and that it's not safe to use a separate object tree.
13271.118Slukem
13281.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
13291.118Slukemdirectories and links get created during a "make obj":
13301.118Slukem
13311.118SlukemMAKEOBJDIR	If set, this is the component name of the object
13321.118Slukem		directory.
13331.118Slukem
13341.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
13351.118Slukem		object directories or links named "obj.${MACHINE}";
13361.118Slukem		otherwise, just creates ones named "obj".
13371.118Slukem
13381.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
13391.118Slukem		${BSDSRCDIR}, create object directory in the
13401.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
13411.118Slukem		otherwise, create it in the corresponding subdirectory
13421.118Slukem		of ${BSDOBJDIR}
13431.113Sthorpej
13441.118SlukemBUILDID		If set, the contents of this variable are appended
13451.118Slukem		to the object directory name.  If OBJMACHINE is also
13461.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
13471.113Sthorpej
13481.106Sthorpej
13491.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
13501.106Sthorpej
13511.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
13521.1Scgdmore source files, along with their manual pages.  It has a limited number
13531.301Sabsof suffixes, consistent with the current needs of the BSD tree.
13541.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
13551.1Scgd
13561.16SjtcIt has eight targets:
13571.1Scgd
13581.1Scgd	all:
13591.102Sthorpej		build the program and its manual page.  This also
13601.102Sthorpej		creates a GDB initialization file (.gdbinit) in
13611.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
13621.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
13631.1Scgd	clean:
13641.1Scgd		remove the program, any object files and the files a.out,
13651.24Smikel		Errs, errs, mklog, and ${PROG}.core.
13661.1Scgd	cleandir:
13671.1Scgd		remove all of the files removed by the target clean, as
13681.1Scgd		well as .depend, tags, and any manual pages.
13691.42Slukem		`distclean' is a synonym for `cleandir'.
13701.1Scgd	depend:
13711.1Scgd		make the dependencies for the source files, and store
13721.1Scgd		them in the file .depend.
13731.16Sjtc	includes:
13741.16Sjtc		install any header files.
13751.1Scgd	install:
13761.1Scgd		install the program and its manual pages; if the Makefile
13771.1Scgd		does not itself define the target install, the targets
13781.1Scgd		beforeinstall and afterinstall may also be used to cause
13791.1Scgd		actions immediately before and after the install target
13801.1Scgd		is executed.
13811.1Scgd	lint:
13821.1Scgd		run lint on the source files
13831.1Scgd	tags:
13841.1Scgd		create a tags file for the source files.
13851.1Scgd
13861.1ScgdIt sets/uses the following variables:
13871.1Scgd
13881.1ScgdBINGRP		Binary group.
13891.1Scgd
13901.1ScgdBINOWN		Binary owner.
13911.1Scgd
13921.1ScgdBINMODE		Binary mode.
13931.1Scgd
13941.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
13951.286Sapb
13961.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
13971.1Scgd
13981.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
13991.112Sthorpej
14001.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
14011.125Slukem		C objects for <fn>.
14021.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14031.125Slukem
14041.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
14051.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
14061.35Slukem
14071.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
14081.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14091.125Slukem
14101.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
14111.125Slukem
14121.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
14131.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14141.102Sthorpej
14151.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
14161.102Sthorpej		directives in the .gdbinit file that is created in the
14171.102Sthorpej		objdir.
14181.1Scgd
14191.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
14201.1Scgd		For example, to load with the compatibility and utility
14211.1Scgd		libraries, use:
14221.1Scgd
14231.5Sjtc			LDADD+=-lutil -lcompat
14241.1Scgd
14251.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
14261.1Scgd
14271.134SlukemLINKS		See <bsd.links.mk>
14281.134Slukem
14291.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
14301.177Smrg
14311.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
14321.177Smrg		ObjC objects for <fn>.
14331.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
14341.177Smrg
14351.134SlukemSYMLINKS	See <bsd.links.mk>
14361.1Scgd
14371.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
14381.8Scgd		defined, "MAN=${PROG}.1" is assumed.
14391.1Scgd
14401.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
14411.212Slukem		time, with the value of this variable as args to paxctl(1).
14421.193Sperry
14431.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
14441.193Sperry
14451.1ScgdPROG		The name of the program to build.  If not supplied, nothing
14461.1Scgd		is built.
14471.1Scgd
14481.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
14491.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
14501.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
14511.88Sthorpej		the value of PROG if PROG is also set.
14521.87Sthorpej
14531.21SchristosPROGNAME	The name that the above program will be installed as, if
14541.21Schristos		different from ${PROG}.
14551.21Schristos
14561.37StvSRCS		List of source files to build the program.  If SRCS is not
14571.1Scgd		defined, it's assumed to be ${PROG}.c.
14581.108Sjwise
14591.108SjwiseDPSRCS		List of source files which are needed for generating
14601.108Sjwise		dependencies, but are not needed in ${SRCS}.
14611.1Scgd
14621.1ScgdDPADD		Additional dependencies for the program.  Usually used for
14631.1Scgd		libraries.  For example, to depend on the compatibility and
14641.1Scgd		utility libraries use:
14651.1Scgd
14661.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
14671.1Scgd
14681.288Schristos		The following system libraries are predefined for DPADD:
14691.1Scgd
14701.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
14711.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
14721.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
14731.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
14741.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
14751.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
14761.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
14771.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
14781.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
14791.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
14801.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
14811.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
14821.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
14831.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
14841.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
14851.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
14861.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
14871.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
14881.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
14891.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
14901.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
14911.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
14921.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
14931.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
14941.315Schristos		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
14951.315Schristos		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
14961.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
14971.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
14981.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
14991.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
15001.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
15011.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
15021.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
15031.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
15041.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
15051.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
15061.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
15071.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
15081.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
15091.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
15101.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
15111.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
15121.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
15131.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
15141.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
15151.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
15161.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
15171.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
15181.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
15191.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
15201.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
15211.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
15221.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
15231.313Sjmmv		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
15241.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
15251.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
15261.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
15271.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
15281.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
15291.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
15301.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
15311.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
15321.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
15331.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
15341.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
15351.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
15361.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
15371.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
15381.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
15391.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
15401.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
15411.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
15421.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
15431.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
15441.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
15451.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
15461.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
15471.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
15481.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
15491.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
15501.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
15511.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
15521.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
15531.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
15541.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
15551.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
15561.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
15571.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
15581.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
15591.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
15601.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
15611.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
15621.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
15631.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
15641.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
15651.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
15661.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
15671.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
15681.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
15691.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
15701.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
15711.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
15721.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
15731.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
15741.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
15751.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
15761.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
15771.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
15781.1Scgd
15791.288Schristos		The following X-Windows libraries are predefined for DPADD:
15801.288Schristos
15811.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
15821.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
15831.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
15841.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
15851.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
15861.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
15871.317Smrg		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
15881.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
15891.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
15901.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
15911.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
15921.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
15931.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
15941.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
15951.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
15961.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
15971.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
15981.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
15991.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
16001.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
16011.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
16021.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
16031.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
16041.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
16051.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
16061.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
16071.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
16081.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
16091.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
16101.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
16111.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
16121.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
16131.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
16141.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
16151.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
16161.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
16171.288Schristos
16181.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
16191.12Schristos		strings, using xstr(1). Note that this will not work with
16201.12Schristos		parallel makes.
16211.1Scgd
16221.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
16231.1Scgd		to be stripped.
16241.1Scgd
16251.1ScgdSUBDIR		A list of subdirectories that should be built as well.
16261.1Scgd		Each of the targets will execute the same target in the
16271.1Scgd		subdirectories.
16281.1Scgd
16291.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
16301.21Schristos		These are installed exactly like programs.
16311.21Schristos
16321.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
16331.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
16341.166Srtr
16351.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
16361.21Schristos		different from ${SCRIPTS}. These can be further specialized
16371.21Schristos		by setting SCRIPTSNAME_<script>.
16381.21Schristos
16391.124SlukemFILES		See description of <bsd.files.mk>.
16401.21Schristos
16411.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
16421.106Sthorpej		<bsd.own.mk> for additional information about this variable.
16431.130Slukem
16441.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
16451.1Scgdif it exists, as well as the include file <bsd.man.mk>.
16461.1Scgd
16471.1ScgdSome simple examples:
16481.1Scgd
16491.1ScgdTo build foo from foo.c with a manual page foo.1, use:
16501.1Scgd
16511.1Scgd	PROG=	foo
16521.1Scgd
16531.1Scgd	.include <bsd.prog.mk>
16541.1Scgd
16551.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
16561.1Scgd
16571.9Scgd	MAN=	foo.2
16581.1Scgd
16591.1ScgdIf foo does not have a manual page at all, add the line:
16601.1Scgd
16611.75Sagc	MKMAN=	no
16621.1Scgd
16631.1ScgdIf foo has multiple source files, add the line:
16641.1Scgd
16651.1Scgd	SRCS=	a.c b.c c.c d.c
16661.1Scgd
16671.1Scgd
16681.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
16691.118Slukem
16701.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
16711.118Slukemconstruct source files built by rpcgen.
16721.72Ssommerfe
16731.118SlukemThe following macros may be defined in makefiles which include
16741.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
16751.118Slukemare to be built:
16761.21Schristos
16771.118SlukemRPC_INCS:	construct .h file from .x file
16781.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
16791.118Slukem		(for marshalling/unmarshalling data types)
16801.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
16811.118Slukem		(server-side stubs)
16821.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
16831.21Schristos
16841.118SlukemRPC_XDIR:	Directory containing .x/.h files
16851.23Schristos
16861.23Schristos
16871.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
16881.21Schristos
16891.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
16901.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
16911.134Slukemincluded before <bsd.shlib.mk>.
16921.21Schristos
16931.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
16941.118Slukem(defaults are in brackets):
16951.21Schristos
16961.300SjoergSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
16971.300Sjoerg		instead of ${LIBDIR} as the base path for shared library
16981.300Sjoerg		installation.  [/lib]
16991.300Sjoerg
17001.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
17011.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
17021.118Slukem		for all others.]
17031.81Swiz
17041.300Sjoerg_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
17051.118Slukem		otherwise set to ${LIBDIR}
17061.81Swiz
17071.300SjoergSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
17081.300Sjoerg
17091.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
17101.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
17111.118Slukem		all others.]
17121.39Scgd
17131.13Schristos
17141.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
17151.13Schristos
17161.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
17171.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
17181.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
17191.233Sapbfollowing variables:
17201.233Sapb
17211.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
17221.233Sapb		will be ignored and subdirectories will not be processed.
17231.233Sapb
17241.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
17251.233Sapb		specified directory will be visited and the target made.
17261.233Sapb
17271.233Sapb		As a special case, the use of a token .WAIT as an
17281.233Sapb		entry in SUBDIR acts as a synchronization barrier
17291.233Sapb		when multiple make jobs are run; subdirs before the
17301.233Sapb		.WAIT must complete before any subdirs after .WAIT are
17311.233Sapb		started.  See make(1) for some caveats on use of .WAIT
17321.233Sapb		and other special sources.
17331.47Stv
17341.47Stv
17351.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
17361.47Stv
17371.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
17381.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
17391.133Slukemthe NetBSD source tree.
17401.133Slukem
17411.133SlukemThe following variables control how various files are compiled/built.
17421.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
17431.133Slukem
17441.133SlukemAR		Create, modify, and extract from archives.  [ar]
17451.133Slukem
17461.133SlukemARFLAGS		Options to ${AR}.  [rl]
17471.133Slukem
17481.151SlukemAS		Assembler.  [as]
17491.151Slukem
17501.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
17511.211Slukem		assembly source files.  []
17521.151Slukem
17531.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
17541.217Sjoerg		If this option is present, seed the random number
17551.217Sjoerg		generator based on the value, source file names and
17561.217Sjoerg		the output file name to make builds more deterministic.
17571.217Sjoerg		Additional information is available in the GCC
17581.217Sjoerg		documentation of -frandom-seed.
17591.217Sjoerg
17601.133SlukemCC		C compiler.  [cc]
17611.133Slukem
17621.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
17631.133Slukem
17641.133SlukemCPP		C Pre-Processor.  [cpp]
17651.133Slukem
17661.133SlukemCPPFLAGS	Options to ${CPP}.  []
17671.133Slukem
17681.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
17691.133Slukem
17701.133SlukemCXX		C++ compiler.  [c++]
17711.133Slukem
17721.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
17731.133Slukem
17741.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
17751.133Slukem
17761.133SlukemFC		Fortran compiler.  [f77]
17771.133Slukem
17781.133SlukemFFLAGS		Options to {$FC}.  [-O]
17791.133Slukem
17801.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
17811.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
17821.235Sapb
17831.133SlukemINSTALL		install(1) command.  [install]
17841.133Slukem
17851.133SlukemLEX		Lexical analyzer.  [lex]
17861.133Slukem
17871.133SlukemLFLAGS		Options to ${LEX}.  []
17881.133Slukem
17891.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
17901.145Sjwise
17911.133SlukemLD		Linker.  [ld]
17921.133Slukem
17931.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
17941.133Slukem
17951.133SlukemLINT		C program verifier.  [lint]
17961.133Slukem
17971.173SperryLINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
17981.133Slukem
17991.133SlukemLORDER		List dependencies for object files.  [lorder]
18001.133Slukem
18011.133SlukemMAKE		make(1).  [make]
18021.133Slukem
18031.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
18041.133Slukem
18051.133SlukemNM		List symbols from object files.  [nm]
18061.133Slukem
18071.133SlukemPC		Pascal compiler.  [pc]  (Not present)
18081.133Slukem
18091.133SlukemPFLAGS		Options to ${PC}.  []
18101.133Slukem
18111.133SlukemOBJC		Objective C compiler.  [${CC}]
18121.133Slukem
18131.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
18141.133Slukem
18151.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
18161.133Slukem
18171.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
18181.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
18191.291Schristos
18201.168SrizOBJDUMP		Display information from object files.  [objdump]
18211.168Sriz
18221.133SlukemRANLIB		Generate index to archive.  [ranlib]
18231.133Slukem
18241.133SlukemSIZE		List section sizes and total size.  [size]
18251.133Slukem
18261.133SlukemSTRIP		Discard symbols from object files.  [strip]
18271.133Slukem
18281.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
18291.133Slukem
18301.133SlukemYACC		LALR(1) parser generator.  [yacc]
18311.133Slukem
18321.133SlukemYFLAGS		Options to ${YACC}.  []
18331.133Slukem
18341.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
18351.133Slukem		from <file>.y to <file>.h and <file>.c, and add
18361.133Slukem		<foo>.h to CLEANFILES.
18371.133Slukem
18381.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
18391.133Slukem
18401.116Slukem
18411.69SsommerfeOther variables of note (incomplete list):
18421.69Ssommerfe
18431.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
18441.213Slukem		that cause warnings to be fatal, such as:
18451.213Slukem			-Werror -Wa,--fatal-warnings
18461.213Slukem		(The latter being for as(1).)
18471.212Slukem
18481.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
18491.283Sjoerg		passed to it.
18501.283Sjoerg
18511.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
18521.82Slukem			WARNS=1
18531.82Slukem			WARNS=2
18541.82Slukem			WARNS=3
18551.164Smatt			WARNS=4
18561.296Splunky			WARNS=5
18571.69Ssommerfe
18581.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
18591.144Slukem
18601.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
18611.221Smrgcross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
18621.144SlukemIt should be included after the general Makefile contents but before
18631.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
18641.144Slukem
18651.144SlukemIt provides the following targets:
18661.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
18671.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
18681.221Smrg		these rules convert from X11's manual page source
18691.144Slukem		into an mdoc.old source file.
18701.144Slukem
18711.144SlukemIt sets the following variables:
18721.144Slukem
18731.144SlukemBINDIR			Set to ${X11BINDIR}.
18741.144Slukem			To override, define after including <bsd.x11.mk>
18751.144Slukem
18761.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
18771.144Slukem			To override, define after including <bsd.x11.mk>
18781.144Slukem
18791.144SlukemMANDIR			Set to ${X11MANDIR}.
18801.144Slukem			To override, define after including <bsd.x11.mk>
18811.144Slukem
18821.144SlukemCPPFLAGS		Appended with definitions to include from
18831.144Slukem			${DESTDIR}${X11INCDIR}
18841.144Slukem
18851.144SlukemLDFLAGS			Appended with definitions to link from
18861.144Slukem			${DESTDIR}${X11USRLIBDIR}
18871.144Slukem
18881.221SmrgX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
18891.144Slukem
18901.221SmrgX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
18911.144Slukem
18921.221SmrgX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
18931.144Slukem
18941.221SmrgX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
18951.144Slukem
18961.221SmrgX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
18971.144Slukem
18981.221SmrgX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18991.144Slukem
19001.221SmrgX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
19011.144Slukem
19021.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
19031.144Slukem
19041.221SmrgX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
19051.221Smrg
19061.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
19071.144Slukem
19081.144SlukemIt uses the following variables:
19091.144Slukem
19101.144SlukemAPPDEFS			List of app-default files to install.
19111.144Slukem
19121.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
19131.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
19141.144Slukem			have a `.cpp' suffix, the generated files do not.
19151.144Slukem
19161.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
19171.144Slukem
19181.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
19191.144Slukem
19201.144Slukem
19211.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1922