bsd.README revision 1.356
11.356Schristos#	$NetBSD: bsd.README,v 1.356 2016/08/20 16:11:07 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.349SchristosNOCTF		Don't generate and manipulate CTF data of ELF binaries
1631.349Schristos		during build. It is set internally for standalone programs.
1641.349Schristos
1651.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1661.172Shubertf		Default: yes
1671.172Shubertf
1681.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1691.184Slukem		into /usr/libdata/debug.
1701.184Slukem		Default: no
1711.184Slukem
1721.352SchristosNODEBUG		Don't compile with debugging symbols during build.
1731.352Schristos		It is set internally for standalone programs.
1741.352Schristos
1751.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1761.219Slukem		with -DDEBUG.
1771.176Schristos		Default: no
1781.176Schristos
1791.314SchristosMKDEPINCLUDES	If "yes" issue .include statements in the .depend file
1801.314Schristos		instead of inlining the contents of the .d files. Useful
1811.314Schristos		when stale dependencies are present, to list the exact
1821.314Schristos		files that need refreshing. It is off by default because
1831.314Schristos		it is possibly slower.
1841.314Schristos		Default "no"
1851.314Schristos
1861.172ShubertfMKDOC		If "no", don't build or install the documentation.
1871.172Shubertf		Default: yes
1881.172Shubertf
1891.302SjkoshyMKDTRACE	If "no", do not build and install the kernel modules,
1901.302Sjkoshy		utilities and libraries used to implement the dtrace(1)
1911.302Sjkoshy		facility.
1921.302Sjkoshy		Default: no
1931.302Sjkoshy
1941.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1951.172Shubertf		don't install certain libraries in /lib, and don't
1961.172Shubertf		install the shared linker into /libexec.
1971.172Shubertf		Default: yes
1981.172Shubertf
1991.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
2001.260Suebayasi		to cross-build programs and libraries externally added by
2011.260Suebayasi		users, and automatically enables creation of those sets.
2021.260Suebayasi		Default: no
2031.260Suebayasi
2041.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
2051.186Smrg		libraries (libgcc, libobjc, libstdc++).
2061.172Shubertf		Default: yes
2071.172Shubertf
2081.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
2091.201Slukem		libraries (libgcc, libobjc, libstdc++).
2101.172Shubertf		Default: yes
2111.172Shubertf
2121.172ShubertfMKGDB		If "no", don't build gdb(1).
2131.172Shubertf		Default: yes
2141.172Shubertf
2151.334SdhollandMKGROFFHTMLDOC	If "no", avoid trying to use groff to generate html for
2161.334Sdholland		miscellaneous articles, as this seems to sometimes want
2171.334Sdholland		to run software not in base. Does not affect html man
2181.334Sdholland		pages.
2191.334Sdholland		Default: no
2201.334Sdholland
2211.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
2221.172Shubertf		(libraries and support programs).
2231.172Shubertf		Default: yes
2241.172Shubertf
2251.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
2261.172Shubertf		host, the name, release, and architecture of the host
2271.172Shubertf		operating system will be suffixed to the name of the object
2281.172Shubertf		directory created by "make obj".
2291.172Shubertf		Default: no
2301.172Shubertf
2311.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
2321.222Slukem		Default: yes
2331.172Shubertf
2341.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
2351.172Shubertf		Has no effect on most platforms.
2361.172Shubertf		Default: yes
2371.172Shubertf
2381.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
2391.225Sjoerg		Default: no
2401.225Sjoerg
2411.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2421.273Smrg		(libraries and support programs).  This option must not be
2431.273Smrg		set to "no" if MKX11 is not "no".
2441.172Shubertf		Default: yes
2451.172Shubertf
2461.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2471.172Shubertf		Texinfo source files.
2481.172Shubertf		Default: yes
2491.172Shubertf
2501.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2511.172Shubertf		Default: yes
2521.172Shubertf
2531.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2541.181Smrg		(depends on libpthread.)
2551.181Smrg		Default: yes
2561.181Smrg
2571.331SmartinMKKDEBUG	If "yes", force building of kernel symbol info and creation
2581.331Smartin		of netbsd.gdb in all kernel builds, independently of the
2591.331Smartin		settings for "makeoptions DEBUG" in the kernel config file.
2601.331Smartin
2611.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2621.172Shubertf		infrastructure (libraries and support programs).
2631.172Shubertf		Default: yes
2641.172Shubertf
2651.304SjkoshyMKKMOD		If "no", disables building of kernel modules.
2661.304Sjkoshy		Default: yes
2671.304Sjkoshy
2681.312SjmmvMKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
2691.312Sjmmv		Note that setting this to "no" does not disable the build of
2701.312Sjmmv		the NetBSD test suite itself; the build of the tests is
2711.312Sjmmv		controlled by the MKATF knob.
2721.312Sjmmv		Default: no (until the import is done and validated)
2731.312Sjmmv
2741.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2751.208Slukem		(libraries and support programs).
2761.208Slukem		Default: yes
2771.208Slukem
2781.316SjoergMKLIBCXX	If not "no", build and install libc++.
2791.316Sjoerg		Default: no
2801.316Sjoerg
2811.316SjoergMKLIBSTDCXX	If not "no", build and install libstdc++.
2821.316Sjoerg		Default: yes
2831.316Sjoerg
2841.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2851.172Shubertf		Also:
2861.172Shubertf			- don't install the .a libraries
2871.172Shubertf			- don't install _pic.a libraries on PIC systems
2881.172Shubertf			- don't build .a libraries on PIC systems
2891.172Shubertf			- don't install the .so symlink on ELF systems
2901.172Shubertf		I.e, only install the shared library (and the .so.major
2911.172Shubertf		symlink on ELF).
2921.172Shubertf		Default: yes
2931.172Shubertf
2941.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2951.172Shubertf		Default: yes
2961.172Shubertf
2971.261StronMKLVM		If "no", don't build or install the logical volume manager
2981.245Sagc		and device mapper tools and libraries
2991.262Stron		Default: yes
3001.245Sagc
3011.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
3021.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
3031.172Shubertf		Default: yes
3041.172Shubertf
3051.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
3061.256Sjoerg		catman or html pages.  A directory can be exempted by
3071.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
3081.278Sjoerg		if NOMANDOC.${target} is set to "yes".
3091.292Sjoerg		Default: yes
3101.256Sjoerg
3111.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
3121.172Shubertf		Default: no
3131.172Shubertf
3141.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
3151.253Stsarna		(libraries and support programs).
3161.253Stsarna		Default: yes
3171.253Stsarna
3181.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
3191.172Shubertf		definition files.
3201.172Shubertf		Default: yes
3211.172Shubertf
3221.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
3231.275Srmind		Default: yes
3241.275Srmind
3251.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
3261.172Shubertf		and also acts as "MKOBJDIRS=no".
3271.172Shubertf		Default: yes
3281.172Shubertf
3291.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
3301.172Shubertf		Default: no
3311.172Shubertf
3321.172ShubertfMKPAM		If "no", disables building of PAM authentication
3331.172Shubertf		infrastructure (libraries and support programs).
3341.182Speter		Default: yes
3351.172Shubertf
3361.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
3371.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
3381.210Sgmcgarry		Default: no
3391.210Sgmcgarry
3401.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
3411.172Shubertf		Default: yes
3421.172Shubertf
3431.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
3441.172Shubertf		also acts as "MKPICLIB=no"
3451.301Sabs		Default: yes (for MACHINE_ARCHs that support it)
3461.172Shubertf
3471.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
3481.172Shubertf		Default: yes
3491.172Shubertf
3501.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
3511.172Shubertf		shared object libraries from the .a libraries.
3521.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
3531.172Shubertf		_pic.a library pointing to the .a library.
3541.172Shubertf		Default: yes
3551.172Shubertf
3561.198SchristosMKPIE		If "no", create regular executables. Otherwise create
3571.198Schristos		PIE (Position Independent Executables).
3581.198Schristos		Default: no
3591.198Schristos
3601.350SchristosNOPIE		Don't create PIE (Position Independent Executables)
3611.349Schristos		It is set internally for standalone programs.
3621.349Schristos
3631.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3641.271Smrg		Default: no
3651.271Smrg
3661.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3671.172Shubertf		Default: yes
3681.172Shubertf
3691.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3701.172Shubertf		Default: yes
3711.172Shubertf
3721.355SchristosMKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory,
3731.355Schristos		which is necessary for the radeon DRM driver.
3741.355Schristos		Default: yes on i386 and amd64, no elsewhere.
3751.355Schristos
3761.354SchristosMKRELRO		If "partial", set the non-PLT GOT to read-only. If "full"
3771.354Schristos		also force immediate symbol binding.
3781.354Schristos		Default: no
3791.354Schristos	
3801.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3811.295Swiz		different switches to make two builds from the same source tree
3821.295Swiz		result in the same build results.
3831.295Swiz		Default: no
3841.295Swiz
3851.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3861.172Shubertf		MKMAN=no MKNLS=no".
3871.172Shubertf		I.e, don't build catman pages, documentation, Info
3881.172Shubertf		documentation, man pages, NLS files, ...
3891.172Shubertf		Default: yes
3901.172Shubertf
3911.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3921.172Shubertf		infrastructure (libraries and support programs).
3931.172Shubertf		Default: yes
3941.172Shubertf
3951.319SadamMKSLJIT		If "no", disables building of sljit (stack-less platform
3961.309Salnsn		independent JIT compiler) private library and tests.
3971.309Salnsn		Default: yes on amd64, i386 and sparc, no elsewhere.
3981.309Salnsn
3991.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
4001.172Shubertf		generate output containing library calls for floating
4011.172Shubertf		point and possibly soft-float library support.
4021.172Shubertf		Default: no
4031.172Shubertf
4041.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
4051.172Shubertf		libraries.
4061.172Shubertf		Default: yes
4071.172Shubertf
4081.351SchristosMKTOOLSDEBUG	If "yes" build the tools with debugging symbols.
4091.351Schristos		Default: no
4101.351Schristos
4111.306SchristosMKTPM		If "no" then don't build the Trusted Platform Module
4121.306Schristos		infrastructure.
4131.306Schristos		Default: no
4141.306Schristos
4151.355SchristosMKUNBOUND	If not "no", build and install the "unbound" DNS resolver.
4161.356Schristos		Default: yes
4171.355Schristos
4181.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
4191.172Shubertf		files or directories, and keep a metadata log of what
4201.172Shubertf		the owner/group/mode should be.  This allows a
4211.172Shubertf		non-root "make install".
4221.172Shubertf		Default: no
4231.172Shubertf
4241.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
4251.172Shubertf		more recently modified in the source directories that their
4261.172Shubertf		installed counterparts.
4271.172Shubertf		Default: no
4281.172Shubertf
4291.346SmrgMKX11		If not "no", 'make build' also descends into 
4301.346Smrg		src/external/mit/xorg to cross-build X11 and automatically
4311.346Smrg		enables creation of X sets.
4321.216Smrg		Default: no
4331.216Smrg
4341.346SmrgMKX11FONTS	If not "no", do not build or install the X fonts.  The xfont
4351.346Smrg		set is still created but will be empty.
4361.251Smrg		Default: yes
4371.251Smrg
4381.346SmrgMKX11MOTIF:	If "yes", build the native X11 libGLw with Motif stubs.  If
4391.346Smrg		Motif is not installed in the default location /usr/pkg, the
4401.346Smrg		location can be specified using the X11MOTIFPATH variable.
4411.318Smbalmer		Default: no
4421.318Smbalmer
4431.172ShubertfMKYP		If "no", disables building of YP (NIS)
4441.172Shubertf		infrastructure (libraries and support programs).
4451.172Shubertf		Default: yes
4461.172Shubertf
4471.301SabsMKZFS		If "no", do not build and install utilities and libraries
4481.301Sabs		used to manage ZFS file system. Do not build zfs and solaris
4491.340Spooka		compatibility kernel modules.  Note: ZFS requires 64bit
4501.340Spooka		atomic operations.
4511.340Spooka		Default: yes on amd64, no elsewhere.
4521.254Shaad
4531.298SchristosMKRUMP		If "no", do not build and install rump related headers,
4541.298Schristos		libraries, and programs.
4551.298Schristos		Default: yes
4561.298Schristos
4571.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
4581.172Shubertf		various system utilities/libraries that support it.
4591.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
4601.172Shubertf		forced to "no".
4611.172Shubertf
4621.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
4631.172Shubertf		various system utilities/libraries that support it.
4641.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
4651.172Shubertf		forced to "no".
4661.172Shubertf
4671.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
4681.197Sad		designed for improved performance with threaded
4691.197Sad		applications.  The "phkmalloc" allocator as used up
4701.197Sad		before NetBSD-5.0 will be substituted.
4711.197Sad
4721.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
4731.172Shubertf		support into various system utilities/libraries that
4741.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
4751.172Shubertf		will also be forced to "no".
4761.172Shubertf
4771.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
4781.208Slukem		system utilities/libraries that support it.
4791.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
4801.208Slukem
4811.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
4821.172Shubertf		into various system utilities/libraries that support it.
4831.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
4841.172Shubertf
4851.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
4861.172Shubertf		support into various system utilities/libraries that
4871.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4881.172Shubertf		also be forced to "no".
4891.204Slukem		Default: no
4901.172Shubertf
4911.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4921.257Stron		detects stack overflows and aborts the program. The
4931.268Snjoly		stack protection code imposes a performance penalty
4941.259Spgoyette		of about 5%.
4951.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4961.187Schristos
4971.353SchristosNOSSP		Don't compile with stack protector during build.
4981.353Schristos		It is set internally for standalone programs.
4991.353Schristos
5001.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
5011.246Schristos		functions that do not do bounds checking regularly, but
5021.246Schristos		they could in some cases by using the gcc
5031.301Sabs		__builtin_object_size() function to determine the buffer
5041.246Schristos		size where it is known and detect buffer overflows.
5051.246Schristos		These substitute functions are in /usr/include/ssp.
5061.257Stron		Default: depends on the part of the source tree
5071.246Schristos
5081.353SchristosNOFORT		Don't compile with substitute wrappers during build.
5091.353Schristos		It is set internally for standalone programs.
5101.353Schristos
5111.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
5121.172Shubertf		various system utilities/libraries that support it.
5131.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
5141.172Shubertf
5151.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
5161.327Sapb		Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
5171.327Sapb		and use nbpigz to compress things.
5181.274Smrg		Default: "no".
5191.274Smrg
5201.172ShubertfCOPTS.lib<lib>
5211.177SmrgOBJCOPTS.lib<lib>
5221.172ShubertfLDADD.lib<lib>
5231.172ShubertfCPPFLAGS.lib<lib>
5241.172ShubertfCXXFLAGS.lib<lib>
5251.172ShubertfCOPTS.<prog>
5261.177SmrgOBJCCOPTS.<prog>
5271.172ShubertfLDADD.<prog>
5281.172ShubertfCPPFLAGS.<prog>
5291.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
5301.172Shubertf		variables in a way that applies only to a particular library
5311.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
5321.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
5331.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
5341.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
5351.172Shubertf		the crypto library.
5361.118Slukem
5371.281SjoergThe active compiler is selected using the following variables:
5381.281SjoergAVAILABLE_COMPILER
5391.281Sjoerg		List of available compiler suites.  Processed in order
5401.281Sjoerg		for selecting the active compiler for each frontend.
5411.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
5421.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
5431.281SjoergUNSUPPORTED_COMPILER.xxx
5441.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
5451.281Sjoerg
5461.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
5471.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
5481.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
5491.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
5501.281Sjoerg
5511.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
5521.1Scgd
5531.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
5541.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
5551.1Scgd
5561.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
5571.1Scgd
5581.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
5591.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
5601.17Sthorpeja few global "feature configuration" parameters.
5611.1Scgd
5621.1ScgdIt has no targets.
5631.1Scgd
5641.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
5651.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
5661.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
5671.29Scjsis included.  These files may define any of the variables described below.
5681.17Sthorpej
5691.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
5701.17Sthorpej(defaults are in brackets):
5711.15Scgd
5721.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
5731.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
5741.98Slukem		otherwise BSDSRCDIR will be used as the default.
5751.98Slukem		Various makefiles within the NetBSD source tree will
5761.98Slukem		use this to reference the top level of the source tree.
5771.98Slukem
5781.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
5791.98Slukem		based on the presence of tools/ and build.sh.  This variable
5801.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
5811.98Slukem		determined once and then propagated to all sub-makes.
5821.95Slukem
5831.305Sapb_NETBSD_VERSION_DEPENDS
5841.305Sapb		A list of files which contain information about
5851.305Sapb		the version of the NetBSD being built.  This is
5861.305Sapb		defined only if the current directory appears
5871.305Sapb		to be inside a NetBSD source tree.  The list of
5881.305Sapb		files includes ${NETBSDSRCDIR}/sys/sys/param.h
5891.305Sapb		(which contains the kernel version number),
5901.305Sapb		${NETBSDSRCDIR}/sys/conf/newvers.sh and
5911.305Sapb		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
5921.305Sapb		interpret the information in sys/sys/param.h), and
5931.305Sapb		${_SRC_TOP_OBJ_}/params (which is an optional file,
5941.305Sapb		created by "make build" in ${_SRC_TOP_}/Makefile,
5951.305Sapb		containing all the variables that may influence the
5961.305Sapb		build).
5971.305Sapb
5981.305Sapb		Targets that depend on the NetBSD version, or on
5991.305Sapb		variables defined at build time, can declare a
6001.305Sapb		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
6011.305Sapb
6021.305Sapb			version.c: ${_NETBSD_VERSION_DEPENDS}
6031.305Sapb				commands to create version.c
6041.305Sapb
6051.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
6061.116Slukem		will work correctly.  [/usr/src]
6071.15Scgd
6081.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
6091.116Slukem		will work correctly.  [/usr/obj]
6101.15Scgd
6111.116SlukemBINGRP		Binary group.  [wheel]
6121.15Scgd
6131.116SlukemBINOWN		Binary owner.  [root]
6141.15Scgd
6151.116SlukemBINMODE		Binary mode.  [555]
6161.15Scgd
6171.116SlukemNONBINMODE	Mode for non-executable files.  [444]
6181.15Scgd
6191.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
6201.15Scgd
6211.116SlukemMANGRP		Manual group.  [wheel]
6221.15Scgd
6231.116SlukemMANOWN		Manual owner.  [root]
6241.15Scgd
6251.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
6261.15Scgd
6271.222SlukemMANINSTALL	Manual installation type.  Space separated list:
6281.222Slukem			catinstall, htmlinstall, maninstall
6291.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
6301.76Sfair
6311.76SfairLDSTATIC	Control program linking; if set blank, link everything
6321.129Slukem		dynamically.  If set to "-static", link everything statically.
6331.76Sfair		If not set, programs link according to their makefile.
6341.21Schristos
6351.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
6361.15Scgd
6371.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
6381.15Scgd
6391.116SlukemLIBGRP		Library group.  [${BINGRP}]
6401.15Scgd
6411.116SlukemLIBOWN		Library owner.  [${BINOWN}]
6421.15Scgd
6431.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
6441.15Scgd
6451.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
6461.116Slukem	        installation.  [/usr/share/doc]
6471.62Ssimonb
6481.116SlukemDOCGRP		Documentation group.  [wheel]
6491.15Scgd
6501.116SlukemDOCOWN		Documentation owner.  [root]
6511.15Scgd
6521.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
6531.15Scgd
6541.335SapbGZIP_N_FLAG	Flags to pass to TOOL_GZIP to prevent it from inserting
6551.335Sapb		file names or timestamps in the compressed output.
6561.335Sapb		[-n, or -nT when TOOL_GZIP is really TOOL_PIGZ]
6571.335Sapb
6581.84SkleinkNLSDIR		Base path for Native Language Support files installation.
6591.15Scgd		[/usr/share/nls]
6601.1Scgd
6611.116SlukemNLSGRP		Native Language Support files group.  [wheel]
6621.1Scgd
6631.116SlukemNLSOWN		Native Language Support files owner.  [root]
6641.1Scgd
6651.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
6661.1Scgd
6671.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
6681.255Sapb		if that exists; otherwise /usr/xsrc]
6691.144Slukem
6701.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
6711.144Slukem
6721.221SmrgX11SRCDIR.lib<package>
6731.221SmrgX11SRCDIR.<package>
6741.221Smrg		The path to the xorg src tree for the specificed package>.
6751.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
6761.221Smrg
6771.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
6781.221Smrg		[/usr/X11R7]
6791.144Slukem
6801.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
6811.144Slukem
6821.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
6831.144Slukem
6841.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
6851.144Slukem
6861.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
6871.144Slukem
6881.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
6891.144Slukem
6901.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
6911.144Slukem
6921.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
6931.1Scgd		to be stripped.  This is to be used when building your
6941.1Scgd		own install script so that the entire system can be made
6951.146Slukem		stripped/not-stripped using a single knob.  []
6961.1Scgd
6971.2ScgdCOPY		The flag passed to the install program to cause the binary
6981.2Scgd		to be copied rather than moved.  This is to be used when
6991.2Scgd		building our own install script so that the entire system
7001.2Scgd		can either be installed with copies, or with moves using
7011.116Slukem		a single knob.  [-c]
7021.15Scgd
7031.310SapbMAKEDIRTARGETENV
7041.310Sapb		Environment variables passed to the child make process
7051.310Sapb		invoked by MAKEDIRTARGET.
7061.310Sapb
7071.150SlukemMAKEDIRTARGET dir target [params]
7081.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
7091.150Slukem		displaying a "pretty" message whilst doing so.
7101.150Slukem
7111.152SclRELEASEMACHINEDIR
7121.152Scl		Subdirectory used below RELEASEDIR when building
7131.152Scl		a release.  [${MACHINE}]
7141.152Scl
7151.152SclRELEASEMACHINE	Subdirectory or path component used for the following
7161.152Scl		paths:
7171.152Scl			distrib/${RELEASEMACHINE}
7181.152Scl			distrib/notes/${RELEASEMACHINE}
7191.152Scl			etc/etc.${RELEASEMACHINE}
7201.152Scl		Used when building a release.  [${MACHINE}]
7211.150Slukem
7221.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
7231.214Swizmake configuration file to modify the behavior of the system build
7241.17Sthorpejprocess (default values are in brackets along with comments, if set by
7251.134Slukem<bsd.own.mk>):
7261.33Sjonathan
7271.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
7281.172Shubertf		be used as part of a build in progress.
7291.172Shubertf		Supported values:
7301.172Shubertf
7311.172Shubertf		yes	Use the tools from TOOLDIR.
7321.172Shubertf			Must be set to this if cross-compiling.
7331.172Shubertf
7341.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
7351.172Shubertf			build native compilation tool components that are
7361.172Shubertf			version-specific for that tool.
7371.172Shubertf
7381.172Shubertf		never	Do not use the tools from TOOLDIR, even when
7391.172Shubertf			building native tool components.  This is similar to
7401.172Shubertf			the traditional NetBSD build method, but does not
7411.172Shubertf			verify that the compilation tools in use are
7421.172Shubertf			up-to-date enough in order to build the tree
7431.172Shubertf			successfully.  This may cause build or runtime
7441.172Shubertf			problems when building the whole NetBSD source tree.
7451.172Shubertf
7461.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
7471.172Shubertf		source tree (detected automatically); "no" otherwise
7481.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
7491.172Shubertf		make(1) include files).
7501.142Slukem
7511.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
7521.199Ssimonb		use ELF -- currently all architectures].
7531.33Sjonathan
7541.103SthorpejTOOLCHAIN_MISSING
7551.142Slukem		If not "no", this indicates that the platform being built
7561.103Sthorpej		does not have a working in-tree toolchain.  If the
7571.142Slukem		${MACHINE_ARCH} in question falls into this category,
7581.301Sabs		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
7591.103Sthorpej		Otherwise, the variable is unconditionally assigned the
7601.103Sthorpej		value "no".
7611.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
7621.142Slukem		unconditionally assigned the value "no".
7631.103Sthorpej
7641.103SthorpejEXTERNAL_TOOLCHAIN
7651.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
7661.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
7671.103Sthorpej		access to this variable.  The variable should be defined
7681.103Sthorpej		either in the user's environment or in the user's mk.conf
7691.103Sthorpej		file.  If defined, this variable indicates the root of
7701.103Sthorpej		an external toolchain which will be used to build the
7711.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
7721.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
7731.103Sthorpej		cross-compile framework.
7741.103Sthorpej
7751.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
7761.142Slukem		assigned the value "no", since the external version of the
7771.142Slukem		compiler may not be able to build the library components of
7781.142Slukem		the in-tree compiler.
7791.103Sthorpej
7801.103Sthorpej		NOTE: This variable is not yet used in as many places as
7811.103Sthorpej		it should be.  Expect the exact semantics of this variable
7821.103Sthorpej		to change in the short term as parts of the cross-compile
7831.103Sthorpej		framework continue to be cleaned up.
7841.1Scgd
7851.236SapbThe following variables are defined to commands to perform the
7861.236Sapbappropriate operation, with the default in [brackets].  Note that
7871.236Sapbthe defaults change if USETOOLS == "yes":
7881.236Sapb
7891.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
7901.236Sapb
7911.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
7921.236Sapb
7931.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
7941.236Sapb
7951.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
7961.236Sapb
7971.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
7981.236Sapb
7991.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
8001.236Sapb
8011.236SapbTOOL_CAT		Concatenate and print files.  [cat]
8021.236Sapb
8031.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
8041.236Sapb
8051.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
8061.236Sapb
8071.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
8081.236Sapb
8091.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
8101.236Sapb
8111.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
8121.236Sapb
8131.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
8141.236Sapb
8151.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
8161.236Sapb
8171.236SapbTOOL_EQN		Format equations for groff.  [eqn]
8181.236Sapb
8191.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
8201.236Sapb
8211.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
8221.236Sapb
8231.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
8241.236Sapb
8251.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
8261.236Sapb
8271.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
8281.236Sapb
8291.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
8301.247Ssketch
8311.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
8321.236Sapb
8331.327SapbTOOL_GZIP		Compression/decompression tool.  [gzip]
8341.327Sapb
8351.335SapbTOOL_GZIP_N		Same as TOOL_GZIP, plus a command line option to
8361.335Sapb			prevent it from inserting file names or timestamps
8371.335Sapb			into the compressed output.
8381.335Sapb			[${TOOL_GZIP} ${GZIP_N_FLAG}]
8391.335Sapb
8401.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
8411.236Sapb
8421.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
8431.236Sapb
8441.328SskrllTOOL_HPPAMKBOOT		Make bootable image for hppa.  [hppa-mkboot]
8451.236Sapb
8461.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
8471.236Sapb
8481.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
8491.236Sapb
8501.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
8511.236Sapb
8521.236SapbTOOL_JOIN		Relational database operator.  [join]
8531.236Sapb
8541.236SapbTOOL_M4			M4 macro language processor.  [m4]
8551.236Sapb
8561.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
8571.236Sapb
8581.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
8591.236Sapb
8601.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
8611.236Sapb
8621.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
8631.236Sapb
8641.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
8651.236Sapb
8661.236SapbTOOL_MENUC		Menu compiler.  [menuc]
8671.236Sapb
8681.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
8691.236Sapb			[mips-elf2ecoff]
8701.236Sapb
8711.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
8721.236Sapb
8731.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
8741.236Sapb
8751.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
8761.236Sapb
8771.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
8781.236Sapb
8791.311SjmcneillTOOL_MKNOD		Make device special file.  [mknod]
8801.311Sjmcneill
8811.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
8821.236Sapb
8831.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
8841.236Sapb
8851.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
8861.236Sapb
8871.332SphxTOOL_NCDCS		Turn ELF kernel into a NCD firmware image. [ncdcs]
8881.332Sphx
8891.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
8901.236Sapb
8911.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
8921.236Sapb
8931.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
8941.273Smrg
8951.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
8961.236Sapb
8971.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
8981.236Sapb
8991.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
9001.236Sapb
9011.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
9021.236Sapb
9031.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
9041.236Sapb
9051.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
9061.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
9071.236Sapb
9081.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
9091.236Sapb
9101.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
9111.236Sapb
9121.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
9131.236Sapb
9141.236SapbTOOL_SED		Stream editor.  [sed]
9151.236Sapb
9161.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
9171.236Sapb
9181.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
9191.236Sapb			[sparkcrc]
9201.236Sapb
9211.236SapbTOOL_STAT		Display file status.  [stat]
9221.236Sapb
9231.236SapbTOOL_STRFILE		Create a random access file for storing strings.
9241.236Sapb			[strfile]
9251.236Sapb
9261.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
9271.236Sapb
9281.236SapbTOOL_TBL		Format tables for groff.  [tbl]
9291.236Sapb
9301.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
9311.236Sapb
9321.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
9331.236Sapb
9341.236SapbTOOL_ZIC		Time zone compiler.  [zic]
9351.236Sapb
9361.323SmattFor each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
9371.323Smattlist of what ports can be built for it.  This keeps those definitions in
9381.323Smattcentralized place.
9391.323Smatt
9401.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
9411.1Scgdthey use the same default owners etc. as the rest of the tree.
9421.131Slukem
9431.131Slukem
9441.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
9451.286Sapb
9461.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
9471.286Sapbtargets.  It uses the following variables:
9481.286Sapb
9491.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
9501.286Sapb
9511.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
9521.286Sapb		the clean target.
9531.286Sapb
9541.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
9551.287Sapb		will delete files from both the object directory,
9561.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
9571.287Sapb
9581.287Sapb		If MKCLEANSRC is set to "no", then the file names in
9591.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
9601.287Sapb		to the object directory, ${.OBJDIR}.  This is the
9611.287Sapb		traditional behaviour.
9621.287Sapb
9631.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
9641.287Sapb		is performed relative to both the object directory,
9651.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
9661.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
9671.287Sapb		Deleting files from ${.CURDIR} is intended to remove
9681.287Sapb		stray output files that had been left in the source
9691.287Sapb		directory by an earlier build that did not use object
9701.287Sapb		directories.
9711.287Sapb
9721.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
9731.287Sapb		separate object directories, and you are sure that there
9741.287Sapb		are no stray files in the source directories, then you
9751.287Sapb		may set MKCLEANSRC=no to save some time.
9761.287Sapb
9771.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
9781.287Sapb		will verify that files have been deleted.
9791.287Sapb
9801.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
9811.287Sapb		be deleted using a "rm -f" command, and its success or
9821.287Sapb		failure will be ignored.
9831.287Sapb
9841.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
9851.287Sapb		the "rm -f" command will be verified using an "ls"
9861.287Sapb		command.
9871.287Sapb
9881.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
9891.287Sapb		there will be no problems caused by file permissions,
9901.287Sapb		read-only file systems, or the like, then you may set
9911.287Sapb		MKCLEANVERIFY=no to save some time.
9921.286Sapb
9931.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
9941.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
9951.286Sapbor CLEANDIRFILES variables.  For example:
9961.286Sapb
9971.286Sapb	    CLEANFILES+= a.out
9981.286Sapb	    CLEANDIRFILES+= .depend
9991.286Sapb
10001.286Sapb	    .include <bsd.clean.mk>
10011.286Sapb
10021.308SapbThe files listed in CLEANFILES and CLEANDIRFILES must not be
10031.308Sapbdirectories, because the potential risk from running "rm -rf" commands
10041.308Sapbin bsd.clean.mk is considered too great.  If you want to recursively
10051.308Sapbdelete a directory as part of "make clean" or "make cleandir" then you
10061.308Sapbneed to provide your own target.
10071.286Sapb
10081.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
10091.131Slukem
10101.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
10111.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
10121.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
10131.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
10141.133Slukemdependencies for the .d files.  In order for this to function correctly,
10151.132Slukemit should be .included after all other .mk files and directives that may
10161.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
10171.132Slukem
10181.132SlukemSRCS		List of source files to build the program.
10191.132Slukem
10201.132SlukemDPSRCS		List of source files which are needed for generating
10211.132Slukem		dependencies, but are not needed in ${SRCS}.
10221.1Scgd
10231.1Scgd
10241.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
10251.106Sthorpej
10261.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
10271.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
10281.124Slukem
10291.124SlukemFILES		The list of files to install.
10301.124Slukem
10311.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
10321.153Slukem		are installed by the `configinstall' target,
10331.153Slukem		not the `install' target.
10341.153Slukem		The FILES* variables documented below also apply.
10351.153Slukem
10361.124SlukemFILESOWN	File owner.  [${BINOWN}]
10371.124Slukem
10381.124SlukemFILESGRP	File group.  [${BINGRP}]
10391.124Slukem
10401.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
10411.124Slukem
10421.124SlukemFILESDIR	The location to install the files.
10431.124Slukem
10441.124SlukemFILESNAME	Optional name to install each file as.
10451.124Slukem
10461.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
10471.153Slukem
10481.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
10491.153Slukem
10501.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
10511.153Slukem
10521.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
10531.153Slukem
10541.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
10551.124Slukem
10561.285SapbFILESBUILD	If this variable is defined, then its value will be
10571.285Sapb		used as the default for all FILESBUILD_<fn> variables.
10581.285Sapb		Otherwise, the default will be "no".
10591.285Sapb
10601.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
10611.243Scube		targets to be built by `realall'.  Users of that variable
10621.243Scube		should provide a target to build the file.
10631.243Scube
10641.135Slukem
10651.139SlukemBUILDSYMLINKS	List of two word items:
10661.135Slukem			lnsrc lntgt
10671.135Slukem		For each lnsrc item, create a symlink named lntgt.
10681.135Slukem		The lntgt symlinks are removed by the cleandir target.
10691.106Sthorpej
10701.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
10711.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
10721.301Sabs		The source files have a `.uue' suffix, the generated files do
10731.148Sjmc		not.
10741.149Sjmc
10751.202SuweUUDECODE_FILES_RENAME_<fn>
10761.202Suwe		Rename the output from the decode to the provided name.
10771.148Sjmc		
10781.148Sjmc		*NOTE: These files are simply decoded, with no install or other
10791.148Sjmc		       rule applying implicitly except being added to the clean
10801.148Sjmc		       target.
10811.106Sthorpej
10821.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
10831.113Sthorpej
10841.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
10851.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
10861.134Slukembefore <bsd.gcc.mk>.
10871.113Sthorpej
10881.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
10891.113Sthorpejof which need to know where to find certain GCC support libraries.
10901.113Sthorpej
10911.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
10921.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
10931.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
10941.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
10951.113Sthorpej
10961.134Slukem<bsd.gcc.mk> sets the following variables:
10971.113Sthorpej
10981.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
10991.118Slukem
11001.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
11011.118Slukem
11021.118Slukem_GCC_CRTEND	The full path name to crtend.o.
11031.118Slukem
11041.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
11051.118Slukem
11061.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
11071.118Slukem
11081.118Slukem
11091.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
11101.118Slukem
11111.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
11121.118Slukemvariables:
11131.118Slukem
11141.124SlukemINCS		The list of include files.
11151.118Slukem
11161.118SlukemINCSDIR		The location to install the include files.
11171.118Slukem
11181.118SlukemINCSNAME	Target name of the include file, if only one; same as
11191.118Slukem		FILESNAME, but for include files.
11201.118Slukem
11211.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
11221.134Slukem		are installed in the 'includes' target and not the
11231.134Slukem		(much later) 'install' target.
11241.134Slukem
11251.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
11261.118Slukem		same as FILESNAME_<file>, but for include files.
11271.118Slukem
11281.118Slukem
11291.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
11301.118Slukem
11311.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
11321.118Slukemdocumentation from respective Texinfo source files.  It defines three
11331.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
11341.118Slukemfollowing variables:
11351.118Slukem
11361.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
11371.118Slukem		consist of single files with the extension replaced by
11381.118Slukem		.info.
11391.118Slukem
11401.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
11411.118Slukem
11421.118Slukem
11431.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
11441.118Slukem
11451.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
11461.118Slukemlocation of kernel sources and object directories.
11471.118Slukem
11481.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
11491.124Slukem		[${_SRC_TOP_}/sys]
11501.118Slukem
11511.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
11521.124Slukem		[arch/${MACHINE}]
11531.120Slukem
11541.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
11551.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
11561.118Slukem
11571.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
11581.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
11591.118Slukem		The default value is
11601.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
11611.118Slukem		if it exists or the target 'obj' is being made.
11621.118Slukem		Otherwise the default is
11631.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
11641.118Slukem
11651.118SlukemIt is important that Makefiles (such as those under src/distrib) that
11661.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
11671.118Slukemrather than make assumptions about the location of the compiled kernel.
11681.118Slukem
11691.118Slukem
11701.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
11711.118Slukem
11721.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
11731.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
11741.118Slukeminclude file installation.  It is intended to be included alone, by
11751.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
11761.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
11771.134Slukemin that file up to date.
11781.118Slukem
11791.325Schristos=-=-=-=-=   bsd.syscall.mk =-=-=-=-=
11801.325Schristos
11811.325SchristosThe include file <bsd.syscall.mk> contains the logic to create syscall
11821.325Schristosfiles for various emulations. It includes <bsd.kinc.mk> to handle the
11831.325Schristosrest of the targets.
11841.118Slukem
11851.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
11861.118Slukem
11871.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
11881.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
11891.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
11901.118Slukemwhich checks for installed shared object libraries whose version is greater
11911.118Slukemthat the version of the source. It has a limited number of suffixes,
11921.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
11931.118Slukem<bsd.shlib.mk> to get shared library parameters.
11941.118Slukem
11951.118SlukemIt sets/uses the following variables:
11961.118Slukem
11971.118SlukemLIB		The name of the library to build.
11981.118Slukem
11991.118SlukemLIBDIR		Target directory for libraries.
12001.118Slukem
12011.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
12021.248Sperry		permissions in files inside its archives to those of
12031.248Sperry		the file it was fed. This leads to non-reproduceable
12041.324Sapb		builds. If MKARZERO is set to "yes" (default is the
12051.324Sapb		same as MKREPRO, or "no" if MKREPRO is not defined),
12061.248Sperry		then the "D" flag is passed to ar, causing the
12071.248Sperry		timestamp, uid and gid to be zeroed and the file
12081.248Sperry		permissions to be set to 644. This allows .a files
12091.248Sperry		from different builds to be bit identical.
12101.248Sperry
12111.300SjoergSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
12121.300Sjoerg		is not "no".
12131.300Sjoerg
12141.263SabsSHLIB_MAJOR
12151.263SabsSHLIB_MINOR
12161.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
12171.263Sabs
12181.300SjoergUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
12191.118Slukem		as the path to install shared libraries to.
12201.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
12211.130Slukem		Default: no
12221.118Slukem
12231.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
12241.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
12251.218Slukem		MKPROFILE=no MKSTATICLIB=no".
12261.218Slukem		Default: no
12271.218Slukem
12281.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
12291.211Slukem		MKPROFILE=no", and don't install the (.a) library.
12301.154Slukem		This is useful for "build only" helper libraries.
12311.154Slukem		Default: no
12321.154Slukem
12331.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
12341.244Smrg		shared libraries.
12351.244Smrg		This is useful for C++ libraries.
12361.244Smrg		Default: no
12371.244Smrg
12381.118SlukemLINTLIBDIR	Target directory for lint libraries.
12391.118Slukem
12401.118SlukemLIBGRP		Library group.
12411.118Slukem
12421.118SlukemLIBOWN		Library owner.
12431.118Slukem
12441.118SlukemLIBMODE		Library mode.
12451.118Slukem
12461.118SlukemLDADD		Additional loader objects.
12471.118Slukem
12481.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12491.118Slukem
12501.118SlukemNOCHECKVER_<library>
12511.118SlukemNOCHECKVER	If set, disables checking for installed shared object
12521.118Slukem		libraries with versions greater than the source.  A
12531.118Slukem		particular library name, without the "lib" prefix, may
12541.118Slukem		be appended to the variable name to disable the check for
12551.118Slukem		only that library.
12561.118Slukem
12571.118SlukemSRCS		List of source files to build the library.  Suffix types
12581.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
12591.118Slukem		to .c files of the same name.  (This is not the default for
12601.118Slukem		versions of make.)
12611.118Slukem
12621.157SlukemLIBDPLIBS	A list of the tuples:
12631.157Slukem			libname  path-to-srcdir-of-libname
12641.157Slukem
12651.157Slukem		For each tuple;
12661.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
12671.157Slukem			`libname', and if it is not set it is determined
12681.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
12691.157Slukem			latter is to allow for build time optimization).
12701.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
12711.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
12721.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
12731.157Slukem
12741.307Spooka		The special value "_external" for LIBDO.lib makes the
12751.307Spooka		build system to assume the library comes from outside
12761.307Spooka		of the NetBSD source tree and only causes -llibname
12771.307Spooka		to be added to LDADD.
12781.307Spooka
12791.157Slukem		This variable may be used for individual libraries, as
12801.301Sabs		well as in parent directories to cache common libraries
12811.157Slukem		as a build-time optimization.
12821.157Slukem
12831.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
12841.118Slukemif it exists, as well as the include file <bsd.man.mk>.
12851.118Slukem
12861.118SlukemIt has rules for building profiled objects; profiled libraries are
12871.118Slukembuilt by default.
12881.118Slukem
12891.118SlukemLibraries are ranlib'd when made.
12901.118Slukem
12911.118Slukem
12921.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
12931.118Slukem
12941.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
12951.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
12961.134Slukem
12971.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
12981.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
12991.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
13001.249Sapbby a method for explicitly recording hard links in a metadata log.
13011.249Sapb
13021.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
13031.134Slukem			source-file target-file
13041.134Slukem		${DESTDIR} is prepended to both paths before linking.
13051.134Slukem		For example, to link /bin/test and /bin/[, use:
13061.134Slukem			LINKS=/bin/test /bin/[
13071.134Slukem
13081.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
13091.153Slukem		are installed by the `configinstall' target,
13101.153Slukem		not the `install' target.
13111.153Slukem
13121.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
13131.134Slukem			source-file target-file
13141.134Slukem		${DESTDIR} is only prepended to target-file before linking.
13151.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
13161.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
13171.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
13181.118Slukem
13191.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
13201.153Slukem		are installed by the `configinstall' target,
13211.153Slukem		not the `install' target.
13221.153Slukem
13231.249SapbLINKSOWN	Link owner.  [${BINOWN}]
13241.249Sapb
13251.249SapbLINKSGRP	Link group.  [${BINGRP}]
13261.249Sapb
13271.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
13281.249Sapb
13291.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
13301.249Sapb
13311.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
13321.249Sapb
13331.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
13341.249Sapb
13351.118Slukem
13361.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
13371.118Slukem
13381.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
13391.118Slukemlinks.
13401.118Slukem
13411.222SlukemIt has a three targets:
13421.118Slukem
13431.222Slukem	catinstall:
13441.222Slukem		Install the preformatted manual pages and their links.
13451.222Slukem	htmlinstall:
13461.222Slukem		Install the HTML manual pages and their links.
13471.118Slukem	maninstall:
13481.118Slukem		Install the manual page sources and their links.
13491.118Slukem
13501.118SlukemIt sets/uses the following variables:
13511.118Slukem
13521.118SlukemMANDIR		Base path for manual installation.
13531.118Slukem
13541.118SlukemMANGRP		Manual group.
13551.118Slukem
13561.118SlukemMANOWN		Manual owner.
13571.118Slukem
13581.118SlukemMANMODE		Manual mode.
13591.118Slukem
13601.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
13611.118Slukem		or "/tahoe" for machine specific manual pages.
13621.118Slukem
13631.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
13641.118Slukem
13651.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
13661.118Slukem		linked-to file must come first, the linked file second,
13671.276Sreed		and there may be multiple pairs.
13681.118Slukem
13691.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
13701.118Slukemit exists.
13711.118Slukem
13721.118Slukem
13731.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
13741.118Slukem
13751.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
13761.118Slukemand use of separated object and source directories.
13771.118Slukem
13781.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
13791.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
13801.118Slukemit exists.  Otherwise make(1) looks for the existence of a
13811.118Slukemsubdirectory (or a symlink to a directory) of the source directory
13821.118Slukeminto which built targets should be placed.  If an environment variable
13831.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
13841.118Slukemobject directory; failing that, make first looks for a subdirectory
13851.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
13861.118Slukem
13871.118SlukemObject directories are not created automatically by make(1) if they
13881.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
13891.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
13901.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
13911.118Slukemand this is determined by a simple string prefix comparison -- object
13921.118Slukemdirectories are created in a separate object directory tree, and a
13931.118Slukemsymlink to the object directory in that tree is created in the source
13941.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
13951.118Slukemsource tree and that it's not safe to use a separate object tree.
13961.118Slukem
13971.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
13981.118Slukemdirectories and links get created during a "make obj":
13991.118Slukem
14001.118SlukemMAKEOBJDIR	If set, this is the component name of the object
14011.118Slukem		directory.
14021.118Slukem
14031.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
14041.118Slukem		object directories or links named "obj.${MACHINE}";
14051.118Slukem		otherwise, just creates ones named "obj".
14061.118Slukem
14071.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
14081.118Slukem		${BSDSRCDIR}, create object directory in the
14091.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
14101.118Slukem		otherwise, create it in the corresponding subdirectory
14111.118Slukem		of ${BSDOBJDIR}
14121.113Sthorpej
14131.118SlukemBUILDID		If set, the contents of this variable are appended
14141.118Slukem		to the object directory name.  If OBJMACHINE is also
14151.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
14161.113Sthorpej
14171.106Sthorpej
14181.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
14191.106Sthorpej
14201.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
14211.1Scgdmore source files, along with their manual pages.  It has a limited number
14221.301Sabsof suffixes, consistent with the current needs of the BSD tree.
14231.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
14241.1Scgd
14251.16SjtcIt has eight targets:
14261.1Scgd
14271.1Scgd	all:
14281.102Sthorpej		build the program and its manual page.  This also
14291.102Sthorpej		creates a GDB initialization file (.gdbinit) in
14301.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
14311.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
14321.1Scgd	clean:
14331.1Scgd		remove the program, any object files and the files a.out,
14341.24Smikel		Errs, errs, mklog, and ${PROG}.core.
14351.1Scgd	cleandir:
14361.1Scgd		remove all of the files removed by the target clean, as
14371.1Scgd		well as .depend, tags, and any manual pages.
14381.42Slukem		`distclean' is a synonym for `cleandir'.
14391.1Scgd	depend:
14401.1Scgd		make the dependencies for the source files, and store
14411.1Scgd		them in the file .depend.
14421.16Sjtc	includes:
14431.16Sjtc		install any header files.
14441.1Scgd	install:
14451.1Scgd		install the program and its manual pages; if the Makefile
14461.1Scgd		does not itself define the target install, the targets
14471.1Scgd		beforeinstall and afterinstall may also be used to cause
14481.1Scgd		actions immediately before and after the install target
14491.1Scgd		is executed.
14501.1Scgd	lint:
14511.1Scgd		run lint on the source files
14521.1Scgd	tags:
14531.1Scgd		create a tags file for the source files.
14541.1Scgd
14551.1ScgdIt sets/uses the following variables:
14561.1Scgd
14571.1ScgdBINGRP		Binary group.
14581.1Scgd
14591.1ScgdBINOWN		Binary owner.
14601.1Scgd
14611.1ScgdBINMODE		Binary mode.
14621.1Scgd
14631.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
14641.286Sapb
14651.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
14661.1Scgd
14671.337SuebayasiCONFIGOPTS	Additional flags to config(1) when building kernels.
14681.337Suebayasi
14691.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
14701.112Sthorpej
14711.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
14721.125Slukem		C objects for <fn>.
14731.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14741.125Slukem
14751.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
14761.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
14771.35Slukem
14781.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
14791.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14801.125Slukem
14811.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
14821.125Slukem
14831.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
14841.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14851.102Sthorpej
14861.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
14871.102Sthorpej		directives in the .gdbinit file that is created in the
14881.102Sthorpej		objdir.
14891.1Scgd
14901.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
14911.1Scgd		For example, to load with the compatibility and utility
14921.1Scgd		libraries, use:
14931.1Scgd
14941.5Sjtc			LDADD+=-lutil -lcompat
14951.1Scgd
14961.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
14971.1Scgd
14981.134SlukemLINKS		See <bsd.links.mk>
14991.134Slukem
15001.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
15011.177Smrg
15021.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
15031.177Smrg		ObjC objects for <fn>.
15041.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
15051.177Smrg
15061.134SlukemSYMLINKS	See <bsd.links.mk>
15071.1Scgd
15081.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
15091.8Scgd		defined, "MAN=${PROG}.1" is assumed.
15101.1Scgd
15111.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
15121.212Slukem		time, with the value of this variable as args to paxctl(1).
15131.193Sperry
15141.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
15151.193Sperry
15161.1ScgdPROG		The name of the program to build.  If not supplied, nothing
15171.1Scgd		is built.
15181.1Scgd
15191.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
15201.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
15211.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
15221.88Sthorpej		the value of PROG if PROG is also set.
15231.87Sthorpej
15241.21SchristosPROGNAME	The name that the above program will be installed as, if
15251.21Schristos		different from ${PROG}.
15261.21Schristos
15271.37StvSRCS		List of source files to build the program.  If SRCS is not
15281.1Scgd		defined, it's assumed to be ${PROG}.c.
15291.108Sjwise
15301.108SjwiseDPSRCS		List of source files which are needed for generating
15311.108Sjwise		dependencies, but are not needed in ${SRCS}.
15321.1Scgd
15331.1ScgdDPADD		Additional dependencies for the program.  Usually used for
15341.1Scgd		libraries.  For example, to depend on the compatibility and
15351.1Scgd		utility libraries use:
15361.1Scgd
15371.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
15381.1Scgd
15391.288Schristos		The following system libraries are predefined for DPADD:
15401.1Scgd
15411.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
15421.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
15431.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
15441.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
15451.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
15461.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
15471.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
15481.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
15491.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
15501.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
15511.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
15521.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
15531.322Sjoerg		LIBCRTI?=	${DESTDIR}/usr/lib/crti.o
15541.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
15551.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
15561.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
15571.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
15581.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
15591.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
15601.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
15611.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
15621.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
15631.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
15641.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
15651.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
15661.315Schristos		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
15671.315Schristos		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
15681.347Schristos		LIBEXECINFO?=	${DESTDIR}/usr/lib/libexecinfo.a
15691.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
15701.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
15711.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
15721.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
15731.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
15741.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
15751.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
15761.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
15771.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
15781.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
15791.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
15801.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
15811.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
15821.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
15831.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
15841.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
15851.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
15861.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
15871.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
15881.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
15891.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
15901.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
15911.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
15921.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
15931.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
15941.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
15951.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
15961.313Sjmmv		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
15971.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
15981.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
15991.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
16001.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
16011.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
16021.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
16031.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
16041.348Skamil		LIBPANEL?=	${DESTDIR}/usr/lib/libpanel.a
16051.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
16061.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
16071.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
16081.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
16091.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
16101.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
16111.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
16121.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
16131.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
16141.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
16151.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
16161.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
16171.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
16181.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
16191.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
16201.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
16211.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
16221.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
16231.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
16241.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
16251.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
16261.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
16271.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
16281.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
16291.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
16301.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
16311.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
16321.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
16331.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
16341.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
16351.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
16361.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
16371.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
16381.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
16391.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
16401.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
16411.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
16421.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
16431.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
16441.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
16451.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
16461.355Schristos		LIBUNBOUND?=	${DESTDIR}/usr/lib/libunbound.a
16471.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
16481.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
16491.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
16501.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
16511.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
16521.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
16531.1Scgd
16541.288Schristos		The following X-Windows libraries are predefined for DPADD:
16551.288Schristos
16561.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
16571.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
16581.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
16591.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
16601.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
16611.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
16621.317Smrg		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
16631.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
16641.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
16651.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
16661.320Schristos		LIBXCB?=	${DESTDIR}/usr/X11R7/lib/libxcb.a
16671.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
16681.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
16691.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
16701.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
16711.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
16721.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
16731.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
16741.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
16751.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
16761.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
16771.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
16781.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
16791.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
16801.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
16811.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
16821.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
16831.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
16841.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
16851.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
16861.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
16871.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
16881.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
16891.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
16901.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
16911.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
16921.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
16931.288Schristos
16941.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
16951.12Schristos		strings, using xstr(1). Note that this will not work with
16961.12Schristos		parallel makes.
16971.1Scgd
16981.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
16991.1Scgd		to be stripped.
17001.1Scgd
17011.1ScgdSUBDIR		A list of subdirectories that should be built as well.
17021.1Scgd		Each of the targets will execute the same target in the
17031.1Scgd		subdirectories.
17041.1Scgd
17051.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
17061.21Schristos		These are installed exactly like programs.
17071.21Schristos
17081.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
17091.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
17101.166Srtr
17111.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
17121.21Schristos		different from ${SCRIPTS}. These can be further specialized
17131.21Schristos		by setting SCRIPTSNAME_<script>.
17141.21Schristos
17151.124SlukemFILES		See description of <bsd.files.mk>.
17161.21Schristos
17171.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
17181.106Sthorpej		<bsd.own.mk> for additional information about this variable.
17191.130Slukem
17201.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
17211.1Scgdif it exists, as well as the include file <bsd.man.mk>.
17221.1Scgd
17231.1ScgdSome simple examples:
17241.1Scgd
17251.1ScgdTo build foo from foo.c with a manual page foo.1, use:
17261.1Scgd
17271.1Scgd	PROG=	foo
17281.1Scgd
17291.1Scgd	.include <bsd.prog.mk>
17301.1Scgd
17311.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
17321.1Scgd
17331.9Scgd	MAN=	foo.2
17341.1Scgd
17351.1ScgdIf foo does not have a manual page at all, add the line:
17361.1Scgd
17371.75Sagc	MKMAN=	no
17381.1Scgd
17391.1ScgdIf foo has multiple source files, add the line:
17401.1Scgd
17411.1Scgd	SRCS=	a.c b.c c.c d.c
17421.1Scgd
17431.1Scgd
17441.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
17451.118Slukem
17461.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
17471.118Slukemconstruct source files built by rpcgen.
17481.72Ssommerfe
17491.118SlukemThe following macros may be defined in makefiles which include
17501.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
17511.118Slukemare to be built:
17521.21Schristos
17531.118SlukemRPC_INCS:	construct .h file from .x file
17541.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
17551.118Slukem		(for marshalling/unmarshalling data types)
17561.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
17571.118Slukem		(server-side stubs)
17581.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
17591.21Schristos
17601.118SlukemRPC_XDIR:	Directory containing .x/.h files
17611.23Schristos
17621.23Schristos
17631.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
17641.21Schristos
17651.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
17661.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
17671.134Slukemincluded before <bsd.shlib.mk>.
17681.21Schristos
17691.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
17701.118Slukem(defaults are in brackets):
17711.21Schristos
17721.300SjoergSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
17731.300Sjoerg		instead of ${LIBDIR} as the base path for shared library
17741.300Sjoerg		installation.  [/lib]
17751.300Sjoerg
17761.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
17771.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
17781.118Slukem		for all others.]
17791.81Swiz
17801.300Sjoerg_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
17811.118Slukem		otherwise set to ${LIBDIR}
17821.81Swiz
17831.300SjoergSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
17841.300Sjoerg
17851.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
17861.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
17871.118Slukem		all others.]
17881.39Scgd
17891.13Schristos
17901.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
17911.13Schristos
17921.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
17931.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
17941.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
17951.233Sapbfollowing variables:
17961.233Sapb
17971.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
17981.233Sapb		will be ignored and subdirectories will not be processed.
17991.233Sapb
18001.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
18011.233Sapb		specified directory will be visited and the target made.
18021.233Sapb
18031.233Sapb		As a special case, the use of a token .WAIT as an
18041.233Sapb		entry in SUBDIR acts as a synchronization barrier
18051.233Sapb		when multiple make jobs are run; subdirs before the
18061.233Sapb		.WAIT must complete before any subdirs after .WAIT are
18071.233Sapb		started.  See make(1) for some caveats on use of .WAIT
18081.233Sapb		and other special sources.
18091.47Stv
18101.47Stv
18111.326Schristos=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
18121.326Schristos
18131.326SchristosThe include file <bsd.x11.mk> contains parameters and targets for
18141.346Smrgcross-building X11 from ${X11SRCDIR.<package>}.  It should be included
18151.346Smrgafter the general Makefile contents but before the include files such as
18161.346Smrg<bsd.prog.mk> and <bsd.lib.mk>.
18171.326Schristos
18181.326SchristosIt provides the following targets:
18191.326Schristos	.man.1 .man.3 .man.4 .man.5 .man.7:
18201.326Schristos		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
18211.326Schristos		these rules convert from X11's manual page source
18221.326Schristos		into an mdoc.old source file.
18231.326Schristos
18241.326SchristosIt sets the following variables:
18251.326Schristos
18261.326SchristosBINDIR			Set to ${X11BINDIR}.
18271.326Schristos			To override, define after including <bsd.x11.mk>
18281.326Schristos
18291.326SchristosLIBDIR			Set to ${X11USRLIBDIR}.
18301.326Schristos			To override, define after including <bsd.x11.mk>
18311.326Schristos
18321.326SchristosMANDIR			Set to ${X11MANDIR}.
18331.326Schristos			To override, define after including <bsd.x11.mk>
18341.326Schristos
18351.326SchristosCPPFLAGS		Appended with definitions to include from
18361.326Schristos			${DESTDIR}${X11INCDIR}
18371.326Schristos
18381.326SchristosLDFLAGS			Appended with definitions to link from
18391.326Schristos			${DESTDIR}${X11USRLIBDIR}
18401.326Schristos
18411.326SchristosX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
18421.326Schristos
18431.326SchristosX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
18441.326Schristos
18451.326SchristosX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
18461.326Schristos
18471.326SchristosX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
18481.326Schristos
18491.326SchristosX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
18501.326Schristos
18511.326SchristosX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18521.326Schristos
18531.326SchristosX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
18541.326Schristos
18551.326SchristosX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
18561.326Schristos
18571.326SchristosX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
18581.326Schristos
18591.326SchristosX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
18601.326Schristos
18611.326SchristosIt uses the following variables:
18621.326Schristos
18631.326SchristosAPPDEFS			List of app-default files to install.
18641.326Schristos
18651.326SchristosCPPSCRIPTS		List of files/scripts to run through cpp(1)
18661.326Schristos			and then ${X11TOOL_UNXCOMM}.  The source files
18671.326Schristos			have a `.cpp' suffix, the generated files do not.
18681.326Schristos
18691.326SchristosCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
18701.326Schristos
18711.326SchristosCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
18721.326Schristos
18731.326Schristos
18741.326Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
18751.326Schristos
18761.326SchristosThe following files are described here for completion, but they are not
18771.326Schristossupposed to be included directly from other Makefiles; they are used
18781.326Schristosinternally by other system files.
18791.326Schristos
18801.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
18811.47Stv
18821.326SchristosThe include file <bsd.sys.mk> is used by other system mk files and
18831.326Schristosit is not intended to be included standalone. It contains rules and
18841.326Schristossystem build variables. It requires bsd.own.mk to be included first.
18851.326SchristosIt contains overrides that are used when building the NetBSD source tree.
18861.133Slukem
18871.133SlukemThe following variables control how various files are compiled/built.
18881.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
18891.133Slukem
18901.133SlukemAR		Create, modify, and extract from archives.  [ar]
18911.133Slukem
18921.133SlukemARFLAGS		Options to ${AR}.  [rl]
18931.133Slukem
18941.151SlukemAS		Assembler.  [as]
18951.151Slukem
18961.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
18971.211Slukem		assembly source files.  []
18981.151Slukem
18991.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
19001.217Sjoerg		If this option is present, seed the random number
19011.217Sjoerg		generator based on the value, source file names and
19021.217Sjoerg		the output file name to make builds more deterministic.
19031.217Sjoerg		Additional information is available in the GCC
19041.217Sjoerg		documentation of -frandom-seed.
19051.217Sjoerg
19061.133SlukemCC		C compiler.  [cc]
19071.133Slukem
19081.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
19091.133Slukem
19101.133SlukemCPP		C Pre-Processor.  [cpp]
19111.133Slukem
19121.133SlukemCPPFLAGS	Options to ${CPP}.  []
19131.133Slukem
19141.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
19151.133Slukem
19161.133SlukemCXX		C++ compiler.  [c++]
19171.133Slukem
19181.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
19191.133Slukem
19201.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
19211.133Slukem
19221.133SlukemFC		Fortran compiler.  [f77]
19231.133Slukem
19241.133SlukemFFLAGS		Options to {$FC}.  [-O]
19251.133Slukem
19261.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
19271.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
19281.235Sapb
19291.133SlukemINSTALL		install(1) command.  [install]
19301.133Slukem
19311.133SlukemLEX		Lexical analyzer.  [lex]
19321.133Slukem
19331.133SlukemLFLAGS		Options to ${LEX}.  []
19341.133Slukem
19351.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
19361.145Sjwise
19371.133SlukemLD		Linker.  [ld]
19381.133Slukem
19391.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
19401.133Slukem
19411.133SlukemLINT		C program verifier.  [lint]
19421.133Slukem
19431.330SchristosLINTFLAGS	Options to ${LINT}.  [-chapbxzgFS]
19441.133Slukem
19451.133SlukemLORDER		List dependencies for object files.  [lorder]
19461.133Slukem
19471.133SlukemMAKE		make(1).  [make]
19481.133Slukem
19491.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
19501.133Slukem
19511.321SmrgMKDEPCXX	Construct Makefile dependency list for C++ files.  [mkdep]
19521.321Smrg
19531.133SlukemNM		List symbols from object files.  [nm]
19541.133Slukem
19551.133SlukemPC		Pascal compiler.  [pc]  (Not present)
19561.133Slukem
19571.133SlukemPFLAGS		Options to ${PC}.  []
19581.133Slukem
19591.133SlukemOBJC		Objective C compiler.  [${CC}]
19601.133Slukem
19611.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
19621.133Slukem
19631.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
19641.133Slukem
19651.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
19661.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
19671.291Schristos
19681.168SrizOBJDUMP		Display information from object files.  [objdump]
19691.168Sriz
19701.133SlukemRANLIB		Generate index to archive.  [ranlib]
19711.133Slukem
19721.343SpookaREADELF		Display information from ELF object files.  [readelf]
19731.343Spooka
19741.133SlukemSIZE		List section sizes and total size.  [size]
19751.133Slukem
19761.343SpookaSTRINGS		Display printable character sequences in files.  [strings]
19771.343Spooka
19781.133SlukemSTRIP		Discard symbols from object files.  [strip]
19791.133Slukem
19801.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
19811.133Slukem
19821.133SlukemYACC		LALR(1) parser generator.  [yacc]
19831.133Slukem
19841.133SlukemYFLAGS		Options to ${YACC}.  []
19851.133Slukem
19861.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
19871.133Slukem		from <file>.y to <file>.h and <file>.c, and add
19881.133Slukem		<foo>.h to CLEANFILES.
19891.133Slukem
19901.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
19911.133Slukem
19921.116Slukem
19931.69SsommerfeOther variables of note (incomplete list):
19941.69Ssommerfe
19951.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
19961.213Slukem		that cause warnings to be fatal, such as:
19971.213Slukem			-Werror -Wa,--fatal-warnings
19981.213Slukem		(The latter being for as(1).)
19991.212Slukem
20001.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
20011.283Sjoerg		passed to it.
20021.283Sjoerg
20031.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
20041.82Slukem			WARNS=1
20051.82Slukem			WARNS=2
20061.82Slukem			WARNS=3
20071.164Smatt			WARNS=4
20081.296Splunky			WARNS=5
20091.336Schristos			WARNS=6
20101.69Ssommerfe
20111.326Schristos=-=-=-=-=   bsd.host.mk  =-=-=-=-=
20121.144Slukem
20131.326SchristosThis file is automatically included from bsd.own.mk. It contains settings
20141.326Schristosfor all the HOST_* variables that are used in host programs and libraries.
20151.144Slukem
20161.326SchristosHOST_AR			The host archive processing command
20171.144Slukem
20181.326SchristosHOST_CC			The host c compiler
20191.144Slukem
20201.326SchristosHOST_CFLAGS		The host c compiler flags
20211.144Slukem
20221.326SchristosHOST_COMPILE.c		The host c compiler line with flags
20231.144Slukem
20241.326SchristosHOST_COMPILE.cc		The host c++ compiler line with flags
20251.144Slukem
20261.326SchristosHOST_CPP		The host c pre-processor
20271.144Slukem
20281.326SchristosHOST_CPPFLAGS		The cost c pre-processor flags
20291.144Slukem
20301.326SchristosHOST_CXX		The host c++ compiler
20311.144Slukem
20321.326SchristosHOST_CXXFLAGS		The host c++ compiler flags
20331.144Slukem
20341.326SchristosHOST_INSTALL_DIR	The host command to install a directory
20351.144Slukem
20361.326SchristosHOST_INSTALL_FILE	The host command to install a file
20371.144Slukem
20381.326SchristosHOST_INSTALL_SYMLINK	The host command to install a symlink
20391.144Slukem
20401.326SchristosHOST_LD			The host linker command
20411.144Slukem
20421.326SchristosHOST_LDFLAGS		The host linker flags
20431.144Slukem
20441.326SchristosHOST_LINK.c		The host c linker line with flags
20451.221Smrg
20461.326SchristosHOST_LINK.cc		The host c++ linker line with flags
20471.144Slukem
20481.326SchristosHOST_LN			The host command to link two files
20491.144Slukem
20501.326SchristosHOST_MKDEP		The host command to create dependencies for c programs
20511.144Slukem
20521.326SchristosHOST_MKDEPCXX		The host command to create dependencies for c++ programs
20531.144Slukem
20541.326SchristosHOST_OSTYPE		The host OSNAME-RELEASE-ARCH tupple
20551.144Slukem
20561.326SchristosHOST_RANLIB		The host command to create random access archives
20571.144Slukem
20581.326SchristosHOST_SH			The host Bourne shell interpreter name (absolute path)
20591.144Slukem
20601.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2061