bsd.README revision 1.347
11.347Schristos#	$NetBSD: bsd.README,v 1.347 2015/11/07 23:53:28 christos Exp $
21.24Smikel#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
31.1Scgd
41.213SlukemThis is the README file for the make "include" files for the NetBSD
51.213Slukemsource tree.  The files are installed in /usr/share/mk, and are,
61.213Slukemby convention, named with the suffix ".mk".
71.1Scgd
81.1ScgdNote, this file is not intended to replace reading through the .mk
91.1Scgdfiles for anything tricky.
101.1Scgd
111.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
121.1Scgd
131.1ScgdRANDOM THINGS WORTH KNOWING:
141.1Scgd
151.1ScgdThe files are simply C-style #include files, and pretty much behave like
161.1Scgdyou'd expect.  The syntax is slightly different in that a single '.' is
171.1Scgdused instead of the hash mark, i.e. ".include <bsd.prog.mk>".
181.1Scgd
191.1ScgdOne difference that will save you lots of debugging time is that inclusion
201.1Scgdof the file is normally done at the *end* of the Makefile.  The reason for
211.1Scgdthis is because .mk files often modify variables and behavior based on the
221.1Scgdvalues of variables set in the Makefile.  To make this work, remember that
231.1Scgdthe FIRST target found is the target that is used, i.e. if the Makefile has:
241.1Scgd
251.1Scgd	a:
261.1Scgd		echo a
271.1Scgd	a:
281.1Scgd		echo a number two
291.1Scgd
301.1Scgdthe command "make a" will echo "a".  To make things confusing, the SECOND
311.1Scgdvariable assignment is the overriding one, i.e. if the Makefile has:
321.1Scgd
331.1Scgd	a=	foo
341.1Scgd	a=	bar
351.1Scgd
361.1Scgd	b:
371.1Scgd		echo ${a}
381.1Scgd
391.1Scgdthe command "make b" will echo "bar".  This is for compatibility with the
401.1Scgdway the V7 make behaved.
411.1Scgd
421.1ScgdIt's fairly difficult to make the BSD .mk files work when you're building
431.75Sagcmultiple programs in a single directory.  It's a lot easier to split up the
441.1Scgdprograms than to deal with the problem.  Most of the agony comes from making
451.36Srossthe "obj" directory stuff work right, not because we switched to a new version
461.1Scgdof make.  So, don't get mad at us, figure out a better way to handle multiple
471.1Scgdarchitectures so we can quit using the symbolic link stuff.  (Imake doesn't
481.1Scgdcount.)
491.1Scgd
501.1ScgdThe file .depend in the source directory is expected to contain dependencies
511.1Scgdfor the source files.  This file is read automatically by make after reading
521.1Scgdthe Makefile.
531.1Scgd
541.1ScgdThe variable DESTDIR works as before.  It's not set anywhere but will change
551.1Scgdthe tree where the file gets installed.
561.1Scgd
571.1ScgdThe profiled libraries are no longer built in a different directory than
581.1Scgdthe regular libraries.  A new suffix, ".po", is used to denote a profiled
591.265Snjolyobject, and ".pico" denotes a shared (position-independent) object.
601.97Sitojun
611.142SlukemThere are various make variables used during the build.
621.142Slukem
631.142SlukemMany variables support a (case sensitive) value of "no" or "yes",
641.142Slukemand are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
651.142Slukem
661.142Slukem
671.172ShubertfThe basic rule for the variable naming scheme is as follows:
681.172Shubertf
691.231SapbHOST_xxx	A command that runs on the host machine regardless of
701.231Sapb		whether or not the system is being cross compiled, or
711.231Sapb		flags for such a command.
721.231Sapb
731.172ShubertfMKxxx		Can be set to "no" to disable functionality, or
741.172Shubertf		"yes" to enable it.
751.172Shubertf		Usually defaults to "yes", although some variables
761.172Shubertf		default to "no".
771.172Shubertf		Due to make(1) implementation issues, if a temporary
781.224Slukem		command-line override of a mk.conf(5) or <bsd.own.mk>
791.214Swiz		setting is required whilst still honoring a particular
801.172Shubertf		Makefile's setting of MKxxx, use
811.172Shubertf			env MKxxx=value make
821.172Shubertf		instead of
831.172Shubertf			make MKxxx=value
841.172Shubertf
851.172ShubertfNOxxx		If defined, disables a feature.
861.172Shubertf		Not intended for users.
871.172Shubertf		This is to allow Makefiles to disable functionality
881.172Shubertf		that they don't support (such as missing man pages).
891.172Shubertf		NOxxx variables must be defined before <bsd.own.mk>
901.172Shubertf		is included.
911.172Shubertf
921.231SapbTOOL_xxx	A tool that is provided as part of the USETOOLS
931.231Sapb		framework.  When not using the USETOOLS framework,
941.231Sapb		TOOL_xxx variables should refer to tools that are
951.231Sapb		already installed on the host system.
961.231Sapb
971.172ShubertfThe following variables that control how things are made/installed that
981.172Shubertfare not set by default. These should not be set by Makefiles; they're for
991.224Slukemthe user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
1001.224Slukemor on the make(1) command line:
1011.172Shubertf
1021.172ShubertfBUILD 		If defined, 'make install' checks that the targets in the
1031.172Shubertf		source directories are up-to-date and remakes them if they
1041.172Shubertf                are out of date, instead of blindly trying to install
1051.172Shubertf                out of date or non-existent targets.
1061.172Shubertf
1071.172ShubertfMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
1081.172Shubertf		Default: 2
1091.172Shubertf		Supported values:
1101.172Shubertf		    0	Minimal output ("quiet")
1111.172Shubertf		    1	Describe what is occurring
1121.172Shubertf		    2	Describe what is occurring and echo the actual command
1131.241Sapb		    3	Ignore the effect of the "@" prefix in make commands
1141.241Sapb		    4	Trace shell commands using the shell's -x flag
1151.172Shubertf
1161.312SjmmvMKATF		If "no", don't build the Automated Testing Framework (ATF),
1171.312Sjmmv		which includes the libatf-c, libatf-c++ and libatf-sh libraries
1181.312Sjmmv		and the various command line tools.  Also, because the build of
1191.312Sjmmv		the libraries is disabled, don't build the NetBSD test suite
1201.312Sjmmv		either.
1211.210Sgmcgarry		Default: yes
1221.210Sgmcgarry
1231.252SskrllMKBFD		Obsolete, use MKBINUTILS
1241.252Sskrll
1251.266SjoergMKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
1261.266Sjoerg		libopcodes)
1271.172Shubertf		Default: yes
1281.172Shubertf
1291.266SjoergMKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
1301.266Sjoerg		the pax frontends.
1311.266Sjoerg		Default: no
1321.266Sjoerg
1331.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1341.292Sjoerg		Default: no
1351.172Shubertf
1361.234SmrgMKCOMPAT  	If "no", don't build or install the src/compat.
1371.303Sjkoshy		Default: yes on amd64/mips64/sparc64, no elsewhere.
1381.234Smrg
1391.344SmattMKCOMPATTESTS  	If "yes", build and install the NetBSD test suite when
1401.344Smatt		building and installing src/compat.
1411.344Smatt		Default: no
1421.344Smatt
1431.345SmattMKCOMPATX11  	If "yes", build and install the X11 libraries when
1441.345Smatt		building and installing src/compat.
1451.345Smatt		Default: no
1461.345Smatt
1471.210SgmcgarryMKCOMPLEX	If "no", don't build libm support for <complex.h>
1481.210Sgmcgarry		Default: yes
1491.210Sgmcgarry
1501.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1511.174Schristos		and also acts as "MKKERBEROS=no".
1521.172Shubertf		Default: yes
1531.172Shubertf
1541.297SspzMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5
1551.172Shubertf		Default: no
1561.172Shubertf
1571.329SozakiMKCTF		If "no", do not build and install CTF tools, and also
1581.329Sozaki		don't generate and manipulate CTF data of ELF binaries
1591.329Sozaki		during build.
1601.329Sozaki		Default: no
1611.329Sozaki
1621.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1631.172Shubertf		Default: yes
1641.172Shubertf
1651.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1661.184Slukem		into /usr/libdata/debug.
1671.184Slukem		Default: no
1681.184Slukem
1691.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1701.219Slukem		with -DDEBUG.
1711.176Schristos		Default: no
1721.176Schristos
1731.314SchristosMKDEPINCLUDES	If "yes" issue .include statements in the .depend file
1741.314Schristos		instead of inlining the contents of the .d files. Useful
1751.314Schristos		when stale dependencies are present, to list the exact
1761.314Schristos		files that need refreshing. It is off by default because
1771.314Schristos		it is possibly slower.
1781.314Schristos		Default "no"
1791.314Schristos
1801.172ShubertfMKDOC		If "no", don't build or install the documentation.
1811.172Shubertf		Default: yes
1821.172Shubertf
1831.302SjkoshyMKDTRACE	If "no", do not build and install the kernel modules,
1841.302Sjkoshy		utilities and libraries used to implement the dtrace(1)
1851.302Sjkoshy		facility.
1861.302Sjkoshy		Default: no
1871.302Sjkoshy
1881.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1891.172Shubertf		don't install certain libraries in /lib, and don't
1901.172Shubertf		install the shared linker into /libexec.
1911.172Shubertf		Default: yes
1921.172Shubertf
1931.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
1941.260Suebayasi		to cross-build programs and libraries externally added by
1951.260Suebayasi		users, and automatically enables creation of those sets.
1961.260Suebayasi		Default: no
1971.260Suebayasi
1981.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1991.186Smrg		libraries (libgcc, libobjc, libstdc++).
2001.172Shubertf		Default: yes
2011.172Shubertf
2021.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
2031.201Slukem		libraries (libgcc, libobjc, libstdc++).
2041.172Shubertf		Default: yes
2051.172Shubertf
2061.172ShubertfMKGDB		If "no", don't build gdb(1).
2071.172Shubertf		Default: yes
2081.172Shubertf
2091.334SdhollandMKGROFFHTMLDOC	If "no", avoid trying to use groff to generate html for
2101.334Sdholland		miscellaneous articles, as this seems to sometimes want
2111.334Sdholland		to run software not in base. Does not affect html man
2121.334Sdholland		pages.
2131.334Sdholland		Default: no
2141.334Sdholland
2151.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
2161.172Shubertf		(libraries and support programs).
2171.172Shubertf		Default: yes
2181.172Shubertf
2191.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
2201.172Shubertf		host, the name, release, and architecture of the host
2211.172Shubertf		operating system will be suffixed to the name of the object
2221.172Shubertf		directory created by "make obj".
2231.172Shubertf		Default: no
2241.172Shubertf
2251.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
2261.222Slukem		Default: yes
2271.172Shubertf
2281.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
2291.172Shubertf		Has no effect on most platforms.
2301.172Shubertf		Default: yes
2311.172Shubertf
2321.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
2331.225Sjoerg		Default: no
2341.225Sjoerg
2351.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2361.273Smrg		(libraries and support programs).  This option must not be
2371.273Smrg		set to "no" if MKX11 is not "no".
2381.172Shubertf		Default: yes
2391.172Shubertf
2401.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2411.172Shubertf		Texinfo source files.
2421.172Shubertf		Default: yes
2431.172Shubertf
2441.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2451.172Shubertf		Default: yes
2461.172Shubertf
2471.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2481.181Smrg		(depends on libpthread.)
2491.181Smrg		Default: yes
2501.181Smrg
2511.331SmartinMKKDEBUG	If "yes", force building of kernel symbol info and creation
2521.331Smartin		of netbsd.gdb in all kernel builds, independently of the
2531.331Smartin		settings for "makeoptions DEBUG" in the kernel config file.
2541.331Smartin
2551.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2561.172Shubertf		infrastructure (libraries and support programs).
2571.172Shubertf		Default: yes
2581.172Shubertf
2591.304SjkoshyMKKMOD		If "no", disables building of kernel modules.
2601.304Sjkoshy		Default: yes
2611.304Sjkoshy
2621.312SjmmvMKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
2631.312Sjmmv		Note that setting this to "no" does not disable the build of
2641.312Sjmmv		the NetBSD test suite itself; the build of the tests is
2651.312Sjmmv		controlled by the MKATF knob.
2661.312Sjmmv		Default: no (until the import is done and validated)
2671.312Sjmmv
2681.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2691.208Slukem		(libraries and support programs).
2701.208Slukem		Default: yes
2711.208Slukem
2721.316SjoergMKLIBCXX	If not "no", build and install libc++.
2731.316Sjoerg		Default: no
2741.316Sjoerg
2751.316SjoergMKLIBSTDCXX	If not "no", build and install libstdc++.
2761.316Sjoerg		Default: yes
2771.316Sjoerg
2781.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2791.172Shubertf		Also:
2801.172Shubertf			- don't install the .a libraries
2811.172Shubertf			- don't install _pic.a libraries on PIC systems
2821.172Shubertf			- don't build .a libraries on PIC systems
2831.172Shubertf			- don't install the .so symlink on ELF systems
2841.172Shubertf		I.e, only install the shared library (and the .so.major
2851.172Shubertf		symlink on ELF).
2861.172Shubertf		Default: yes
2871.172Shubertf
2881.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2891.172Shubertf		Default: yes
2901.172Shubertf
2911.261StronMKLVM		If "no", don't build or install the logical volume manager
2921.245Sagc		and device mapper tools and libraries
2931.262Stron		Default: yes
2941.245Sagc
2951.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2961.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2971.172Shubertf		Default: yes
2981.172Shubertf
2991.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
3001.256Sjoerg		catman or html pages.  A directory can be exempted by
3011.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
3021.278Sjoerg		if NOMANDOC.${target} is set to "yes".
3031.292Sjoerg		Default: yes
3041.256Sjoerg
3051.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
3061.172Shubertf		Default: no
3071.172Shubertf
3081.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
3091.253Stsarna		(libraries and support programs).
3101.253Stsarna		Default: yes
3111.253Stsarna
3121.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
3131.172Shubertf		definition files.
3141.172Shubertf		Default: yes
3151.172Shubertf
3161.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
3171.275Srmind		Default: yes
3181.275Srmind
3191.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
3201.172Shubertf		and also acts as "MKOBJDIRS=no".
3211.172Shubertf		Default: yes
3221.172Shubertf
3231.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
3241.172Shubertf		Default: no
3251.172Shubertf
3261.172ShubertfMKPAM		If "no", disables building of PAM authentication
3271.172Shubertf		infrastructure (libraries and support programs).
3281.182Speter		Default: yes
3291.172Shubertf
3301.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
3311.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
3321.210Sgmcgarry		Default: no
3331.210Sgmcgarry
3341.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
3351.172Shubertf		Default: yes
3361.172Shubertf
3371.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
3381.172Shubertf		also acts as "MKPICLIB=no"
3391.301Sabs		Default: yes (for MACHINE_ARCHs that support it)
3401.172Shubertf
3411.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
3421.172Shubertf		Default: yes
3431.172Shubertf
3441.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
3451.172Shubertf		shared object libraries from the .a libraries.
3461.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
3471.172Shubertf		_pic.a library pointing to the .a library.
3481.172Shubertf		Default: yes
3491.172Shubertf
3501.198SchristosMKPIE		If "no", create regular executables. Otherwise create
3511.198Schristos		PIE (Position Independent Executables).
3521.198Schristos		Default: no
3531.198Schristos
3541.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3551.271Smrg		Default: no
3561.271Smrg
3571.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3581.172Shubertf		Default: yes
3591.172Shubertf
3601.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3611.172Shubertf		Default: yes
3621.172Shubertf
3631.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3641.295Swiz		different switches to make two builds from the same source tree
3651.295Swiz		result in the same build results.
3661.295Swiz		Default: no
3671.295Swiz
3681.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3691.172Shubertf		MKMAN=no MKNLS=no".
3701.172Shubertf		I.e, don't build catman pages, documentation, Info
3711.172Shubertf		documentation, man pages, NLS files, ...
3721.172Shubertf		Default: yes
3731.172Shubertf
3741.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3751.172Shubertf		infrastructure (libraries and support programs).
3761.172Shubertf		Default: yes
3771.172Shubertf
3781.319SadamMKSLJIT		If "no", disables building of sljit (stack-less platform
3791.309Salnsn		independent JIT compiler) private library and tests.
3801.309Salnsn		Default: yes on amd64, i386 and sparc, no elsewhere.
3811.309Salnsn
3821.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3831.172Shubertf		generate output containing library calls for floating
3841.172Shubertf		point and possibly soft-float library support.
3851.172Shubertf		Default: no
3861.172Shubertf
3871.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3881.172Shubertf		libraries.
3891.172Shubertf		Default: yes
3901.172Shubertf
3911.306SchristosMKTPM		If "no" then don't build the Trusted Platform Module
3921.306Schristos		infrastructure.
3931.306Schristos		Default: no
3941.306Schristos
3951.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3961.172Shubertf		files or directories, and keep a metadata log of what
3971.172Shubertf		the owner/group/mode should be.  This allows a
3981.172Shubertf		non-root "make install".
3991.172Shubertf		Default: no
4001.172Shubertf
4011.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
4021.172Shubertf		more recently modified in the source directories that their
4031.172Shubertf		installed counterparts.
4041.172Shubertf		Default: no
4051.172Shubertf
4061.346SmrgMKX11		If not "no", 'make build' also descends into 
4071.346Smrg		src/external/mit/xorg to cross-build X11 and automatically
4081.346Smrg		enables creation of X sets.
4091.216Smrg		Default: no
4101.216Smrg
4111.346SmrgMKX11FONTS	If not "no", do not build or install the X fonts.  The xfont
4121.346Smrg		set is still created but will be empty.
4131.251Smrg		Default: yes
4141.251Smrg
4151.346SmrgMKX11MOTIF:	If "yes", build the native X11 libGLw with Motif stubs.  If
4161.346Smrg		Motif is not installed in the default location /usr/pkg, the
4171.346Smrg		location can be specified using the X11MOTIFPATH variable.
4181.318Smbalmer		Default: no
4191.318Smbalmer
4201.341SmrgMKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory,
4211.341Smrg		which is necessary for the radeon DRM driver.
4221.341Smrg		Default: yes on i386 and amd64, no elsewhere.
4231.341Smrg
4241.172ShubertfMKYP		If "no", disables building of YP (NIS)
4251.172Shubertf		infrastructure (libraries and support programs).
4261.172Shubertf		Default: yes
4271.172Shubertf
4281.301SabsMKZFS		If "no", do not build and install utilities and libraries
4291.301Sabs		used to manage ZFS file system. Do not build zfs and solaris
4301.340Spooka		compatibility kernel modules.  Note: ZFS requires 64bit
4311.340Spooka		atomic operations.
4321.340Spooka		Default: yes on amd64, no elsewhere.
4331.254Shaad
4341.298SchristosMKRUMP		If "no", do not build and install rump related headers,
4351.298Schristos		libraries, and programs.
4361.298Schristos		Default: yes
4371.298Schristos
4381.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
4391.172Shubertf		various system utilities/libraries that support it.
4401.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
4411.172Shubertf		forced to "no".
4421.172Shubertf
4431.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
4441.172Shubertf		various system utilities/libraries that support it.
4451.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
4461.172Shubertf		forced to "no".
4471.172Shubertf
4481.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
4491.197Sad		designed for improved performance with threaded
4501.197Sad		applications.  The "phkmalloc" allocator as used up
4511.197Sad		before NetBSD-5.0 will be substituted.
4521.197Sad
4531.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
4541.172Shubertf		support into various system utilities/libraries that
4551.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
4561.172Shubertf		will also be forced to "no".
4571.172Shubertf
4581.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
4591.208Slukem		system utilities/libraries that support it.
4601.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
4611.208Slukem
4621.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
4631.172Shubertf		into various system utilities/libraries that support it.
4641.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
4651.172Shubertf
4661.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
4671.172Shubertf		support into various system utilities/libraries that
4681.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4691.172Shubertf		also be forced to "no".
4701.204Slukem		Default: no
4711.172Shubertf
4721.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4731.257Stron		detects stack overflows and aborts the program. The
4741.268Snjoly		stack protection code imposes a performance penalty
4751.259Spgoyette		of about 5%.
4761.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4771.187Schristos
4781.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
4791.246Schristos		functions that do not do bounds checking regularly, but
4801.246Schristos		they could in some cases by using the gcc
4811.301Sabs		__builtin_object_size() function to determine the buffer
4821.246Schristos		size where it is known and detect buffer overflows.
4831.246Schristos		These substitute functions are in /usr/include/ssp.
4841.257Stron		Default: depends on the part of the source tree
4851.246Schristos
4861.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4871.172Shubertf		various system utilities/libraries that support it.
4881.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4891.172Shubertf
4901.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
4911.327Sapb		Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
4921.327Sapb		and use nbpigz to compress things.
4931.274Smrg		Default: "no".
4941.274Smrg
4951.172ShubertfCOPTS.lib<lib>
4961.177SmrgOBJCOPTS.lib<lib>
4971.172ShubertfLDADD.lib<lib>
4981.172ShubertfCPPFLAGS.lib<lib>
4991.172ShubertfCXXFLAGS.lib<lib>
5001.172ShubertfCOPTS.<prog>
5011.177SmrgOBJCCOPTS.<prog>
5021.172ShubertfLDADD.<prog>
5031.172ShubertfCPPFLAGS.<prog>
5041.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
5051.172Shubertf		variables in a way that applies only to a particular library
5061.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
5071.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
5081.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
5091.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
5101.172Shubertf		the crypto library.
5111.118Slukem
5121.281SjoergThe active compiler is selected using the following variables:
5131.281SjoergAVAILABLE_COMPILER
5141.281Sjoerg		List of available compiler suites.  Processed in order
5151.281Sjoerg		for selecting the active compiler for each frontend.
5161.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
5171.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
5181.281SjoergUNSUPPORTED_COMPILER.xxx
5191.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
5201.281Sjoerg
5211.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
5221.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
5231.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
5241.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
5251.281Sjoerg
5261.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
5271.1Scgd
5281.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
5291.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
5301.1Scgd
5311.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
5321.1Scgd
5331.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
5341.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
5351.17Sthorpeja few global "feature configuration" parameters.
5361.1Scgd
5371.1ScgdIt has no targets.
5381.1Scgd
5391.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
5401.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
5411.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
5421.29Scjsis included.  These files may define any of the variables described below.
5431.17Sthorpej
5441.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
5451.17Sthorpej(defaults are in brackets):
5461.15Scgd
5471.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
5481.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
5491.98Slukem		otherwise BSDSRCDIR will be used as the default.
5501.98Slukem		Various makefiles within the NetBSD source tree will
5511.98Slukem		use this to reference the top level of the source tree.
5521.98Slukem
5531.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
5541.98Slukem		based on the presence of tools/ and build.sh.  This variable
5551.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
5561.98Slukem		determined once and then propagated to all sub-makes.
5571.95Slukem
5581.305Sapb_NETBSD_VERSION_DEPENDS
5591.305Sapb		A list of files which contain information about
5601.305Sapb		the version of the NetBSD being built.  This is
5611.305Sapb		defined only if the current directory appears
5621.305Sapb		to be inside a NetBSD source tree.  The list of
5631.305Sapb		files includes ${NETBSDSRCDIR}/sys/sys/param.h
5641.305Sapb		(which contains the kernel version number),
5651.305Sapb		${NETBSDSRCDIR}/sys/conf/newvers.sh and
5661.305Sapb		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
5671.305Sapb		interpret the information in sys/sys/param.h), and
5681.305Sapb		${_SRC_TOP_OBJ_}/params (which is an optional file,
5691.305Sapb		created by "make build" in ${_SRC_TOP_}/Makefile,
5701.305Sapb		containing all the variables that may influence the
5711.305Sapb		build).
5721.305Sapb
5731.305Sapb		Targets that depend on the NetBSD version, or on
5741.305Sapb		variables defined at build time, can declare a
5751.305Sapb		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
5761.305Sapb
5771.305Sapb			version.c: ${_NETBSD_VERSION_DEPENDS}
5781.305Sapb				commands to create version.c
5791.305Sapb
5801.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
5811.116Slukem		will work correctly.  [/usr/src]
5821.15Scgd
5831.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
5841.116Slukem		will work correctly.  [/usr/obj]
5851.15Scgd
5861.116SlukemBINGRP		Binary group.  [wheel]
5871.15Scgd
5881.116SlukemBINOWN		Binary owner.  [root]
5891.15Scgd
5901.116SlukemBINMODE		Binary mode.  [555]
5911.15Scgd
5921.116SlukemNONBINMODE	Mode for non-executable files.  [444]
5931.15Scgd
5941.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
5951.15Scgd
5961.116SlukemMANGRP		Manual group.  [wheel]
5971.15Scgd
5981.116SlukemMANOWN		Manual owner.  [root]
5991.15Scgd
6001.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
6011.15Scgd
6021.222SlukemMANINSTALL	Manual installation type.  Space separated list:
6031.222Slukem			catinstall, htmlinstall, maninstall
6041.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
6051.76Sfair
6061.76SfairLDSTATIC	Control program linking; if set blank, link everything
6071.129Slukem		dynamically.  If set to "-static", link everything statically.
6081.76Sfair		If not set, programs link according to their makefile.
6091.21Schristos
6101.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
6111.15Scgd
6121.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
6131.15Scgd
6141.116SlukemLIBGRP		Library group.  [${BINGRP}]
6151.15Scgd
6161.116SlukemLIBOWN		Library owner.  [${BINOWN}]
6171.15Scgd
6181.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
6191.15Scgd
6201.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
6211.116Slukem	        installation.  [/usr/share/doc]
6221.62Ssimonb
6231.116SlukemDOCGRP		Documentation group.  [wheel]
6241.15Scgd
6251.116SlukemDOCOWN		Documentation owner.  [root]
6261.15Scgd
6271.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
6281.15Scgd
6291.335SapbGZIP_N_FLAG	Flags to pass to TOOL_GZIP to prevent it from inserting
6301.335Sapb		file names or timestamps in the compressed output.
6311.335Sapb		[-n, or -nT when TOOL_GZIP is really TOOL_PIGZ]
6321.335Sapb
6331.84SkleinkNLSDIR		Base path for Native Language Support files installation.
6341.15Scgd		[/usr/share/nls]
6351.1Scgd
6361.116SlukemNLSGRP		Native Language Support files group.  [wheel]
6371.1Scgd
6381.116SlukemNLSOWN		Native Language Support files owner.  [root]
6391.1Scgd
6401.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
6411.1Scgd
6421.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
6431.255Sapb		if that exists; otherwise /usr/xsrc]
6441.144Slukem
6451.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
6461.144Slukem
6471.221SmrgX11SRCDIR.lib<package>
6481.221SmrgX11SRCDIR.<package>
6491.221Smrg		The path to the xorg src tree for the specificed package>.
6501.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
6511.221Smrg
6521.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
6531.221Smrg		[/usr/X11R7]
6541.144Slukem
6551.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
6561.144Slukem
6571.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
6581.144Slukem
6591.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
6601.144Slukem
6611.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
6621.144Slukem
6631.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
6641.144Slukem
6651.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
6661.144Slukem
6671.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
6681.1Scgd		to be stripped.  This is to be used when building your
6691.1Scgd		own install script so that the entire system can be made
6701.146Slukem		stripped/not-stripped using a single knob.  []
6711.1Scgd
6721.2ScgdCOPY		The flag passed to the install program to cause the binary
6731.2Scgd		to be copied rather than moved.  This is to be used when
6741.2Scgd		building our own install script so that the entire system
6751.2Scgd		can either be installed with copies, or with moves using
6761.116Slukem		a single knob.  [-c]
6771.15Scgd
6781.310SapbMAKEDIRTARGETENV
6791.310Sapb		Environment variables passed to the child make process
6801.310Sapb		invoked by MAKEDIRTARGET.
6811.310Sapb
6821.150SlukemMAKEDIRTARGET dir target [params]
6831.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
6841.150Slukem		displaying a "pretty" message whilst doing so.
6851.150Slukem
6861.152SclRELEASEMACHINEDIR
6871.152Scl		Subdirectory used below RELEASEDIR when building
6881.152Scl		a release.  [${MACHINE}]
6891.152Scl
6901.152SclRELEASEMACHINE	Subdirectory or path component used for the following
6911.152Scl		paths:
6921.152Scl			distrib/${RELEASEMACHINE}
6931.152Scl			distrib/notes/${RELEASEMACHINE}
6941.152Scl			etc/etc.${RELEASEMACHINE}
6951.152Scl		Used when building a release.  [${MACHINE}]
6961.150Slukem
6971.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
6981.214Swizmake configuration file to modify the behavior of the system build
6991.17Sthorpejprocess (default values are in brackets along with comments, if set by
7001.134Slukem<bsd.own.mk>):
7011.33Sjonathan
7021.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
7031.172Shubertf		be used as part of a build in progress.
7041.172Shubertf		Supported values:
7051.172Shubertf
7061.172Shubertf		yes	Use the tools from TOOLDIR.
7071.172Shubertf			Must be set to this if cross-compiling.
7081.172Shubertf
7091.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
7101.172Shubertf			build native compilation tool components that are
7111.172Shubertf			version-specific for that tool.
7121.172Shubertf
7131.172Shubertf		never	Do not use the tools from TOOLDIR, even when
7141.172Shubertf			building native tool components.  This is similar to
7151.172Shubertf			the traditional NetBSD build method, but does not
7161.172Shubertf			verify that the compilation tools in use are
7171.172Shubertf			up-to-date enough in order to build the tree
7181.172Shubertf			successfully.  This may cause build or runtime
7191.172Shubertf			problems when building the whole NetBSD source tree.
7201.172Shubertf
7211.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
7221.172Shubertf		source tree (detected automatically); "no" otherwise
7231.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
7241.172Shubertf		make(1) include files).
7251.142Slukem
7261.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
7271.199Ssimonb		use ELF -- currently all architectures].
7281.33Sjonathan
7291.103SthorpejTOOLCHAIN_MISSING
7301.142Slukem		If not "no", this indicates that the platform being built
7311.103Sthorpej		does not have a working in-tree toolchain.  If the
7321.142Slukem		${MACHINE_ARCH} in question falls into this category,
7331.301Sabs		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
7341.103Sthorpej		Otherwise, the variable is unconditionally assigned the
7351.103Sthorpej		value "no".
7361.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
7371.142Slukem		unconditionally assigned the value "no".
7381.103Sthorpej
7391.103SthorpejEXTERNAL_TOOLCHAIN
7401.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
7411.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
7421.103Sthorpej		access to this variable.  The variable should be defined
7431.103Sthorpej		either in the user's environment or in the user's mk.conf
7441.103Sthorpej		file.  If defined, this variable indicates the root of
7451.103Sthorpej		an external toolchain which will be used to build the
7461.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
7471.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
7481.103Sthorpej		cross-compile framework.
7491.103Sthorpej
7501.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
7511.142Slukem		assigned the value "no", since the external version of the
7521.142Slukem		compiler may not be able to build the library components of
7531.142Slukem		the in-tree compiler.
7541.103Sthorpej
7551.103Sthorpej		NOTE: This variable is not yet used in as many places as
7561.103Sthorpej		it should be.  Expect the exact semantics of this variable
7571.103Sthorpej		to change in the short term as parts of the cross-compile
7581.103Sthorpej		framework continue to be cleaned up.
7591.1Scgd
7601.236SapbThe following variables are defined to commands to perform the
7611.236Sapbappropriate operation, with the default in [brackets].  Note that
7621.236Sapbthe defaults change if USETOOLS == "yes":
7631.236Sapb
7641.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
7651.236Sapb
7661.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
7671.236Sapb
7681.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
7691.236Sapb
7701.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
7711.236Sapb
7721.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
7731.236Sapb
7741.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
7751.236Sapb
7761.236SapbTOOL_CAT		Concatenate and print files.  [cat]
7771.236Sapb
7781.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
7791.236Sapb
7801.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
7811.236Sapb
7821.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
7831.236Sapb
7841.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
7851.236Sapb
7861.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
7871.236Sapb
7881.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
7891.236Sapb
7901.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
7911.236Sapb
7921.236SapbTOOL_EQN		Format equations for groff.  [eqn]
7931.236Sapb
7941.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
7951.236Sapb
7961.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
7971.236Sapb
7981.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
7991.236Sapb
8001.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
8011.236Sapb
8021.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
8031.236Sapb
8041.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
8051.247Ssketch
8061.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
8071.236Sapb
8081.327SapbTOOL_GZIP		Compression/decompression tool.  [gzip]
8091.327Sapb
8101.335SapbTOOL_GZIP_N		Same as TOOL_GZIP, plus a command line option to
8111.335Sapb			prevent it from inserting file names or timestamps
8121.335Sapb			into the compressed output.
8131.335Sapb			[${TOOL_GZIP} ${GZIP_N_FLAG}]
8141.335Sapb
8151.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
8161.236Sapb
8171.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
8181.236Sapb
8191.328SskrllTOOL_HPPAMKBOOT		Make bootable image for hppa.  [hppa-mkboot]
8201.236Sapb
8211.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
8221.236Sapb
8231.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
8241.236Sapb
8251.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
8261.236Sapb
8271.236SapbTOOL_JOIN		Relational database operator.  [join]
8281.236Sapb
8291.236SapbTOOL_M4			M4 macro language processor.  [m4]
8301.236Sapb
8311.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
8321.236Sapb
8331.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
8341.236Sapb
8351.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
8361.236Sapb
8371.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
8381.236Sapb
8391.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
8401.236Sapb
8411.236SapbTOOL_MENUC		Menu compiler.  [menuc]
8421.236Sapb
8431.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
8441.236Sapb			[mips-elf2ecoff]
8451.236Sapb
8461.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
8471.236Sapb
8481.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
8491.236Sapb
8501.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
8511.236Sapb
8521.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
8531.236Sapb
8541.311SjmcneillTOOL_MKNOD		Make device special file.  [mknod]
8551.311Sjmcneill
8561.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
8571.236Sapb
8581.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
8591.236Sapb
8601.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
8611.236Sapb
8621.332SphxTOOL_NCDCS		Turn ELF kernel into a NCD firmware image. [ncdcs]
8631.332Sphx
8641.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
8651.236Sapb
8661.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
8671.236Sapb
8681.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
8691.273Smrg
8701.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
8711.236Sapb
8721.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
8731.236Sapb
8741.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
8751.236Sapb
8761.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
8771.236Sapb
8781.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
8791.236Sapb
8801.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
8811.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
8821.236Sapb
8831.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
8841.236Sapb
8851.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
8861.236Sapb
8871.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
8881.236Sapb
8891.236SapbTOOL_SED		Stream editor.  [sed]
8901.236Sapb
8911.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
8921.236Sapb
8931.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
8941.236Sapb			[sparkcrc]
8951.236Sapb
8961.236SapbTOOL_STAT		Display file status.  [stat]
8971.236Sapb
8981.236SapbTOOL_STRFILE		Create a random access file for storing strings.
8991.236Sapb			[strfile]
9001.236Sapb
9011.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
9021.236Sapb
9031.236SapbTOOL_TBL		Format tables for groff.  [tbl]
9041.236Sapb
9051.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
9061.236Sapb
9071.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
9081.236Sapb
9091.236SapbTOOL_ZIC		Time zone compiler.  [zic]
9101.236Sapb
9111.323SmattFor each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
9121.323Smattlist of what ports can be built for it.  This keeps those definitions in
9131.323Smattcentralized place.
9141.323Smatt
9151.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
9161.1Scgdthey use the same default owners etc. as the rest of the tree.
9171.131Slukem
9181.131Slukem
9191.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
9201.286Sapb
9211.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
9221.286Sapbtargets.  It uses the following variables:
9231.286Sapb
9241.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
9251.286Sapb
9261.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
9271.286Sapb		the clean target.
9281.286Sapb
9291.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
9301.287Sapb		will delete files from both the object directory,
9311.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
9321.287Sapb
9331.287Sapb		If MKCLEANSRC is set to "no", then the file names in
9341.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
9351.287Sapb		to the object directory, ${.OBJDIR}.  This is the
9361.287Sapb		traditional behaviour.
9371.287Sapb
9381.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
9391.287Sapb		is performed relative to both the object directory,
9401.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
9411.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
9421.287Sapb		Deleting files from ${.CURDIR} is intended to remove
9431.287Sapb		stray output files that had been left in the source
9441.287Sapb		directory by an earlier build that did not use object
9451.287Sapb		directories.
9461.287Sapb
9471.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
9481.287Sapb		separate object directories, and you are sure that there
9491.287Sapb		are no stray files in the source directories, then you
9501.287Sapb		may set MKCLEANSRC=no to save some time.
9511.287Sapb
9521.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
9531.287Sapb		will verify that files have been deleted.
9541.287Sapb
9551.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
9561.287Sapb		be deleted using a "rm -f" command, and its success or
9571.287Sapb		failure will be ignored.
9581.287Sapb
9591.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
9601.287Sapb		the "rm -f" command will be verified using an "ls"
9611.287Sapb		command.
9621.287Sapb
9631.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
9641.287Sapb		there will be no problems caused by file permissions,
9651.287Sapb		read-only file systems, or the like, then you may set
9661.287Sapb		MKCLEANVERIFY=no to save some time.
9671.286Sapb
9681.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
9691.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
9701.286Sapbor CLEANDIRFILES variables.  For example:
9711.286Sapb
9721.286Sapb	    CLEANFILES+= a.out
9731.286Sapb	    CLEANDIRFILES+= .depend
9741.286Sapb
9751.286Sapb	    .include <bsd.clean.mk>
9761.286Sapb
9771.308SapbThe files listed in CLEANFILES and CLEANDIRFILES must not be
9781.308Sapbdirectories, because the potential risk from running "rm -rf" commands
9791.308Sapbin bsd.clean.mk is considered too great.  If you want to recursively
9801.308Sapbdelete a directory as part of "make clean" or "make cleandir" then you
9811.308Sapbneed to provide your own target.
9821.286Sapb
9831.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
9841.131Slukem
9851.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
9861.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
9871.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
9881.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
9891.133Slukemdependencies for the .d files.  In order for this to function correctly,
9901.132Slukemit should be .included after all other .mk files and directives that may
9911.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
9921.132Slukem
9931.132SlukemSRCS		List of source files to build the program.
9941.132Slukem
9951.132SlukemDPSRCS		List of source files which are needed for generating
9961.132Slukem		dependencies, but are not needed in ${SRCS}.
9971.1Scgd
9981.1Scgd
9991.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
10001.106Sthorpej
10011.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
10021.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
10031.124Slukem
10041.124SlukemFILES		The list of files to install.
10051.124Slukem
10061.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
10071.153Slukem		are installed by the `configinstall' target,
10081.153Slukem		not the `install' target.
10091.153Slukem		The FILES* variables documented below also apply.
10101.153Slukem
10111.124SlukemFILESOWN	File owner.  [${BINOWN}]
10121.124Slukem
10131.124SlukemFILESGRP	File group.  [${BINGRP}]
10141.124Slukem
10151.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
10161.124Slukem
10171.124SlukemFILESDIR	The location to install the files.
10181.124Slukem
10191.124SlukemFILESNAME	Optional name to install each file as.
10201.124Slukem
10211.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
10221.153Slukem
10231.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
10241.153Slukem
10251.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
10261.153Slukem
10271.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
10281.153Slukem
10291.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
10301.124Slukem
10311.285SapbFILESBUILD	If this variable is defined, then its value will be
10321.285Sapb		used as the default for all FILESBUILD_<fn> variables.
10331.285Sapb		Otherwise, the default will be "no".
10341.285Sapb
10351.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
10361.243Scube		targets to be built by `realall'.  Users of that variable
10371.243Scube		should provide a target to build the file.
10381.243Scube
10391.135Slukem
10401.139SlukemBUILDSYMLINKS	List of two word items:
10411.135Slukem			lnsrc lntgt
10421.135Slukem		For each lnsrc item, create a symlink named lntgt.
10431.135Slukem		The lntgt symlinks are removed by the cleandir target.
10441.106Sthorpej
10451.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
10461.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
10471.301Sabs		The source files have a `.uue' suffix, the generated files do
10481.148Sjmc		not.
10491.149Sjmc
10501.202SuweUUDECODE_FILES_RENAME_<fn>
10511.202Suwe		Rename the output from the decode to the provided name.
10521.148Sjmc		
10531.148Sjmc		*NOTE: These files are simply decoded, with no install or other
10541.148Sjmc		       rule applying implicitly except being added to the clean
10551.148Sjmc		       target.
10561.106Sthorpej
10571.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
10581.113Sthorpej
10591.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
10601.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
10611.134Slukembefore <bsd.gcc.mk>.
10621.113Sthorpej
10631.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
10641.113Sthorpejof which need to know where to find certain GCC support libraries.
10651.113Sthorpej
10661.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
10671.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
10681.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
10691.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
10701.113Sthorpej
10711.134Slukem<bsd.gcc.mk> sets the following variables:
10721.113Sthorpej
10731.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
10741.118Slukem
10751.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
10761.118Slukem
10771.118Slukem_GCC_CRTEND	The full path name to crtend.o.
10781.118Slukem
10791.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
10801.118Slukem
10811.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
10821.118Slukem
10831.118Slukem
10841.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
10851.118Slukem
10861.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
10871.118Slukemvariables:
10881.118Slukem
10891.124SlukemINCS		The list of include files.
10901.118Slukem
10911.118SlukemINCSDIR		The location to install the include files.
10921.118Slukem
10931.118SlukemINCSNAME	Target name of the include file, if only one; same as
10941.118Slukem		FILESNAME, but for include files.
10951.118Slukem
10961.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
10971.134Slukem		are installed in the 'includes' target and not the
10981.134Slukem		(much later) 'install' target.
10991.134Slukem
11001.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
11011.118Slukem		same as FILESNAME_<file>, but for include files.
11021.118Slukem
11031.118Slukem
11041.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
11051.118Slukem
11061.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
11071.118Slukemdocumentation from respective Texinfo source files.  It defines three
11081.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
11091.118Slukemfollowing variables:
11101.118Slukem
11111.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
11121.118Slukem		consist of single files with the extension replaced by
11131.118Slukem		.info.
11141.118Slukem
11151.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
11161.118Slukem
11171.118Slukem
11181.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
11191.118Slukem
11201.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
11211.118Slukemlocation of kernel sources and object directories.
11221.118Slukem
11231.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
11241.124Slukem		[${_SRC_TOP_}/sys]
11251.118Slukem
11261.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
11271.124Slukem		[arch/${MACHINE}]
11281.120Slukem
11291.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
11301.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
11311.118Slukem
11321.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
11331.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
11341.118Slukem		The default value is
11351.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
11361.118Slukem		if it exists or the target 'obj' is being made.
11371.118Slukem		Otherwise the default is
11381.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
11391.118Slukem
11401.118SlukemIt is important that Makefiles (such as those under src/distrib) that
11411.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
11421.118Slukemrather than make assumptions about the location of the compiled kernel.
11431.118Slukem
11441.118Slukem
11451.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
11461.118Slukem
11471.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
11481.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
11491.118Slukeminclude file installation.  It is intended to be included alone, by
11501.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
11511.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
11521.134Slukemin that file up to date.
11531.118Slukem
11541.325Schristos=-=-=-=-=   bsd.syscall.mk =-=-=-=-=
11551.325Schristos
11561.325SchristosThe include file <bsd.syscall.mk> contains the logic to create syscall
11571.325Schristosfiles for various emulations. It includes <bsd.kinc.mk> to handle the
11581.325Schristosrest of the targets.
11591.118Slukem
11601.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
11611.118Slukem
11621.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
11631.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
11641.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
11651.118Slukemwhich checks for installed shared object libraries whose version is greater
11661.118Slukemthat the version of the source. It has a limited number of suffixes,
11671.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
11681.118Slukem<bsd.shlib.mk> to get shared library parameters.
11691.118Slukem
11701.118SlukemIt sets/uses the following variables:
11711.118Slukem
11721.118SlukemLIB		The name of the library to build.
11731.118Slukem
11741.118SlukemLIBDIR		Target directory for libraries.
11751.118Slukem
11761.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
11771.248Sperry		permissions in files inside its archives to those of
11781.248Sperry		the file it was fed. This leads to non-reproduceable
11791.324Sapb		builds. If MKARZERO is set to "yes" (default is the
11801.324Sapb		same as MKREPRO, or "no" if MKREPRO is not defined),
11811.248Sperry		then the "D" flag is passed to ar, causing the
11821.248Sperry		timestamp, uid and gid to be zeroed and the file
11831.248Sperry		permissions to be set to 644. This allows .a files
11841.248Sperry		from different builds to be bit identical.
11851.248Sperry
11861.300SjoergSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
11871.300Sjoerg		is not "no".
11881.300Sjoerg
11891.263SabsSHLIB_MAJOR
11901.263SabsSHLIB_MINOR
11911.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
11921.263Sabs
11931.300SjoergUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
11941.118Slukem		as the path to install shared libraries to.
11951.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
11961.130Slukem		Default: no
11971.118Slukem
11981.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
11991.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
12001.218Slukem		MKPROFILE=no MKSTATICLIB=no".
12011.218Slukem		Default: no
12021.218Slukem
12031.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
12041.211Slukem		MKPROFILE=no", and don't install the (.a) library.
12051.154Slukem		This is useful for "build only" helper libraries.
12061.154Slukem		Default: no
12071.154Slukem
12081.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
12091.244Smrg		shared libraries.
12101.244Smrg		This is useful for C++ libraries.
12111.244Smrg		Default: no
12121.244Smrg
12131.118SlukemLINTLIBDIR	Target directory for lint libraries.
12141.118Slukem
12151.118SlukemLIBGRP		Library group.
12161.118Slukem
12171.118SlukemLIBOWN		Library owner.
12181.118Slukem
12191.118SlukemLIBMODE		Library mode.
12201.118Slukem
12211.118SlukemLDADD		Additional loader objects.
12221.118Slukem
12231.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12241.118Slukem
12251.118SlukemNOCHECKVER_<library>
12261.118SlukemNOCHECKVER	If set, disables checking for installed shared object
12271.118Slukem		libraries with versions greater than the source.  A
12281.118Slukem		particular library name, without the "lib" prefix, may
12291.118Slukem		be appended to the variable name to disable the check for
12301.118Slukem		only that library.
12311.118Slukem
12321.118SlukemSRCS		List of source files to build the library.  Suffix types
12331.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
12341.118Slukem		to .c files of the same name.  (This is not the default for
12351.118Slukem		versions of make.)
12361.118Slukem
12371.157SlukemLIBDPLIBS	A list of the tuples:
12381.157Slukem			libname  path-to-srcdir-of-libname
12391.157Slukem
12401.157Slukem		For each tuple;
12411.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
12421.157Slukem			`libname', and if it is not set it is determined
12431.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
12441.157Slukem			latter is to allow for build time optimization).
12451.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
12461.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
12471.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
12481.157Slukem
12491.307Spooka		The special value "_external" for LIBDO.lib makes the
12501.307Spooka		build system to assume the library comes from outside
12511.307Spooka		of the NetBSD source tree and only causes -llibname
12521.307Spooka		to be added to LDADD.
12531.307Spooka
12541.157Slukem		This variable may be used for individual libraries, as
12551.301Sabs		well as in parent directories to cache common libraries
12561.157Slukem		as a build-time optimization.
12571.157Slukem
12581.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
12591.118Slukemif it exists, as well as the include file <bsd.man.mk>.
12601.118Slukem
12611.118SlukemIt has rules for building profiled objects; profiled libraries are
12621.118Slukembuilt by default.
12631.118Slukem
12641.118SlukemLibraries are ranlib'd when made.
12651.118Slukem
12661.118Slukem
12671.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
12681.118Slukem
12691.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
12701.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
12711.134Slukem
12721.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
12731.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
12741.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
12751.249Sapbby a method for explicitly recording hard links in a metadata log.
12761.249Sapb
12771.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
12781.134Slukem			source-file target-file
12791.134Slukem		${DESTDIR} is prepended to both paths before linking.
12801.134Slukem		For example, to link /bin/test and /bin/[, use:
12811.134Slukem			LINKS=/bin/test /bin/[
12821.134Slukem
12831.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
12841.153Slukem		are installed by the `configinstall' target,
12851.153Slukem		not the `install' target.
12861.153Slukem
12871.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
12881.134Slukem			source-file target-file
12891.134Slukem		${DESTDIR} is only prepended to target-file before linking.
12901.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
12911.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
12921.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
12931.118Slukem
12941.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
12951.153Slukem		are installed by the `configinstall' target,
12961.153Slukem		not the `install' target.
12971.153Slukem
12981.249SapbLINKSOWN	Link owner.  [${BINOWN}]
12991.249Sapb
13001.249SapbLINKSGRP	Link group.  [${BINGRP}]
13011.249Sapb
13021.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
13031.249Sapb
13041.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
13051.249Sapb
13061.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
13071.249Sapb
13081.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
13091.249Sapb
13101.118Slukem
13111.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
13121.118Slukem
13131.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
13141.118Slukemlinks.
13151.118Slukem
13161.222SlukemIt has a three targets:
13171.118Slukem
13181.222Slukem	catinstall:
13191.222Slukem		Install the preformatted manual pages and their links.
13201.222Slukem	htmlinstall:
13211.222Slukem		Install the HTML manual pages and their links.
13221.118Slukem	maninstall:
13231.118Slukem		Install the manual page sources and their links.
13241.118Slukem
13251.118SlukemIt sets/uses the following variables:
13261.118Slukem
13271.118SlukemMANDIR		Base path for manual installation.
13281.118Slukem
13291.118SlukemMANGRP		Manual group.
13301.118Slukem
13311.118SlukemMANOWN		Manual owner.
13321.118Slukem
13331.118SlukemMANMODE		Manual mode.
13341.118Slukem
13351.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
13361.118Slukem		or "/tahoe" for machine specific manual pages.
13371.118Slukem
13381.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
13391.118Slukem
13401.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
13411.118Slukem		linked-to file must come first, the linked file second,
13421.276Sreed		and there may be multiple pairs.
13431.118Slukem
13441.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
13451.118Slukemit exists.
13461.118Slukem
13471.118Slukem
13481.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
13491.118Slukem
13501.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
13511.118Slukemand use of separated object and source directories.
13521.118Slukem
13531.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
13541.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
13551.118Slukemit exists.  Otherwise make(1) looks for the existence of a
13561.118Slukemsubdirectory (or a symlink to a directory) of the source directory
13571.118Slukeminto which built targets should be placed.  If an environment variable
13581.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
13591.118Slukemobject directory; failing that, make first looks for a subdirectory
13601.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
13611.118Slukem
13621.118SlukemObject directories are not created automatically by make(1) if they
13631.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
13641.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
13651.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
13661.118Slukemand this is determined by a simple string prefix comparison -- object
13671.118Slukemdirectories are created in a separate object directory tree, and a
13681.118Slukemsymlink to the object directory in that tree is created in the source
13691.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
13701.118Slukemsource tree and that it's not safe to use a separate object tree.
13711.118Slukem
13721.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
13731.118Slukemdirectories and links get created during a "make obj":
13741.118Slukem
13751.118SlukemMAKEOBJDIR	If set, this is the component name of the object
13761.118Slukem		directory.
13771.118Slukem
13781.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
13791.118Slukem		object directories or links named "obj.${MACHINE}";
13801.118Slukem		otherwise, just creates ones named "obj".
13811.118Slukem
13821.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
13831.118Slukem		${BSDSRCDIR}, create object directory in the
13841.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
13851.118Slukem		otherwise, create it in the corresponding subdirectory
13861.118Slukem		of ${BSDOBJDIR}
13871.113Sthorpej
13881.118SlukemBUILDID		If set, the contents of this variable are appended
13891.118Slukem		to the object directory name.  If OBJMACHINE is also
13901.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
13911.113Sthorpej
13921.106Sthorpej
13931.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
13941.106Sthorpej
13951.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
13961.1Scgdmore source files, along with their manual pages.  It has a limited number
13971.301Sabsof suffixes, consistent with the current needs of the BSD tree.
13981.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
13991.1Scgd
14001.16SjtcIt has eight targets:
14011.1Scgd
14021.1Scgd	all:
14031.102Sthorpej		build the program and its manual page.  This also
14041.102Sthorpej		creates a GDB initialization file (.gdbinit) in
14051.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
14061.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
14071.1Scgd	clean:
14081.1Scgd		remove the program, any object files and the files a.out,
14091.24Smikel		Errs, errs, mklog, and ${PROG}.core.
14101.1Scgd	cleandir:
14111.1Scgd		remove all of the files removed by the target clean, as
14121.1Scgd		well as .depend, tags, and any manual pages.
14131.42Slukem		`distclean' is a synonym for `cleandir'.
14141.1Scgd	depend:
14151.1Scgd		make the dependencies for the source files, and store
14161.1Scgd		them in the file .depend.
14171.16Sjtc	includes:
14181.16Sjtc		install any header files.
14191.1Scgd	install:
14201.1Scgd		install the program and its manual pages; if the Makefile
14211.1Scgd		does not itself define the target install, the targets
14221.1Scgd		beforeinstall and afterinstall may also be used to cause
14231.1Scgd		actions immediately before and after the install target
14241.1Scgd		is executed.
14251.1Scgd	lint:
14261.1Scgd		run lint on the source files
14271.1Scgd	tags:
14281.1Scgd		create a tags file for the source files.
14291.1Scgd
14301.1ScgdIt sets/uses the following variables:
14311.1Scgd
14321.1ScgdBINGRP		Binary group.
14331.1Scgd
14341.1ScgdBINOWN		Binary owner.
14351.1Scgd
14361.1ScgdBINMODE		Binary mode.
14371.1Scgd
14381.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
14391.286Sapb
14401.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
14411.1Scgd
14421.337SuebayasiCONFIGOPTS	Additional flags to config(1) when building kernels.
14431.337Suebayasi
14441.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
14451.112Sthorpej
14461.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
14471.125Slukem		C objects for <fn>.
14481.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14491.125Slukem
14501.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
14511.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
14521.35Slukem
14531.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
14541.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14551.125Slukem
14561.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
14571.125Slukem
14581.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
14591.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14601.102Sthorpej
14611.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
14621.102Sthorpej		directives in the .gdbinit file that is created in the
14631.102Sthorpej		objdir.
14641.1Scgd
14651.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
14661.1Scgd		For example, to load with the compatibility and utility
14671.1Scgd		libraries, use:
14681.1Scgd
14691.5Sjtc			LDADD+=-lutil -lcompat
14701.1Scgd
14711.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
14721.1Scgd
14731.134SlukemLINKS		See <bsd.links.mk>
14741.134Slukem
14751.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
14761.177Smrg
14771.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
14781.177Smrg		ObjC objects for <fn>.
14791.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
14801.177Smrg
14811.134SlukemSYMLINKS	See <bsd.links.mk>
14821.1Scgd
14831.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
14841.8Scgd		defined, "MAN=${PROG}.1" is assumed.
14851.1Scgd
14861.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
14871.212Slukem		time, with the value of this variable as args to paxctl(1).
14881.193Sperry
14891.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
14901.193Sperry
14911.1ScgdPROG		The name of the program to build.  If not supplied, nothing
14921.1Scgd		is built.
14931.1Scgd
14941.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
14951.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
14961.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
14971.88Sthorpej		the value of PROG if PROG is also set.
14981.87Sthorpej
14991.21SchristosPROGNAME	The name that the above program will be installed as, if
15001.21Schristos		different from ${PROG}.
15011.21Schristos
15021.37StvSRCS		List of source files to build the program.  If SRCS is not
15031.1Scgd		defined, it's assumed to be ${PROG}.c.
15041.108Sjwise
15051.108SjwiseDPSRCS		List of source files which are needed for generating
15061.108Sjwise		dependencies, but are not needed in ${SRCS}.
15071.1Scgd
15081.1ScgdDPADD		Additional dependencies for the program.  Usually used for
15091.1Scgd		libraries.  For example, to depend on the compatibility and
15101.1Scgd		utility libraries use:
15111.1Scgd
15121.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
15131.1Scgd
15141.288Schristos		The following system libraries are predefined for DPADD:
15151.1Scgd
15161.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
15171.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
15181.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
15191.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
15201.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
15211.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
15221.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
15231.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
15241.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
15251.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
15261.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
15271.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
15281.322Sjoerg		LIBCRTI?=	${DESTDIR}/usr/lib/crti.o
15291.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
15301.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
15311.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
15321.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
15331.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
15341.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
15351.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
15361.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
15371.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
15381.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
15391.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
15401.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
15411.315Schristos		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
15421.315Schristos		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
15431.347Schristos		LIBEXECINFO?=	${DESTDIR}/usr/lib/libexecinfo.a
15441.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
15451.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
15461.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
15471.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
15481.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
15491.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
15501.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
15511.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
15521.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
15531.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
15541.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
15551.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
15561.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
15571.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
15581.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
15591.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
15601.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
15611.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
15621.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
15631.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
15641.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
15651.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
15661.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
15671.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
15681.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
15691.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
15701.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
15711.313Sjmmv		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
15721.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
15731.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
15741.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
15751.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
15761.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
15771.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
15781.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
15791.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
15801.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
15811.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
15821.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
15831.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
15841.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
15851.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
15861.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
15871.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
15881.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
15891.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
15901.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
15911.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
15921.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
15931.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
15941.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
15951.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
15961.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
15971.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
15981.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
15991.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
16001.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
16011.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
16021.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
16031.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
16041.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
16051.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
16061.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
16071.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
16081.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
16091.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
16101.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
16111.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
16121.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
16131.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
16141.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
16151.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
16161.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
16171.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
16181.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
16191.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
16201.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
16211.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
16221.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
16231.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
16241.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
16251.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
16261.1Scgd
16271.288Schristos		The following X-Windows libraries are predefined for DPADD:
16281.288Schristos
16291.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
16301.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
16311.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
16321.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
16331.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
16341.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
16351.317Smrg		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
16361.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
16371.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
16381.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
16391.320Schristos		LIBXCB?=	${DESTDIR}/usr/X11R7/lib/libxcb.a
16401.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
16411.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
16421.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
16431.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
16441.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
16451.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
16461.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
16471.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
16481.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
16491.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
16501.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
16511.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
16521.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
16531.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
16541.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
16551.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
16561.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
16571.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
16581.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
16591.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
16601.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
16611.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
16621.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
16631.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
16641.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
16651.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
16661.288Schristos
16671.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
16681.12Schristos		strings, using xstr(1). Note that this will not work with
16691.12Schristos		parallel makes.
16701.1Scgd
16711.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
16721.1Scgd		to be stripped.
16731.1Scgd
16741.1ScgdSUBDIR		A list of subdirectories that should be built as well.
16751.1Scgd		Each of the targets will execute the same target in the
16761.1Scgd		subdirectories.
16771.1Scgd
16781.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
16791.21Schristos		These are installed exactly like programs.
16801.21Schristos
16811.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
16821.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
16831.166Srtr
16841.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
16851.21Schristos		different from ${SCRIPTS}. These can be further specialized
16861.21Schristos		by setting SCRIPTSNAME_<script>.
16871.21Schristos
16881.124SlukemFILES		See description of <bsd.files.mk>.
16891.21Schristos
16901.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
16911.106Sthorpej		<bsd.own.mk> for additional information about this variable.
16921.130Slukem
16931.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
16941.1Scgdif it exists, as well as the include file <bsd.man.mk>.
16951.1Scgd
16961.1ScgdSome simple examples:
16971.1Scgd
16981.1ScgdTo build foo from foo.c with a manual page foo.1, use:
16991.1Scgd
17001.1Scgd	PROG=	foo
17011.1Scgd
17021.1Scgd	.include <bsd.prog.mk>
17031.1Scgd
17041.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
17051.1Scgd
17061.9Scgd	MAN=	foo.2
17071.1Scgd
17081.1ScgdIf foo does not have a manual page at all, add the line:
17091.1Scgd
17101.75Sagc	MKMAN=	no
17111.1Scgd
17121.1ScgdIf foo has multiple source files, add the line:
17131.1Scgd
17141.1Scgd	SRCS=	a.c b.c c.c d.c
17151.1Scgd
17161.1Scgd
17171.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
17181.118Slukem
17191.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
17201.118Slukemconstruct source files built by rpcgen.
17211.72Ssommerfe
17221.118SlukemThe following macros may be defined in makefiles which include
17231.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
17241.118Slukemare to be built:
17251.21Schristos
17261.118SlukemRPC_INCS:	construct .h file from .x file
17271.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
17281.118Slukem		(for marshalling/unmarshalling data types)
17291.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
17301.118Slukem		(server-side stubs)
17311.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
17321.21Schristos
17331.118SlukemRPC_XDIR:	Directory containing .x/.h files
17341.23Schristos
17351.23Schristos
17361.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
17371.21Schristos
17381.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
17391.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
17401.134Slukemincluded before <bsd.shlib.mk>.
17411.21Schristos
17421.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
17431.118Slukem(defaults are in brackets):
17441.21Schristos
17451.300SjoergSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
17461.300Sjoerg		instead of ${LIBDIR} as the base path for shared library
17471.300Sjoerg		installation.  [/lib]
17481.300Sjoerg
17491.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
17501.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
17511.118Slukem		for all others.]
17521.81Swiz
17531.300Sjoerg_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
17541.118Slukem		otherwise set to ${LIBDIR}
17551.81Swiz
17561.300SjoergSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
17571.300Sjoerg
17581.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
17591.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
17601.118Slukem		all others.]
17611.39Scgd
17621.13Schristos
17631.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
17641.13Schristos
17651.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
17661.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
17671.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
17681.233Sapbfollowing variables:
17691.233Sapb
17701.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
17711.233Sapb		will be ignored and subdirectories will not be processed.
17721.233Sapb
17731.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
17741.233Sapb		specified directory will be visited and the target made.
17751.233Sapb
17761.233Sapb		As a special case, the use of a token .WAIT as an
17771.233Sapb		entry in SUBDIR acts as a synchronization barrier
17781.233Sapb		when multiple make jobs are run; subdirs before the
17791.233Sapb		.WAIT must complete before any subdirs after .WAIT are
17801.233Sapb		started.  See make(1) for some caveats on use of .WAIT
17811.233Sapb		and other special sources.
17821.47Stv
17831.47Stv
17841.326Schristos=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
17851.326Schristos
17861.326SchristosThe include file <bsd.x11.mk> contains parameters and targets for
17871.346Smrgcross-building X11 from ${X11SRCDIR.<package>}.  It should be included
17881.346Smrgafter the general Makefile contents but before the include files such as
17891.346Smrg<bsd.prog.mk> and <bsd.lib.mk>.
17901.326Schristos
17911.326SchristosIt provides the following targets:
17921.326Schristos	.man.1 .man.3 .man.4 .man.5 .man.7:
17931.326Schristos		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
17941.326Schristos		these rules convert from X11's manual page source
17951.326Schristos		into an mdoc.old source file.
17961.326Schristos
17971.326SchristosIt sets the following variables:
17981.326Schristos
17991.326SchristosBINDIR			Set to ${X11BINDIR}.
18001.326Schristos			To override, define after including <bsd.x11.mk>
18011.326Schristos
18021.326SchristosLIBDIR			Set to ${X11USRLIBDIR}.
18031.326Schristos			To override, define after including <bsd.x11.mk>
18041.326Schristos
18051.326SchristosMANDIR			Set to ${X11MANDIR}.
18061.326Schristos			To override, define after including <bsd.x11.mk>
18071.326Schristos
18081.326SchristosCPPFLAGS		Appended with definitions to include from
18091.326Schristos			${DESTDIR}${X11INCDIR}
18101.326Schristos
18111.326SchristosLDFLAGS			Appended with definitions to link from
18121.326Schristos			${DESTDIR}${X11USRLIBDIR}
18131.326Schristos
18141.326SchristosX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
18151.326Schristos
18161.326SchristosX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
18171.326Schristos
18181.326SchristosX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
18191.326Schristos
18201.326SchristosX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
18211.326Schristos
18221.326SchristosX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
18231.326Schristos
18241.326SchristosX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18251.326Schristos
18261.326SchristosX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
18271.326Schristos
18281.326SchristosX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
18291.326Schristos
18301.326SchristosX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
18311.326Schristos
18321.326SchristosX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
18331.326Schristos
18341.326SchristosIt uses the following variables:
18351.326Schristos
18361.326SchristosAPPDEFS			List of app-default files to install.
18371.326Schristos
18381.326SchristosCPPSCRIPTS		List of files/scripts to run through cpp(1)
18391.326Schristos			and then ${X11TOOL_UNXCOMM}.  The source files
18401.326Schristos			have a `.cpp' suffix, the generated files do not.
18411.326Schristos
18421.326SchristosCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
18431.326Schristos
18441.326SchristosCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
18451.326Schristos
18461.326Schristos
18471.326Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
18481.326Schristos
18491.326SchristosThe following files are described here for completion, but they are not
18501.326Schristossupposed to be included directly from other Makefiles; they are used
18511.326Schristosinternally by other system files.
18521.326Schristos
18531.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
18541.47Stv
18551.326SchristosThe include file <bsd.sys.mk> is used by other system mk files and
18561.326Schristosit is not intended to be included standalone. It contains rules and
18571.326Schristossystem build variables. It requires bsd.own.mk to be included first.
18581.326SchristosIt contains overrides that are used when building the NetBSD source tree.
18591.133Slukem
18601.133SlukemThe following variables control how various files are compiled/built.
18611.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
18621.133Slukem
18631.133SlukemAR		Create, modify, and extract from archives.  [ar]
18641.133Slukem
18651.133SlukemARFLAGS		Options to ${AR}.  [rl]
18661.133Slukem
18671.151SlukemAS		Assembler.  [as]
18681.151Slukem
18691.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
18701.211Slukem		assembly source files.  []
18711.151Slukem
18721.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
18731.217Sjoerg		If this option is present, seed the random number
18741.217Sjoerg		generator based on the value, source file names and
18751.217Sjoerg		the output file name to make builds more deterministic.
18761.217Sjoerg		Additional information is available in the GCC
18771.217Sjoerg		documentation of -frandom-seed.
18781.217Sjoerg
18791.133SlukemCC		C compiler.  [cc]
18801.133Slukem
18811.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
18821.133Slukem
18831.133SlukemCPP		C Pre-Processor.  [cpp]
18841.133Slukem
18851.133SlukemCPPFLAGS	Options to ${CPP}.  []
18861.133Slukem
18871.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
18881.133Slukem
18891.133SlukemCXX		C++ compiler.  [c++]
18901.133Slukem
18911.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
18921.133Slukem
18931.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
18941.133Slukem
18951.133SlukemFC		Fortran compiler.  [f77]
18961.133Slukem
18971.133SlukemFFLAGS		Options to {$FC}.  [-O]
18981.133Slukem
18991.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
19001.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
19011.235Sapb
19021.133SlukemINSTALL		install(1) command.  [install]
19031.133Slukem
19041.133SlukemLEX		Lexical analyzer.  [lex]
19051.133Slukem
19061.133SlukemLFLAGS		Options to ${LEX}.  []
19071.133Slukem
19081.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
19091.145Sjwise
19101.133SlukemLD		Linker.  [ld]
19111.133Slukem
19121.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
19131.133Slukem
19141.133SlukemLINT		C program verifier.  [lint]
19151.133Slukem
19161.330SchristosLINTFLAGS	Options to ${LINT}.  [-chapbxzgFS]
19171.133Slukem
19181.133SlukemLORDER		List dependencies for object files.  [lorder]
19191.133Slukem
19201.133SlukemMAKE		make(1).  [make]
19211.133Slukem
19221.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
19231.133Slukem
19241.321SmrgMKDEPCXX	Construct Makefile dependency list for C++ files.  [mkdep]
19251.321Smrg
19261.133SlukemNM		List symbols from object files.  [nm]
19271.133Slukem
19281.133SlukemPC		Pascal compiler.  [pc]  (Not present)
19291.133Slukem
19301.133SlukemPFLAGS		Options to ${PC}.  []
19311.133Slukem
19321.133SlukemOBJC		Objective C compiler.  [${CC}]
19331.133Slukem
19341.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
19351.133Slukem
19361.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
19371.133Slukem
19381.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
19391.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
19401.291Schristos
19411.168SrizOBJDUMP		Display information from object files.  [objdump]
19421.168Sriz
19431.133SlukemRANLIB		Generate index to archive.  [ranlib]
19441.133Slukem
19451.343SpookaREADELF		Display information from ELF object files.  [readelf]
19461.343Spooka
19471.133SlukemSIZE		List section sizes and total size.  [size]
19481.133Slukem
19491.343SpookaSTRINGS		Display printable character sequences in files.  [strings]
19501.343Spooka
19511.133SlukemSTRIP		Discard symbols from object files.  [strip]
19521.133Slukem
19531.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
19541.133Slukem
19551.133SlukemYACC		LALR(1) parser generator.  [yacc]
19561.133Slukem
19571.133SlukemYFLAGS		Options to ${YACC}.  []
19581.133Slukem
19591.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
19601.133Slukem		from <file>.y to <file>.h and <file>.c, and add
19611.133Slukem		<foo>.h to CLEANFILES.
19621.133Slukem
19631.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
19641.133Slukem
19651.116Slukem
19661.69SsommerfeOther variables of note (incomplete list):
19671.69Ssommerfe
19681.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
19691.213Slukem		that cause warnings to be fatal, such as:
19701.213Slukem			-Werror -Wa,--fatal-warnings
19711.213Slukem		(The latter being for as(1).)
19721.212Slukem
19731.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
19741.283Sjoerg		passed to it.
19751.283Sjoerg
19761.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
19771.82Slukem			WARNS=1
19781.82Slukem			WARNS=2
19791.82Slukem			WARNS=3
19801.164Smatt			WARNS=4
19811.296Splunky			WARNS=5
19821.336Schristos			WARNS=6
19831.69Ssommerfe
19841.326Schristos=-=-=-=-=   bsd.host.mk  =-=-=-=-=
19851.144Slukem
19861.326SchristosThis file is automatically included from bsd.own.mk. It contains settings
19871.326Schristosfor all the HOST_* variables that are used in host programs and libraries.
19881.144Slukem
19891.326SchristosHOST_AR			The host archive processing command
19901.144Slukem
19911.326SchristosHOST_CC			The host c compiler
19921.144Slukem
19931.326SchristosHOST_CFLAGS		The host c compiler flags
19941.144Slukem
19951.326SchristosHOST_COMPILE.c		The host c compiler line with flags
19961.144Slukem
19971.326SchristosHOST_COMPILE.cc		The host c++ compiler line with flags
19981.144Slukem
19991.326SchristosHOST_CPP		The host c pre-processor
20001.144Slukem
20011.326SchristosHOST_CPPFLAGS		The cost c pre-processor flags
20021.144Slukem
20031.326SchristosHOST_CXX		The host c++ compiler
20041.144Slukem
20051.326SchristosHOST_CXXFLAGS		The host c++ compiler flags
20061.144Slukem
20071.326SchristosHOST_INSTALL_DIR	The host command to install a directory
20081.144Slukem
20091.326SchristosHOST_INSTALL_FILE	The host command to install a file
20101.144Slukem
20111.326SchristosHOST_INSTALL_SYMLINK	The host command to install a symlink
20121.144Slukem
20131.326SchristosHOST_LD			The host linker command
20141.144Slukem
20151.326SchristosHOST_LDFLAGS		The host linker flags
20161.144Slukem
20171.326SchristosHOST_LINK.c		The host c linker line with flags
20181.221Smrg
20191.326SchristosHOST_LINK.cc		The host c++ linker line with flags
20201.144Slukem
20211.326SchristosHOST_LN			The host command to link two files
20221.144Slukem
20231.326SchristosHOST_MKDEP		The host command to create dependencies for c programs
20241.144Slukem
20251.326SchristosHOST_MKDEPCXX		The host command to create dependencies for c++ programs
20261.144Slukem
20271.326SchristosHOST_OSTYPE		The host OSNAME-RELEASE-ARCH tupple
20281.144Slukem
20291.326SchristosHOST_RANLIB		The host command to create random access archives
20301.144Slukem
20311.326SchristosHOST_SH			The host Bourne shell interpreter name (absolute path)
20321.144Slukem
20331.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2034