bsd.README revision 1.298
11.298Schristos#	$NetBSD: bsd.README,v 1.298 2012/08/08 13:56:13 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.210SgmcgarryMKATF		If "no", don't build libatf-c, libatf-c++ libraries associated
1171.210Sgmcgarry		with the Automated Testing Framework (ATF).
1181.210Sgmcgarry		Default: yes
1191.210Sgmcgarry
1201.252SskrllMKBFD		Obsolete, use MKBINUTILS
1211.252Sskrll
1221.266SjoergMKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
1231.266Sjoerg		libopcodes)
1241.172Shubertf		Default: yes
1251.172Shubertf
1261.266SjoergMKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
1271.266Sjoerg		the pax frontends.
1281.266Sjoerg		Default: no
1291.266Sjoerg
1301.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1311.292Sjoerg		Default: no
1321.172Shubertf
1331.234SmrgMKCOMPAT  	If "no", don't build or install the src/compat.
1341.234Smrg		Default: yes on amd64/sparc64, no elsewhere.
1351.234Smrg
1361.210SgmcgarryMKCOMPLEX	If "no", don't build libm support for <complex.h>
1371.210Sgmcgarry		Default: yes
1381.210Sgmcgarry
1391.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1401.174Schristos		and also acts as "MKKERBEROS=no".
1411.172Shubertf		Default: yes
1421.172Shubertf
1431.297SspzMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5
1441.172Shubertf		Default: no
1451.172Shubertf
1461.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1471.172Shubertf		Default: yes
1481.172Shubertf
1491.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1501.184Slukem		into /usr/libdata/debug.
1511.184Slukem		Default: no
1521.184Slukem
1531.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1541.219Slukem		with -DDEBUG.
1551.176Schristos		Default: no
1561.176Schristos
1571.172ShubertfMKDOC		If "no", don't build or install the documentation.
1581.172Shubertf		Default: yes
1591.172Shubertf
1601.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1611.172Shubertf		don't install certain libraries in /lib, and don't
1621.172Shubertf		install the shared linker into /libexec.
1631.172Shubertf		Default: yes
1641.172Shubertf
1651.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
1661.260Suebayasi		to cross-build programs and libraries externally added by
1671.260Suebayasi		users, and automatically enables creation of those sets.
1681.260Suebayasi		Default: no
1691.260Suebayasi
1701.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1711.186Smrg		libraries (libgcc, libobjc, libstdc++).
1721.172Shubertf		Default: yes
1731.172Shubertf
1741.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
1751.201Slukem		libraries (libgcc, libobjc, libstdc++).
1761.172Shubertf		Default: yes
1771.172Shubertf
1781.172ShubertfMKGDB		If "no", don't build gdb(1).
1791.172Shubertf		Default: yes
1801.172Shubertf
1811.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
1821.172Shubertf		(libraries and support programs).
1831.172Shubertf		Default: yes
1841.172Shubertf
1851.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
1861.172Shubertf		host, the name, release, and architecture of the host
1871.172Shubertf		operating system will be suffixed to the name of the object
1881.172Shubertf		directory created by "make obj".
1891.172Shubertf		Default: no
1901.172Shubertf
1911.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
1921.222Slukem		Default: yes
1931.172Shubertf
1941.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
1951.172Shubertf		Has no effect on most platforms.
1961.172Shubertf		Default: yes
1971.172Shubertf
1981.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
1991.225Sjoerg		Default: no
2001.225Sjoerg
2011.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2021.273Smrg		(libraries and support programs).  This option must not be
2031.273Smrg		set to "no" if MKX11 is not "no".
2041.172Shubertf		Default: yes
2051.172Shubertf
2061.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2071.172Shubertf		Texinfo source files.
2081.172Shubertf		Default: yes
2091.172Shubertf
2101.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2111.172Shubertf		Default: yes
2121.172Shubertf
2131.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2141.181Smrg		(depends on libpthread.)
2151.181Smrg		Default: yes
2161.181Smrg
2171.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2181.172Shubertf		infrastructure (libraries and support programs).
2191.172Shubertf		Default: yes
2201.172Shubertf
2211.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2221.208Slukem		(libraries and support programs).
2231.208Slukem		Default: yes
2241.208Slukem
2251.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2261.172Shubertf		Also:
2271.172Shubertf			- don't install the .a libraries
2281.172Shubertf			- don't install _pic.a libraries on PIC systems
2291.172Shubertf			- don't build .a libraries on PIC systems
2301.172Shubertf			- don't install the .so symlink on ELF systems
2311.172Shubertf		I.e, only install the shared library (and the .so.major
2321.172Shubertf		symlink on ELF).
2331.172Shubertf		Default: yes
2341.172Shubertf
2351.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2361.172Shubertf		Default: yes
2371.172Shubertf
2381.261StronMKLVM		If "no", don't build or install the logical volume manager
2391.245Sagc		and device mapper tools and libraries
2401.262Stron		Default: yes
2411.245Sagc
2421.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2431.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2441.172Shubertf		Default: yes
2451.172Shubertf
2461.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
2471.256Sjoerg		catman or html pages.  A directory can be exempted by
2481.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
2491.278Sjoerg		if NOMANDOC.${target} is set to "yes".
2501.292Sjoerg		Default: yes
2511.256Sjoerg
2521.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2531.172Shubertf		Default: no
2541.172Shubertf
2551.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
2561.253Stsarna		(libraries and support programs).
2571.253Stsarna		Default: yes
2581.253Stsarna
2591.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2601.172Shubertf		definition files.
2611.172Shubertf		Default: yes
2621.172Shubertf
2631.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
2641.275Srmind		Default: yes
2651.275Srmind
2661.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2671.172Shubertf		and also acts as "MKOBJDIRS=no".
2681.172Shubertf		Default: yes
2691.172Shubertf
2701.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
2711.172Shubertf		Default: no
2721.172Shubertf
2731.172ShubertfMKPAM		If "no", disables building of PAM authentication
2741.172Shubertf		infrastructure (libraries and support programs).
2751.182Speter		Default: yes
2761.172Shubertf
2771.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
2781.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
2791.210Sgmcgarry		Default: no
2801.210Sgmcgarry
2811.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
2821.172Shubertf		Default: yes
2831.172Shubertf
2841.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
2851.172Shubertf		also acts as "MKPICLIB=no"
2861.172Shubertf		Default: yes (for MACHINE_ARCHs that support it) 
2871.172Shubertf
2881.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2891.172Shubertf		Default: yes
2901.172Shubertf
2911.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2921.172Shubertf		shared object libraries from the .a libraries.
2931.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
2941.172Shubertf		_pic.a library pointing to the .a library.
2951.172Shubertf		Default: yes
2961.172Shubertf
2971.198SchristosMKPIE		If "no", create regular executables. Otherwise create
2981.198Schristos		PIE (Position Independent Executables).
2991.198Schristos		Default: no
3001.198Schristos
3011.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3021.271Smrg		Default: no
3031.271Smrg
3041.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3051.172Shubertf		Default: yes
3061.172Shubertf
3071.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3081.172Shubertf		Default: yes
3091.172Shubertf
3101.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3111.295Swiz		different switches to make two builds from the same source tree
3121.295Swiz		result in the same build results.
3131.295Swiz		Default: no
3141.295Swiz
3151.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3161.172Shubertf		MKMAN=no MKNLS=no".
3171.172Shubertf		I.e, don't build catman pages, documentation, Info
3181.172Shubertf		documentation, man pages, NLS files, ...
3191.172Shubertf		Default: yes
3201.172Shubertf
3211.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3221.172Shubertf		infrastructure (libraries and support programs).
3231.172Shubertf		Default: yes
3241.172Shubertf
3251.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3261.172Shubertf		generate output containing library calls for floating
3271.172Shubertf		point and possibly soft-float library support.
3281.172Shubertf		Default: no
3291.172Shubertf
3301.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3311.172Shubertf		libraries.
3321.172Shubertf		Default: yes
3331.172Shubertf
3341.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3351.172Shubertf		files or directories, and keep a metadata log of what
3361.172Shubertf		the owner/group/mode should be.  This allows a
3371.172Shubertf		non-root "make install".
3381.172Shubertf		Default: no
3391.172Shubertf
3401.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
3411.172Shubertf		more recently modified in the source directories that their
3421.172Shubertf		installed counterparts.
3431.172Shubertf		Default: no
3441.172Shubertf
3451.237SmrgMKX11		If not "no", depending on the value of ${X11FLAVOUR},
3461.237Smrg		'make build' also descends into either src/x11 (XFree86) or
3471.237Smrg		src/external/mit/xorg (modular Xorg) to cross-build X11 and
3481.237Smrg		automatically enables creation of X sets.
3491.216Smrg		Default: no
3501.216Smrg
3511.251SmrgMKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
3521.251Smrg		install the X fonts.  The xfont set is still created but
3531.251Smrg		will be empty.
3541.251Smrg		Default: yes
3551.251Smrg
3561.172ShubertfMKYP		If "no", disables building of YP (NIS)
3571.172Shubertf		infrastructure (libraries and support programs).
3581.172Shubertf		Default: yes
3591.172Shubertf
3601.254ShaadMKZFS		If "no", do not build and install utilities and libraries 
3611.254Shaad		used to manage ZFS file system. Do not build zfs and solaris 
3621.254Shaad		compatibility kernel modules.
3631.270Sriz		Default: yes on i386/amd64, no elsewhere.
3641.254Shaad
3651.298SchristosMKRUMP		If "no", do not build and install rump related headers,
3661.298Schristos		libraries, and programs.
3671.298Schristos		Default: yes
3681.298Schristos
3691.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
3701.172Shubertf		various system utilities/libraries that support it.
3711.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
3721.172Shubertf		forced to "no".
3731.172Shubertf
3741.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
3751.172Shubertf		various system utilities/libraries that support it.
3761.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
3771.172Shubertf		forced to "no".
3781.172Shubertf
3791.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
3801.197Sad		designed for improved performance with threaded
3811.197Sad		applications.  The "phkmalloc" allocator as used up
3821.197Sad		before NetBSD-5.0 will be substituted.
3831.197Sad
3841.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
3851.172Shubertf		support into various system utilities/libraries that
3861.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
3871.172Shubertf		will also be forced to "no".
3881.172Shubertf
3891.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
3901.208Slukem		system utilities/libraries that support it.
3911.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
3921.208Slukem
3931.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
3941.172Shubertf		into various system utilities/libraries that support it.
3951.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
3961.172Shubertf
3971.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
3981.172Shubertf		support into various system utilities/libraries that
3991.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4001.172Shubertf		also be forced to "no".
4011.204Slukem		Default: no
4021.172Shubertf
4031.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4041.257Stron		detects stack overflows and aborts the program. The
4051.268Snjoly		stack protection code imposes a performance penalty
4061.259Spgoyette		of about 5%.
4071.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4081.187Schristos
4091.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
4101.246Schristos		functions that do not do bounds checking regularly, but
4111.246Schristos		they could in some cases by using the gcc
4121.246Schristos		__builtin_object_size() function to determine the buffer 
4131.246Schristos		size where it is known and detect buffer overflows.
4141.246Schristos		These substitute functions are in /usr/include/ssp.
4151.257Stron		Default: depends on the part of the source tree
4161.246Schristos
4171.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4181.172Shubertf		various system utilities/libraries that support it.
4191.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4201.172Shubertf
4211.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
4221.274Smrg		Otherwise, build tools/pigz and use nbpigz to compress
4231.284Smatt		things.
4241.274Smrg		Default: "no".
4251.274Smrg
4261.237SmrgX11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
4271.237Smrg		XFree86 or modular Xorg.  Only matters if MKX11!=no.
4281.242Smrg		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
4291.242Smrg		"XFree86" on everything else.
4301.237Smrg
4311.172ShubertfCOPTS.lib<lib>
4321.177SmrgOBJCOPTS.lib<lib>
4331.172ShubertfLDADD.lib<lib>
4341.172ShubertfCPPFLAGS.lib<lib>
4351.172ShubertfCXXFLAGS.lib<lib>
4361.172ShubertfCOPTS.<prog>
4371.177SmrgOBJCCOPTS.<prog>
4381.172ShubertfLDADD.<prog>
4391.172ShubertfCPPFLAGS.<prog>
4401.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
4411.172Shubertf		variables in a way that applies only to a particular library
4421.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
4431.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
4441.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
4451.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
4461.172Shubertf		the crypto library.
4471.118Slukem
4481.281SjoergThe active compiler is selected using the following variables:
4491.281SjoergAVAILABLE_COMPILER
4501.281Sjoerg		List of available compiler suites.  Processed in order
4511.281Sjoerg		for selecting the active compiler for each frontend.
4521.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
4531.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
4541.281SjoergUNSUPPORTED_COMPILER.xxx
4551.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
4561.281Sjoerg
4571.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
4581.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
4591.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
4601.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
4611.281Sjoerg
4621.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
4631.1Scgd
4641.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
4651.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
4661.1Scgd
4671.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
4681.1Scgd
4691.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
4701.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
4711.17Sthorpeja few global "feature configuration" parameters.
4721.1Scgd
4731.1ScgdIt has no targets.
4741.1Scgd
4751.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
4761.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
4771.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
4781.29Scjsis included.  These files may define any of the variables described below.
4791.17Sthorpej
4801.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
4811.17Sthorpej(defaults are in brackets):
4821.15Scgd
4831.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
4841.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
4851.98Slukem		otherwise BSDSRCDIR will be used as the default.
4861.98Slukem		Various makefiles within the NetBSD source tree will
4871.98Slukem		use this to reference the top level of the source tree.
4881.98Slukem
4891.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
4901.98Slukem		based on the presence of tools/ and build.sh.  This variable
4911.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
4921.98Slukem		determined once and then propagated to all sub-makes.
4931.95Slukem
4941.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
4951.116Slukem		will work correctly.  [/usr/src]
4961.15Scgd
4971.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
4981.116Slukem		will work correctly.  [/usr/obj]
4991.15Scgd
5001.116SlukemBINGRP		Binary group.  [wheel]
5011.15Scgd
5021.116SlukemBINOWN		Binary owner.  [root]
5031.15Scgd
5041.116SlukemBINMODE		Binary mode.  [555]
5051.15Scgd
5061.116SlukemNONBINMODE	Mode for non-executable files.  [444]
5071.15Scgd
5081.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
5091.15Scgd
5101.116SlukemMANGRP		Manual group.  [wheel]
5111.15Scgd
5121.116SlukemMANOWN		Manual owner.  [root]
5131.15Scgd
5141.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
5151.15Scgd
5161.222SlukemMANINSTALL	Manual installation type.  Space separated list:
5171.222Slukem			catinstall, htmlinstall, maninstall
5181.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
5191.76Sfair
5201.76SfairLDSTATIC	Control program linking; if set blank, link everything
5211.129Slukem		dynamically.  If set to "-static", link everything statically.
5221.76Sfair		If not set, programs link according to their makefile.
5231.21Schristos
5241.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
5251.15Scgd
5261.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
5271.15Scgd
5281.116SlukemLIBGRP		Library group.  [${BINGRP}]
5291.15Scgd
5301.116SlukemLIBOWN		Library owner.  [${BINOWN}]
5311.15Scgd
5321.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
5331.15Scgd
5341.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
5351.116Slukem	        installation.  [/usr/share/doc]
5361.62Ssimonb
5371.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
5381.62Ssimonb		[/usr/share/doc/html]
5391.15Scgd
5401.116SlukemDOCGRP		Documentation group.  [wheel]
5411.15Scgd
5421.116SlukemDOCOWN		Documentation owner.  [root]
5431.15Scgd
5441.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
5451.15Scgd
5461.84SkleinkNLSDIR		Base path for Native Language Support files installation.
5471.15Scgd		[/usr/share/nls]
5481.1Scgd
5491.116SlukemNLSGRP		Native Language Support files group.  [wheel]
5501.1Scgd
5511.116SlukemNLSOWN		Native Language Support files owner.  [root]
5521.1Scgd
5531.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
5541.1Scgd
5551.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
5561.255Sapb		if that exists; otherwise /usr/xsrc]
5571.144Slukem
5581.221SmrgX11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
5591.144Slukem
5601.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
5611.144Slukem
5621.221SmrgX11SRCDIR.lib<package>
5631.221SmrgX11SRCDIR.<package>
5641.221Smrg		The path to the xorg src tree for the specificed package>.
5651.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
5661.221Smrg
5671.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
5681.221Smrg		[/usr/X11R7]
5691.144Slukem
5701.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
5711.144Slukem
5721.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
5731.144Slukem
5741.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
5751.144Slukem
5761.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
5771.144Slukem
5781.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
5791.144Slukem
5801.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
5811.144Slukem
5821.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
5831.1Scgd		to be stripped.  This is to be used when building your
5841.1Scgd		own install script so that the entire system can be made
5851.146Slukem		stripped/not-stripped using a single knob.  []
5861.1Scgd
5871.2ScgdCOPY		The flag passed to the install program to cause the binary
5881.2Scgd		to be copied rather than moved.  This is to be used when
5891.2Scgd		building our own install script so that the entire system
5901.2Scgd		can either be installed with copies, or with moves using
5911.116Slukem		a single knob.  [-c]
5921.15Scgd
5931.150SlukemMAKEDIRTARGET dir target [params]
5941.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
5951.150Slukem		displaying a "pretty" message whilst doing so.
5961.150Slukem
5971.152SclRELEASEMACHINEDIR
5981.152Scl		Subdirectory used below RELEASEDIR when building
5991.152Scl		a release.  [${MACHINE}]
6001.152Scl
6011.152SclRELEASEMACHINE	Subdirectory or path component used for the following
6021.152Scl		paths:
6031.152Scl			distrib/${RELEASEMACHINE}
6041.152Scl			distrib/notes/${RELEASEMACHINE}
6051.152Scl			etc/etc.${RELEASEMACHINE}
6061.152Scl		Used when building a release.  [${MACHINE}]
6071.150Slukem
6081.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
6091.214Swizmake configuration file to modify the behavior of the system build
6101.17Sthorpejprocess (default values are in brackets along with comments, if set by
6111.134Slukem<bsd.own.mk>):
6121.33Sjonathan
6131.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
6141.172Shubertf		be used as part of a build in progress.
6151.172Shubertf		Supported values:
6161.172Shubertf
6171.172Shubertf		yes	Use the tools from TOOLDIR.
6181.172Shubertf			Must be set to this if cross-compiling.
6191.172Shubertf
6201.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
6211.172Shubertf			build native compilation tool components that are
6221.172Shubertf			version-specific for that tool.
6231.172Shubertf
6241.172Shubertf		never	Do not use the tools from TOOLDIR, even when
6251.172Shubertf			building native tool components.  This is similar to
6261.172Shubertf			the traditional NetBSD build method, but does not
6271.172Shubertf			verify that the compilation tools in use are
6281.172Shubertf			up-to-date enough in order to build the tree
6291.172Shubertf			successfully.  This may cause build or runtime
6301.172Shubertf			problems when building the whole NetBSD source tree.
6311.172Shubertf
6321.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
6331.172Shubertf		source tree (detected automatically); "no" otherwise
6341.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
6351.172Shubertf		make(1) include files).
6361.142Slukem
6371.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
6381.199Ssimonb		use ELF -- currently all architectures].
6391.33Sjonathan
6401.103SthorpejTOOLCHAIN_MISSING
6411.142Slukem		If not "no", this indicates that the platform being built
6421.103Sthorpej		does not have a working in-tree toolchain.  If the
6431.142Slukem		${MACHINE_ARCH} in question falls into this category,
6441.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
6451.103Sthorpej		Otherwise, the variable is unconditionally assigned the
6461.103Sthorpej		value "no".
6471.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
6481.142Slukem		unconditionally assigned the value "no".
6491.103Sthorpej
6501.103SthorpejEXTERNAL_TOOLCHAIN
6511.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
6521.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
6531.103Sthorpej		access to this variable.  The variable should be defined
6541.103Sthorpej		either in the user's environment or in the user's mk.conf
6551.103Sthorpej		file.  If defined, this variable indicates the root of
6561.103Sthorpej		an external toolchain which will be used to build the
6571.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
6581.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
6591.103Sthorpej		cross-compile framework.
6601.103Sthorpej
6611.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
6621.142Slukem		assigned the value "no", since the external version of the
6631.142Slukem		compiler may not be able to build the library components of
6641.142Slukem		the in-tree compiler.
6651.103Sthorpej
6661.103Sthorpej		NOTE: This variable is not yet used in as many places as
6671.103Sthorpej		it should be.  Expect the exact semantics of this variable
6681.103Sthorpej		to change in the short term as parts of the cross-compile
6691.103Sthorpej		framework continue to be cleaned up.
6701.1Scgd
6711.236SapbThe following variables are defined to commands to perform the
6721.236Sapbappropriate operation, with the default in [brackets].  Note that
6731.236Sapbthe defaults change if USETOOLS == "yes":
6741.236Sapb
6751.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
6761.236Sapb
6771.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
6781.236Sapb
6791.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
6801.236Sapb
6811.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
6821.236Sapb
6831.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
6841.236Sapb
6851.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
6861.236Sapb
6871.236SapbTOOL_CAT		Concatenate and print files.  [cat]
6881.236Sapb
6891.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
6901.236Sapb
6911.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
6921.236Sapb
6931.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
6941.236Sapb
6951.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
6961.236Sapb
6971.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
6981.236Sapb
6991.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
7001.236Sapb
7011.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
7021.236Sapb
7031.236SapbTOOL_EQN		Format equations for groff.  [eqn]
7041.236Sapb
7051.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
7061.236Sapb
7071.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
7081.236Sapb
7091.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
7101.236Sapb
7111.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
7121.236Sapb
7131.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
7141.236Sapb
7151.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
7161.247Ssketch
7171.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
7181.236Sapb
7191.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
7201.236Sapb
7211.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
7221.236Sapb
7231.236SapbTOOL_HP700MKBOOT	Make bootable image for hp700.  [hp700-mkboot]
7241.236Sapb
7251.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
7261.236Sapb
7271.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
7281.236Sapb
7291.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
7301.236Sapb
7311.236SapbTOOL_JOIN		Relational database operator.  [join]
7321.236Sapb
7331.236SapbTOOL_M4			M4 macro language processor.  [m4]
7341.236Sapb
7351.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
7361.236Sapb
7371.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
7381.236Sapb
7391.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
7401.236Sapb
7411.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
7421.236Sapb
7431.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
7441.236Sapb
7451.236SapbTOOL_MENUC		Menu compiler.  [menuc]
7461.236Sapb
7471.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
7481.236Sapb			[mips-elf2ecoff]
7491.236Sapb
7501.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
7511.236Sapb
7521.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
7531.236Sapb
7541.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
7551.236Sapb
7561.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
7571.236Sapb
7581.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
7591.236Sapb
7601.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
7611.236Sapb
7621.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
7631.236Sapb
7641.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
7651.236Sapb
7661.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
7671.236Sapb
7681.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
7691.273Smrg
7701.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
7711.236Sapb
7721.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
7731.236Sapb
7741.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
7751.236Sapb
7761.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
7771.236Sapb
7781.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
7791.236Sapb
7801.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
7811.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
7821.236Sapb
7831.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
7841.236Sapb
7851.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
7861.236Sapb
7871.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
7881.236Sapb
7891.236SapbTOOL_SED		Stream editor.  [sed]
7901.236Sapb
7911.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
7921.236Sapb
7931.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
7941.236Sapb			[sparkcrc]
7951.236Sapb
7961.236SapbTOOL_STAT		Display file status.  [stat]
7971.236Sapb
7981.236SapbTOOL_STRFILE		Create a random access file for storing strings.
7991.236Sapb			[strfile]
8001.236Sapb
8011.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
8021.236Sapb
8031.236SapbTOOL_TBL		Format tables for groff.  [tbl]
8041.236Sapb
8051.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
8061.236Sapb
8071.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
8081.236Sapb
8091.236SapbTOOL_ZIC		Time zone compiler.  [zic]
8101.236Sapb
8111.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
8121.1Scgdthey use the same default owners etc. as the rest of the tree.
8131.131Slukem
8141.131Slukem
8151.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
8161.286Sapb
8171.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
8181.286Sapbtargets.  It uses the following variables:
8191.286Sapb
8201.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
8211.286Sapb
8221.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
8231.286Sapb		the clean target.
8241.286Sapb
8251.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
8261.287Sapb		will delete files from both the object directory,
8271.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
8281.287Sapb
8291.287Sapb		If MKCLEANSRC is set to "no", then the file names in
8301.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
8311.287Sapb		to the object directory, ${.OBJDIR}.  This is the
8321.287Sapb		traditional behaviour.
8331.287Sapb
8341.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
8351.287Sapb		is performed relative to both the object directory,
8361.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
8371.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
8381.287Sapb		Deleting files from ${.CURDIR} is intended to remove
8391.287Sapb		stray output files that had been left in the source
8401.287Sapb		directory by an earlier build that did not use object
8411.287Sapb		directories.
8421.287Sapb
8431.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
8441.287Sapb		separate object directories, and you are sure that there
8451.287Sapb		are no stray files in the source directories, then you
8461.287Sapb		may set MKCLEANSRC=no to save some time.
8471.287Sapb
8481.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
8491.287Sapb		will verify that files have been deleted.
8501.287Sapb
8511.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
8521.287Sapb		be deleted using a "rm -f" command, and its success or
8531.287Sapb		failure will be ignored.
8541.287Sapb
8551.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
8561.287Sapb		the "rm -f" command will be verified using an "ls"
8571.287Sapb		command.
8581.287Sapb
8591.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
8601.287Sapb		there will be no problems caused by file permissions,
8611.287Sapb		read-only file systems, or the like, then you may set
8621.287Sapb		MKCLEANVERIFY=no to save some time.
8631.286Sapb
8641.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
8651.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
8661.286Sapbor CLEANDIRFILES variables.  For example:
8671.286Sapb
8681.286Sapb	    CLEANFILES+= a.out
8691.286Sapb	    CLEANDIRFILES+= .depend
8701.286Sapb
8711.286Sapb	    .include <bsd.clean.mk>
8721.286Sapb
8731.286Sapb
8741.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
8751.131Slukem
8761.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
8771.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
8781.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
8791.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
8801.133Slukemdependencies for the .d files.  In order for this to function correctly,
8811.132Slukemit should be .included after all other .mk files and directives that may
8821.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
8831.132Slukem
8841.132SlukemSRCS		List of source files to build the program.
8851.132Slukem
8861.132SlukemDPSRCS		List of source files which are needed for generating
8871.132Slukem		dependencies, but are not needed in ${SRCS}.
8881.1Scgd
8891.1Scgd
8901.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
8911.106Sthorpej
8921.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
8931.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
8941.124Slukem
8951.124SlukemFILES		The list of files to install.
8961.124Slukem
8971.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
8981.153Slukem		are installed by the `configinstall' target,
8991.153Slukem		not the `install' target.
9001.153Slukem		The FILES* variables documented below also apply.
9011.153Slukem
9021.124SlukemFILESOWN	File owner.  [${BINOWN}]
9031.124Slukem
9041.124SlukemFILESGRP	File group.  [${BINGRP}]
9051.124Slukem
9061.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
9071.124Slukem
9081.124SlukemFILESDIR	The location to install the files.
9091.124Slukem
9101.124SlukemFILESNAME	Optional name to install each file as.
9111.124Slukem
9121.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
9131.153Slukem
9141.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
9151.153Slukem
9161.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
9171.153Slukem
9181.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
9191.153Slukem
9201.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
9211.124Slukem
9221.285SapbFILESBUILD	If this variable is defined, then its value will be
9231.285Sapb		used as the default for all FILESBUILD_<fn> variables.
9241.285Sapb		Otherwise, the default will be "no".
9251.285Sapb
9261.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
9271.243Scube		targets to be built by `realall'.  Users of that variable
9281.243Scube		should provide a target to build the file.
9291.243Scube
9301.135Slukem
9311.139SlukemBUILDSYMLINKS	List of two word items:
9321.135Slukem			lnsrc lntgt
9331.135Slukem		For each lnsrc item, create a symlink named lntgt.
9341.135Slukem		The lntgt symlinks are removed by the cleandir target.
9351.106Sthorpej
9361.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
9371.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
9381.148Sjmc		The source files have a `.uue' suffix, the generated files do 
9391.148Sjmc		not.
9401.149Sjmc
9411.202SuweUUDECODE_FILES_RENAME_<fn>
9421.202Suwe		Rename the output from the decode to the provided name.
9431.148Sjmc		
9441.148Sjmc		*NOTE: These files are simply decoded, with no install or other
9451.148Sjmc		       rule applying implicitly except being added to the clean
9461.148Sjmc		       target.
9471.106Sthorpej
9481.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
9491.113Sthorpej
9501.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
9511.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
9521.134Slukembefore <bsd.gcc.mk>.
9531.113Sthorpej
9541.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
9551.113Sthorpejof which need to know where to find certain GCC support libraries.
9561.113Sthorpej
9571.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
9581.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
9591.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
9601.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
9611.113Sthorpej
9621.134Slukem<bsd.gcc.mk> sets the following variables:
9631.113Sthorpej
9641.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
9651.118Slukem
9661.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
9671.118Slukem
9681.118Slukem_GCC_CRTEND	The full path name to crtend.o.
9691.118Slukem
9701.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
9711.118Slukem
9721.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
9731.118Slukem
9741.118Slukem
9751.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
9761.118Slukem
9771.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
9781.118Slukemvariables:
9791.118Slukem
9801.124SlukemINCS		The list of include files.
9811.118Slukem
9821.118SlukemINCSDIR		The location to install the include files.
9831.118Slukem
9841.118SlukemINCSNAME	Target name of the include file, if only one; same as
9851.118Slukem		FILESNAME, but for include files.
9861.118Slukem
9871.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
9881.134Slukem		are installed in the 'includes' target and not the
9891.134Slukem		(much later) 'install' target.
9901.134Slukem
9911.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
9921.118Slukem		same as FILESNAME_<file>, but for include files.
9931.118Slukem
9941.118Slukem
9951.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
9961.118Slukem
9971.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
9981.118Slukemdocumentation from respective Texinfo source files.  It defines three
9991.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
10001.118Slukemfollowing variables:
10011.118Slukem
10021.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
10031.118Slukem		consist of single files with the extension replaced by
10041.118Slukem		.info.
10051.118Slukem
10061.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
10071.118Slukem
10081.118Slukem
10091.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
10101.118Slukem
10111.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
10121.118Slukemlocation of kernel sources and object directories.
10131.118Slukem
10141.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
10151.124Slukem		[${_SRC_TOP_}/sys]
10161.118Slukem
10171.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
10181.124Slukem		[arch/${MACHINE}]
10191.120Slukem
10201.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
10211.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
10221.118Slukem
10231.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
10241.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
10251.118Slukem		The default value is
10261.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
10271.118Slukem		if it exists or the target 'obj' is being made.
10281.118Slukem		Otherwise the default is
10291.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
10301.118Slukem
10311.118SlukemIt is important that Makefiles (such as those under src/distrib) that
10321.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
10331.118Slukemrather than make assumptions about the location of the compiled kernel.
10341.118Slukem
10351.118Slukem
10361.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
10371.118Slukem
10381.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
10391.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
10401.118Slukeminclude file installation.  It is intended to be included alone, by
10411.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
10421.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
10431.134Slukemin that file up to date.
10441.118Slukem
10451.118Slukem
10461.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
10471.118Slukem
10481.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
10491.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
10501.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
10511.118Slukemwhich checks for installed shared object libraries whose version is greater
10521.118Slukemthat the version of the source. It has a limited number of suffixes,
10531.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
10541.118Slukem<bsd.shlib.mk> to get shared library parameters.
10551.118Slukem
10561.118SlukemIt sets/uses the following variables:
10571.118Slukem
10581.118SlukemLIB		The name of the library to build.
10591.118Slukem
10601.118SlukemLIBDIR		Target directory for libraries.
10611.118Slukem
10621.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
10631.248Sperry		permissions in files inside its archives to those of
10641.248Sperry		the file it was fed. This leads to non-reproduceable
10651.248Sperry		builds. If MKARZERO is set to "yes" (default is "no")
10661.248Sperry		then the "D" flag is passed to ar, causing the
10671.248Sperry		timestamp, uid and gid to be zeroed and the file
10681.248Sperry		permissions to be set to 644. This allows .a files
10691.248Sperry		from different builds to be bit identical.
10701.248Sperry
10711.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
10721.142Slukem		is not "no".
10731.118Slukem
10741.263SabsSHLIB_MAJOR
10751.263SabsSHLIB_MINOR
10761.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
10771.263Sabs
10781.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
10791.118Slukem		as the path to install shared libraries to.
10801.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
10811.130Slukem		Default: no
10821.118Slukem
10831.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
10841.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
10851.218Slukem		MKPROFILE=no MKSTATICLIB=no".
10861.218Slukem		Default: no
10871.218Slukem
10881.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
10891.211Slukem		MKPROFILE=no", and don't install the (.a) library.
10901.154Slukem		This is useful for "build only" helper libraries.
10911.154Slukem		Default: no
10921.154Slukem
10931.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
10941.244Smrg		shared libraries.
10951.244Smrg		This is useful for C++ libraries.
10961.244Smrg		Default: no
10971.244Smrg
10981.118SlukemLINTLIBDIR	Target directory for lint libraries.
10991.118Slukem
11001.118SlukemLIBGRP		Library group.
11011.118Slukem
11021.118SlukemLIBOWN		Library owner.
11031.118Slukem
11041.118SlukemLIBMODE		Library mode.
11051.118Slukem
11061.118SlukemLDADD		Additional loader objects.
11071.118Slukem
11081.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
11091.118Slukem
11101.118SlukemNOCHECKVER_<library>
11111.118SlukemNOCHECKVER	If set, disables checking for installed shared object
11121.118Slukem		libraries with versions greater than the source.  A
11131.118Slukem		particular library name, without the "lib" prefix, may
11141.118Slukem		be appended to the variable name to disable the check for
11151.118Slukem		only that library.
11161.118Slukem
11171.118SlukemSRCS		List of source files to build the library.  Suffix types
11181.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
11191.118Slukem		to .c files of the same name.  (This is not the default for
11201.118Slukem		versions of make.)
11211.118Slukem
11221.157SlukemLIBDPLIBS	A list of the tuples:
11231.157Slukem			libname  path-to-srcdir-of-libname
11241.157Slukem
11251.157Slukem		For each tuple;
11261.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
11271.157Slukem			`libname', and if it is not set it is determined
11281.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
11291.157Slukem			latter is to allow for build time optimization).
11301.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
11311.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
11321.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
11331.157Slukem
11341.157Slukem		This variable may be used for individual libraries, as
11351.157Slukem		well as in parent directories to cache common libraries 
11361.157Slukem		as a build-time optimization.
11371.157Slukem
11381.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
11391.118Slukemif it exists, as well as the include file <bsd.man.mk>.
11401.118Slukem
11411.118SlukemIt has rules for building profiled objects; profiled libraries are
11421.118Slukembuilt by default.
11431.118Slukem
11441.118SlukemLibraries are ranlib'd when made.
11451.118Slukem
11461.118Slukem
11471.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
11481.118Slukem
11491.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
11501.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
11511.134Slukem
11521.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
11531.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
11541.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
11551.249Sapbby a method for explicitly recording hard links in a metadata log.
11561.249Sapb
11571.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
11581.134Slukem			source-file target-file
11591.134Slukem		${DESTDIR} is prepended to both paths before linking.
11601.134Slukem		For example, to link /bin/test and /bin/[, use:
11611.134Slukem			LINKS=/bin/test /bin/[
11621.134Slukem
11631.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
11641.153Slukem		are installed by the `configinstall' target,
11651.153Slukem		not the `install' target.
11661.153Slukem
11671.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
11681.134Slukem			source-file target-file
11691.134Slukem		${DESTDIR} is only prepended to target-file before linking.
11701.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
11711.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
11721.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
11731.118Slukem
11741.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
11751.153Slukem		are installed by the `configinstall' target,
11761.153Slukem		not the `install' target.
11771.153Slukem
11781.249SapbLINKSOWN	Link owner.  [${BINOWN}]
11791.249Sapb
11801.249SapbLINKSGRP	Link group.  [${BINGRP}]
11811.249Sapb
11821.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
11831.249Sapb
11841.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
11851.249Sapb
11861.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
11871.249Sapb
11881.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
11891.249Sapb
11901.118Slukem
11911.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
11921.118Slukem
11931.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
11941.118Slukemlinks.
11951.118Slukem
11961.222SlukemIt has a three targets:
11971.118Slukem
11981.222Slukem	catinstall:
11991.222Slukem		Install the preformatted manual pages and their links.
12001.222Slukem	htmlinstall:
12011.222Slukem		Install the HTML manual pages and their links.
12021.118Slukem	maninstall:
12031.118Slukem		Install the manual page sources and their links.
12041.118Slukem
12051.118SlukemIt sets/uses the following variables:
12061.118Slukem
12071.118SlukemMANDIR		Base path for manual installation.
12081.118Slukem
12091.118SlukemMANGRP		Manual group.
12101.118Slukem
12111.118SlukemMANOWN		Manual owner.
12121.118Slukem
12131.118SlukemMANMODE		Manual mode.
12141.118Slukem
12151.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
12161.118Slukem		or "/tahoe" for machine specific manual pages.
12171.118Slukem
12181.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12191.118Slukem
12201.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
12211.118Slukem		linked-to file must come first, the linked file second,
12221.276Sreed		and there may be multiple pairs.
12231.118Slukem
12241.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
12251.118Slukemit exists.
12261.118Slukem
12271.118Slukem
12281.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
12291.118Slukem
12301.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
12311.118Slukemand use of separated object and source directories.
12321.118Slukem
12331.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
12341.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
12351.118Slukemit exists.  Otherwise make(1) looks for the existence of a
12361.118Slukemsubdirectory (or a symlink to a directory) of the source directory
12371.118Slukeminto which built targets should be placed.  If an environment variable
12381.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
12391.118Slukemobject directory; failing that, make first looks for a subdirectory
12401.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
12411.118Slukem
12421.118SlukemObject directories are not created automatically by make(1) if they
12431.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
12441.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
12451.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
12461.118Slukemand this is determined by a simple string prefix comparison -- object
12471.118Slukemdirectories are created in a separate object directory tree, and a
12481.118Slukemsymlink to the object directory in that tree is created in the source
12491.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
12501.118Slukemsource tree and that it's not safe to use a separate object tree.
12511.118Slukem
12521.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
12531.118Slukemdirectories and links get created during a "make obj":
12541.118Slukem
12551.118SlukemMAKEOBJDIR	If set, this is the component name of the object
12561.118Slukem		directory.
12571.118Slukem
12581.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
12591.118Slukem		object directories or links named "obj.${MACHINE}";
12601.118Slukem		otherwise, just creates ones named "obj".
12611.118Slukem
12621.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
12631.118Slukem		${BSDSRCDIR}, create object directory in the
12641.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
12651.118Slukem		otherwise, create it in the corresponding subdirectory
12661.118Slukem		of ${BSDOBJDIR}
12671.113Sthorpej
12681.118SlukemBUILDID		If set, the contents of this variable are appended
12691.118Slukem		to the object directory name.  If OBJMACHINE is also
12701.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
12711.113Sthorpej
12721.106Sthorpej
12731.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
12741.106Sthorpej
12751.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
12761.1Scgdmore source files, along with their manual pages.  It has a limited number
12771.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
12781.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
12791.1Scgd
12801.16SjtcIt has eight targets:
12811.1Scgd
12821.1Scgd	all:
12831.102Sthorpej		build the program and its manual page.  This also
12841.102Sthorpej		creates a GDB initialization file (.gdbinit) in
12851.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
12861.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
12871.1Scgd	clean:
12881.1Scgd		remove the program, any object files and the files a.out,
12891.24Smikel		Errs, errs, mklog, and ${PROG}.core.
12901.1Scgd	cleandir:
12911.1Scgd		remove all of the files removed by the target clean, as
12921.1Scgd		well as .depend, tags, and any manual pages.
12931.42Slukem		`distclean' is a synonym for `cleandir'.
12941.1Scgd	depend:
12951.1Scgd		make the dependencies for the source files, and store
12961.1Scgd		them in the file .depend.
12971.16Sjtc	includes:
12981.16Sjtc		install any header files.
12991.1Scgd	install:
13001.1Scgd		install the program and its manual pages; if the Makefile
13011.1Scgd		does not itself define the target install, the targets
13021.1Scgd		beforeinstall and afterinstall may also be used to cause
13031.1Scgd		actions immediately before and after the install target
13041.1Scgd		is executed.
13051.1Scgd	lint:
13061.1Scgd		run lint on the source files
13071.1Scgd	tags:
13081.1Scgd		create a tags file for the source files.
13091.1Scgd
13101.1ScgdIt sets/uses the following variables:
13111.1Scgd
13121.1ScgdBINGRP		Binary group.
13131.1Scgd
13141.1ScgdBINOWN		Binary owner.
13151.1Scgd
13161.1ScgdBINMODE		Binary mode.
13171.1Scgd
13181.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
13191.286Sapb
13201.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
13211.1Scgd
13221.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
13231.112Sthorpej
13241.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
13251.125Slukem		C objects for <fn>.
13261.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
13271.125Slukem
13281.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
13291.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
13301.35Slukem
13311.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
13321.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
13331.125Slukem
13341.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
13351.125Slukem
13361.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
13371.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
13381.102Sthorpej
13391.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
13401.102Sthorpej		directives in the .gdbinit file that is created in the
13411.102Sthorpej		objdir.
13421.1Scgd
13431.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
13441.1Scgd		For example, to load with the compatibility and utility
13451.1Scgd		libraries, use:
13461.1Scgd
13471.5Sjtc			LDADD+=-lutil -lcompat
13481.1Scgd
13491.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
13501.1Scgd
13511.134SlukemLINKS		See <bsd.links.mk>
13521.134Slukem
13531.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
13541.177Smrg
13551.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
13561.177Smrg		ObjC objects for <fn>.
13571.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
13581.177Smrg
13591.134SlukemSYMLINKS	See <bsd.links.mk>
13601.1Scgd
13611.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
13621.8Scgd		defined, "MAN=${PROG}.1" is assumed.
13631.1Scgd
13641.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
13651.212Slukem		time, with the value of this variable as args to paxctl(1).
13661.193Sperry
13671.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
13681.193Sperry
13691.1ScgdPROG		The name of the program to build.  If not supplied, nothing
13701.1Scgd		is built.
13711.1Scgd
13721.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
13731.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
13741.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
13751.88Sthorpej		the value of PROG if PROG is also set.
13761.87Sthorpej
13771.21SchristosPROGNAME	The name that the above program will be installed as, if
13781.21Schristos		different from ${PROG}.
13791.21Schristos
13801.37StvSRCS		List of source files to build the program.  If SRCS is not
13811.1Scgd		defined, it's assumed to be ${PROG}.c.
13821.108Sjwise
13831.108SjwiseDPSRCS		List of source files which are needed for generating
13841.108Sjwise		dependencies, but are not needed in ${SRCS}.
13851.1Scgd
13861.1ScgdDPADD		Additional dependencies for the program.  Usually used for
13871.1Scgd		libraries.  For example, to depend on the compatibility and
13881.1Scgd		utility libraries use:
13891.1Scgd
13901.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
13911.1Scgd
13921.288Schristos		The following system libraries are predefined for DPADD:
13931.1Scgd
13941.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
13951.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
13961.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
13971.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
13981.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
13991.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
14001.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
14011.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
14021.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
14031.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
14041.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
14051.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
14061.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
14071.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
14081.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
14091.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
14101.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
14111.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
14121.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
14131.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
14141.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
14151.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
14161.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
14171.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
14181.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
14191.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
14201.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
14211.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
14221.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
14231.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
14241.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
14251.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
14261.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
14271.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
14281.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
14291.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
14301.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
14311.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
14321.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
14331.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
14341.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
14351.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
14361.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
14371.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
14381.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
14391.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
14401.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
14411.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
14421.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
14431.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
14441.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
14451.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
14461.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
14471.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
14481.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
14491.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
14501.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
14511.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
14521.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
14531.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
14541.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
14551.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
14561.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
14571.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
14581.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
14591.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
14601.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
14611.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
14621.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
14631.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
14641.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
14651.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
14661.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
14671.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
14681.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
14691.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
14701.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
14711.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
14721.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
14731.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
14741.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
14751.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
14761.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
14771.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
14781.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
14791.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
14801.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
14811.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
14821.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
14831.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
14841.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
14851.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
14861.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
14871.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
14881.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
14891.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
14901.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
14911.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
14921.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
14931.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
14941.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
14951.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
14961.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
14971.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
14981.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
14991.1Scgd
15001.288Schristos		The following X-Windows libraries are predefined for DPADD:
15011.288Schristos
15021.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
15031.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
15041.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
15051.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
15061.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
15071.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
15081.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
15091.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
15101.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
15111.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
15121.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
15131.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
15141.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
15151.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
15161.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
15171.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
15181.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
15191.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
15201.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
15211.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
15221.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
15231.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
15241.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
15251.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
15261.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
15271.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
15281.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
15291.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
15301.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
15311.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
15321.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
15331.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
15341.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
15351.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
15361.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
15371.288Schristos
15381.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
15391.12Schristos		strings, using xstr(1). Note that this will not work with
15401.12Schristos		parallel makes.
15411.1Scgd
15421.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
15431.1Scgd		to be stripped.
15441.1Scgd
15451.1ScgdSUBDIR		A list of subdirectories that should be built as well.
15461.1Scgd		Each of the targets will execute the same target in the
15471.1Scgd		subdirectories.
15481.1Scgd
15491.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
15501.21Schristos		These are installed exactly like programs.
15511.21Schristos
15521.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
15531.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
15541.166Srtr
15551.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
15561.21Schristos		different from ${SCRIPTS}. These can be further specialized
15571.21Schristos		by setting SCRIPTSNAME_<script>.
15581.21Schristos
15591.124SlukemFILES		See description of <bsd.files.mk>.
15601.21Schristos
15611.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
15621.106Sthorpej		<bsd.own.mk> for additional information about this variable.
15631.130Slukem
15641.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
15651.1Scgdif it exists, as well as the include file <bsd.man.mk>.
15661.1Scgd
15671.1ScgdSome simple examples:
15681.1Scgd
15691.1ScgdTo build foo from foo.c with a manual page foo.1, use:
15701.1Scgd
15711.1Scgd	PROG=	foo
15721.1Scgd
15731.1Scgd	.include <bsd.prog.mk>
15741.1Scgd
15751.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
15761.1Scgd
15771.9Scgd	MAN=	foo.2
15781.1Scgd
15791.1ScgdIf foo does not have a manual page at all, add the line:
15801.1Scgd
15811.75Sagc	MKMAN=	no
15821.1Scgd
15831.1ScgdIf foo has multiple source files, add the line:
15841.1Scgd
15851.1Scgd	SRCS=	a.c b.c c.c d.c
15861.1Scgd
15871.1Scgd
15881.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
15891.118Slukem
15901.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
15911.118Slukemconstruct source files built by rpcgen.
15921.72Ssommerfe
15931.118SlukemThe following macros may be defined in makefiles which include
15941.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
15951.118Slukemare to be built:
15961.21Schristos
15971.118SlukemRPC_INCS:	construct .h file from .x file
15981.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
15991.118Slukem		(for marshalling/unmarshalling data types)
16001.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
16011.118Slukem		(server-side stubs)
16021.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
16031.21Schristos
16041.118SlukemRPC_XDIR:	Directory containing .x/.h files
16051.23Schristos
16061.23Schristos
16071.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
16081.21Schristos
16091.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
16101.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
16111.134Slukemincluded before <bsd.shlib.mk>.
16121.21Schristos
16131.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
16141.118Slukem(defaults are in brackets):
16151.21Schristos
16161.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
16171.142Slukem		instead of ${LIBDIR} as the base path for shared library
16181.142Slukem		installation.  [/lib]
16191.21Schristos
16201.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
16211.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
16221.118Slukem		for all others.]
16231.81Swiz
16241.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
16251.118Slukem		otherwise set to ${LIBDIR}
16261.81Swiz
16271.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
16281.39Scgd
16291.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
16301.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
16311.118Slukem		all others.]
16321.39Scgd
16331.13Schristos
16341.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
16351.13Schristos
16361.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
16371.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
16381.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
16391.233Sapbfollowing variables:
16401.233Sapb
16411.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
16421.233Sapb		will be ignored and subdirectories will not be processed.
16431.233Sapb
16441.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
16451.233Sapb		specified directory will be visited and the target made.
16461.233Sapb
16471.233Sapb		As a special case, the use of a token .WAIT as an
16481.233Sapb		entry in SUBDIR acts as a synchronization barrier
16491.233Sapb		when multiple make jobs are run; subdirs before the
16501.233Sapb		.WAIT must complete before any subdirs after .WAIT are
16511.233Sapb		started.  See make(1) for some caveats on use of .WAIT
16521.233Sapb		and other special sources.
16531.47Stv
16541.47Stv
16551.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
16561.47Stv
16571.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
16581.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
16591.133Slukemthe NetBSD source tree.
16601.133Slukem
16611.133SlukemThe following variables control how various files are compiled/built.
16621.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
16631.133Slukem
16641.133SlukemAR		Create, modify, and extract from archives.  [ar]
16651.133Slukem
16661.133SlukemARFLAGS		Options to ${AR}.  [rl]
16671.133Slukem
16681.151SlukemAS		Assembler.  [as]
16691.151Slukem
16701.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
16711.211Slukem		assembly source files.  []
16721.151Slukem
16731.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
16741.217Sjoerg		If this option is present, seed the random number
16751.217Sjoerg		generator based on the value, source file names and
16761.217Sjoerg		the output file name to make builds more deterministic.
16771.217Sjoerg		Additional information is available in the GCC
16781.217Sjoerg		documentation of -frandom-seed.
16791.217Sjoerg
16801.133SlukemCC		C compiler.  [cc]
16811.133Slukem
16821.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
16831.133Slukem
16841.133SlukemCPP		C Pre-Processor.  [cpp]
16851.133Slukem
16861.133SlukemCPPFLAGS	Options to ${CPP}.  []
16871.133Slukem
16881.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
16891.133Slukem
16901.133SlukemCXX		C++ compiler.  [c++]
16911.133Slukem
16921.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
16931.133Slukem
16941.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
16951.133Slukem
16961.133SlukemFC		Fortran compiler.  [f77]
16971.133Slukem
16981.133SlukemFFLAGS		Options to {$FC}.  [-O]
16991.133Slukem
17001.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
17011.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
17021.235Sapb
17031.133SlukemINSTALL		install(1) command.  [install]
17041.133Slukem
17051.133SlukemLEX		Lexical analyzer.  [lex]
17061.133Slukem
17071.133SlukemLFLAGS		Options to ${LEX}.  []
17081.133Slukem
17091.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
17101.145Sjwise
17111.133SlukemLD		Linker.  [ld]
17121.133Slukem
17131.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
17141.133Slukem
17151.133SlukemLINT		C program verifier.  [lint]
17161.133Slukem
17171.173SperryLINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
17181.133Slukem
17191.133SlukemLORDER		List dependencies for object files.  [lorder]
17201.133Slukem
17211.133SlukemMAKE		make(1).  [make]
17221.133Slukem
17231.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
17241.133Slukem
17251.133SlukemNM		List symbols from object files.  [nm]
17261.133Slukem
17271.133SlukemPC		Pascal compiler.  [pc]  (Not present)
17281.133Slukem
17291.133SlukemPFLAGS		Options to ${PC}.  []
17301.133Slukem
17311.133SlukemOBJC		Objective C compiler.  [${CC}]
17321.133Slukem
17331.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
17341.133Slukem
17351.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
17361.133Slukem
17371.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
17381.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
17391.291Schristos
17401.168SrizOBJDUMP		Display information from object files.  [objdump]
17411.168Sriz
17421.133SlukemRANLIB		Generate index to archive.  [ranlib]
17431.133Slukem
17441.133SlukemSIZE		List section sizes and total size.  [size]
17451.133Slukem
17461.133SlukemSTRIP		Discard symbols from object files.  [strip]
17471.133Slukem
17481.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
17491.133Slukem
17501.133SlukemYACC		LALR(1) parser generator.  [yacc]
17511.133Slukem
17521.133SlukemYFLAGS		Options to ${YACC}.  []
17531.133Slukem
17541.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
17551.133Slukem		from <file>.y to <file>.h and <file>.c, and add
17561.133Slukem		<foo>.h to CLEANFILES.
17571.133Slukem
17581.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
17591.133Slukem
17601.116Slukem
17611.69SsommerfeOther variables of note (incomplete list):
17621.69Ssommerfe
17631.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
17641.213Slukem		that cause warnings to be fatal, such as:
17651.213Slukem			-Werror -Wa,--fatal-warnings
17661.213Slukem		(The latter being for as(1).)
17671.212Slukem
17681.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
17691.283Sjoerg		passed to it.
17701.283Sjoerg
17711.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
17721.82Slukem			WARNS=1
17731.82Slukem			WARNS=2
17741.82Slukem			WARNS=3
17751.164Smatt			WARNS=4
17761.296Splunky			WARNS=5
17771.69Ssommerfe
17781.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
17791.144Slukem
17801.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
17811.221Smrgcross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
17821.144SlukemIt should be included after the general Makefile contents but before
17831.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
17841.144Slukem
17851.144SlukemIt provides the following targets:
17861.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
17871.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
17881.221Smrg		these rules convert from X11's manual page source
17891.144Slukem		into an mdoc.old source file.
17901.144Slukem
17911.144SlukemIt sets the following variables:
17921.144Slukem
17931.144SlukemBINDIR			Set to ${X11BINDIR}.
17941.144Slukem			To override, define after including <bsd.x11.mk>
17951.144Slukem
17961.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
17971.144Slukem			To override, define after including <bsd.x11.mk>
17981.144Slukem
17991.144SlukemMANDIR			Set to ${X11MANDIR}.
18001.144Slukem			To override, define after including <bsd.x11.mk>
18011.144Slukem
18021.144SlukemCPPFLAGS		Appended with definitions to include from
18031.144Slukem			${DESTDIR}${X11INCDIR}
18041.144Slukem
18051.144SlukemLDFLAGS			Appended with definitions to link from
18061.144Slukem			${DESTDIR}${X11USRLIBDIR}
18071.144Slukem
18081.221SmrgX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
18091.144Slukem
18101.221SmrgX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
18111.144Slukem
18121.221SmrgX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
18131.144Slukem
18141.221SmrgX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
18151.144Slukem
18161.221SmrgX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
18171.144Slukem
18181.221SmrgX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18191.144Slukem
18201.221SmrgX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
18211.144Slukem
18221.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
18231.144Slukem
18241.221SmrgX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
18251.221Smrg
18261.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
18271.144Slukem
18281.144SlukemIt uses the following variables:
18291.144Slukem
18301.144SlukemAPPDEFS			List of app-default files to install.
18311.144Slukem
18321.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
18331.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
18341.144Slukem			have a `.cpp' suffix, the generated files do not.
18351.144Slukem
18361.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
18371.144Slukem
18381.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
18391.144Slukem
18401.144Slukem
18411.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1842