bsd.README revision 1.341
11.341Smrg#	$NetBSD: bsd.README,v 1.341 2015/04/26 21:37:22 mrg Exp $
21.24Smikel#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
31.1Scgd
41.213SlukemThis is the README file for the make "include" files for the NetBSD
51.213Slukemsource tree.  The files are installed in /usr/share/mk, and are,
61.213Slukemby convention, named with the suffix ".mk".
71.1Scgd
81.1ScgdNote, this file is not intended to replace reading through the .mk
91.1Scgdfiles for anything tricky.
101.1Scgd
111.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
121.1Scgd
131.1ScgdRANDOM THINGS WORTH KNOWING:
141.1Scgd
151.1ScgdThe files are simply C-style #include files, and pretty much behave like
161.1Scgdyou'd expect.  The syntax is slightly different in that a single '.' is
171.1Scgdused instead of the hash mark, i.e. ".include <bsd.prog.mk>".
181.1Scgd
191.1ScgdOne difference that will save you lots of debugging time is that inclusion
201.1Scgdof the file is normally done at the *end* of the Makefile.  The reason for
211.1Scgdthis is because .mk files often modify variables and behavior based on the
221.1Scgdvalues of variables set in the Makefile.  To make this work, remember that
231.1Scgdthe FIRST target found is the target that is used, i.e. if the Makefile has:
241.1Scgd
251.1Scgd	a:
261.1Scgd		echo a
271.1Scgd	a:
281.1Scgd		echo a number two
291.1Scgd
301.1Scgdthe command "make a" will echo "a".  To make things confusing, the SECOND
311.1Scgdvariable assignment is the overriding one, i.e. if the Makefile has:
321.1Scgd
331.1Scgd	a=	foo
341.1Scgd	a=	bar
351.1Scgd
361.1Scgd	b:
371.1Scgd		echo ${a}
381.1Scgd
391.1Scgdthe command "make b" will echo "bar".  This is for compatibility with the
401.1Scgdway the V7 make behaved.
411.1Scgd
421.1ScgdIt's fairly difficult to make the BSD .mk files work when you're building
431.75Sagcmultiple programs in a single directory.  It's a lot easier to split up the
441.1Scgdprograms than to deal with the problem.  Most of the agony comes from making
451.36Srossthe "obj" directory stuff work right, not because we switched to a new version
461.1Scgdof make.  So, don't get mad at us, figure out a better way to handle multiple
471.1Scgdarchitectures so we can quit using the symbolic link stuff.  (Imake doesn't
481.1Scgdcount.)
491.1Scgd
501.1ScgdThe file .depend in the source directory is expected to contain dependencies
511.1Scgdfor the source files.  This file is read automatically by make after reading
521.1Scgdthe Makefile.
531.1Scgd
541.1ScgdThe variable DESTDIR works as before.  It's not set anywhere but will change
551.1Scgdthe tree where the file gets installed.
561.1Scgd
571.1ScgdThe profiled libraries are no longer built in a different directory than
581.1Scgdthe regular libraries.  A new suffix, ".po", is used to denote a profiled
591.265Snjolyobject, and ".pico" denotes a shared (position-independent) object.
601.97Sitojun
611.142SlukemThere are various make variables used during the build.
621.142Slukem
631.142SlukemMany variables support a (case sensitive) value of "no" or "yes",
641.142Slukemand are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
651.142Slukem
661.142Slukem
671.172ShubertfThe basic rule for the variable naming scheme is as follows:
681.172Shubertf
691.231SapbHOST_xxx	A command that runs on the host machine regardless of
701.231Sapb		whether or not the system is being cross compiled, or
711.231Sapb		flags for such a command.
721.231Sapb
731.172ShubertfMKxxx		Can be set to "no" to disable functionality, or
741.172Shubertf		"yes" to enable it.
751.172Shubertf		Usually defaults to "yes", although some variables
761.172Shubertf		default to "no".
771.172Shubertf		Due to make(1) implementation issues, if a temporary
781.224Slukem		command-line override of a mk.conf(5) or <bsd.own.mk>
791.214Swiz		setting is required whilst still honoring a particular
801.172Shubertf		Makefile's setting of MKxxx, use
811.172Shubertf			env MKxxx=value make
821.172Shubertf		instead of
831.172Shubertf			make MKxxx=value
841.172Shubertf
851.172ShubertfNOxxx		If defined, disables a feature.
861.172Shubertf		Not intended for users.
871.172Shubertf		This is to allow Makefiles to disable functionality
881.172Shubertf		that they don't support (such as missing man pages).
891.172Shubertf		NOxxx variables must be defined before <bsd.own.mk>
901.172Shubertf		is included.
911.172Shubertf
921.231SapbTOOL_xxx	A tool that is provided as part of the USETOOLS
931.231Sapb		framework.  When not using the USETOOLS framework,
941.231Sapb		TOOL_xxx variables should refer to tools that are
951.231Sapb		already installed on the host system.
961.231Sapb
971.172ShubertfThe following variables that control how things are made/installed that
981.172Shubertfare not set by default. These should not be set by Makefiles; they're for
991.224Slukemthe user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
1001.224Slukemor on the make(1) command line:
1011.172Shubertf
1021.172ShubertfBUILD 		If defined, 'make install' checks that the targets in the
1031.172Shubertf		source directories are up-to-date and remakes them if they
1041.172Shubertf                are out of date, instead of blindly trying to install
1051.172Shubertf                out of date or non-existent targets.
1061.172Shubertf
1071.172ShubertfMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
1081.172Shubertf		Default: 2
1091.172Shubertf		Supported values:
1101.172Shubertf		    0	Minimal output ("quiet")
1111.172Shubertf		    1	Describe what is occurring
1121.172Shubertf		    2	Describe what is occurring and echo the actual command
1131.241Sapb		    3	Ignore the effect of the "@" prefix in make commands
1141.241Sapb		    4	Trace shell commands using the shell's -x flag
1151.172Shubertf
1161.312SjmmvMKATF		If "no", don't build the Automated Testing Framework (ATF),
1171.312Sjmmv		which includes the libatf-c, libatf-c++ and libatf-sh libraries
1181.312Sjmmv		and the various command line tools.  Also, because the build of
1191.312Sjmmv		the libraries is disabled, don't build the NetBSD test suite
1201.312Sjmmv		either.
1211.210Sgmcgarry		Default: yes
1221.210Sgmcgarry
1231.252SskrllMKBFD		Obsolete, use MKBINUTILS
1241.252Sskrll
1251.266SjoergMKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
1261.266Sjoerg		libopcodes)
1271.172Shubertf		Default: yes
1281.172Shubertf
1291.266SjoergMKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
1301.266Sjoerg		the pax frontends.
1311.266Sjoerg		Default: no
1321.266Sjoerg
1331.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1341.292Sjoerg		Default: no
1351.172Shubertf
1361.234SmrgMKCOMPAT  	If "no", don't build or install the src/compat.
1371.303Sjkoshy		Default: yes on amd64/mips64/sparc64, no elsewhere.
1381.234Smrg
1391.210SgmcgarryMKCOMPLEX	If "no", don't build libm support for <complex.h>
1401.210Sgmcgarry		Default: yes
1411.210Sgmcgarry
1421.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1431.174Schristos		and also acts as "MKKERBEROS=no".
1441.172Shubertf		Default: yes
1451.172Shubertf
1461.297SspzMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5
1471.172Shubertf		Default: no
1481.172Shubertf
1491.329SozakiMKCTF		If "no", do not build and install CTF tools, and also
1501.329Sozaki		don't generate and manipulate CTF data of ELF binaries
1511.329Sozaki		during build.
1521.329Sozaki		Default: no
1531.329Sozaki
1541.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1551.172Shubertf		Default: yes
1561.172Shubertf
1571.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1581.184Slukem		into /usr/libdata/debug.
1591.184Slukem		Default: no
1601.184Slukem
1611.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1621.219Slukem		with -DDEBUG.
1631.176Schristos		Default: no
1641.176Schristos
1651.314SchristosMKDEPINCLUDES	If "yes" issue .include statements in the .depend file
1661.314Schristos		instead of inlining the contents of the .d files. Useful
1671.314Schristos		when stale dependencies are present, to list the exact
1681.314Schristos		files that need refreshing. It is off by default because
1691.314Schristos		it is possibly slower.
1701.314Schristos		Default "no"
1711.314Schristos
1721.172ShubertfMKDOC		If "no", don't build or install the documentation.
1731.172Shubertf		Default: yes
1741.172Shubertf
1751.302SjkoshyMKDTRACE	If "no", do not build and install the kernel modules,
1761.302Sjkoshy		utilities and libraries used to implement the dtrace(1)
1771.302Sjkoshy		facility.
1781.302Sjkoshy		Default: no
1791.302Sjkoshy
1801.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1811.172Shubertf		don't install certain libraries in /lib, and don't
1821.172Shubertf		install the shared linker into /libexec.
1831.172Shubertf		Default: yes
1841.172Shubertf
1851.260SuebayasiMKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
1861.260Suebayasi		to cross-build programs and libraries externally added by
1871.260Suebayasi		users, and automatically enables creation of those sets.
1881.260Suebayasi		Default: no
1891.260Suebayasi
1901.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1911.186Smrg		libraries (libgcc, libobjc, libstdc++).
1921.172Shubertf		Default: yes
1931.172Shubertf
1941.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
1951.201Slukem		libraries (libgcc, libobjc, libstdc++).
1961.172Shubertf		Default: yes
1971.172Shubertf
1981.172ShubertfMKGDB		If "no", don't build gdb(1).
1991.172Shubertf		Default: yes
2001.172Shubertf
2011.334SdhollandMKGROFFHTMLDOC	If "no", avoid trying to use groff to generate html for
2021.334Sdholland		miscellaneous articles, as this seems to sometimes want
2031.334Sdholland		to run software not in base. Does not affect html man
2041.334Sdholland		pages.
2051.334Sdholland		Default: no
2061.334Sdholland
2071.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
2081.172Shubertf		(libraries and support programs).
2091.172Shubertf		Default: yes
2101.172Shubertf
2111.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
2121.172Shubertf		host, the name, release, and architecture of the host
2131.172Shubertf		operating system will be suffixed to the name of the object
2141.172Shubertf		directory created by "make obj".
2151.172Shubertf		Default: no
2161.172Shubertf
2171.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
2181.222Slukem		Default: yes
2191.172Shubertf
2201.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
2211.172Shubertf		Has no effect on most platforms.
2221.172Shubertf		Default: yes
2231.172Shubertf
2241.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
2251.225Sjoerg		Default: no
2261.225Sjoerg
2271.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
2281.273Smrg		(libraries and support programs).  This option must not be
2291.273Smrg		set to "no" if MKX11 is not "no".
2301.172Shubertf		Default: yes
2311.172Shubertf
2321.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2331.172Shubertf		Texinfo source files.
2341.172Shubertf		Default: yes
2351.172Shubertf
2361.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2371.172Shubertf		Default: yes
2381.172Shubertf
2391.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2401.181Smrg		(depends on libpthread.)
2411.181Smrg		Default: yes
2421.181Smrg
2431.331SmartinMKKDEBUG	If "yes", force building of kernel symbol info and creation
2441.331Smartin		of netbsd.gdb in all kernel builds, independently of the
2451.331Smartin		settings for "makeoptions DEBUG" in the kernel config file.
2461.331Smartin
2471.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2481.172Shubertf		infrastructure (libraries and support programs).
2491.172Shubertf		Default: yes
2501.172Shubertf
2511.304SjkoshyMKKMOD		If "no", disables building of kernel modules.
2521.304Sjkoshy		Default: yes
2531.304Sjkoshy
2541.312SjmmvMKKYUA		If "no", don't build Kyua nor its dependent library Lutok.
2551.312Sjmmv		Note that setting this to "no" does not disable the build of
2561.312Sjmmv		the NetBSD test suite itself; the build of the tests is
2571.312Sjmmv		controlled by the MKATF knob.
2581.312Sjmmv		Default: no (until the import is done and validated)
2591.312Sjmmv
2601.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2611.208Slukem		(libraries and support programs).
2621.208Slukem		Default: yes
2631.208Slukem
2641.316SjoergMKLIBCXX	If not "no", build and install libc++.
2651.316Sjoerg		Default: no
2661.316Sjoerg
2671.316SjoergMKLIBSTDCXX	If not "no", build and install libstdc++.
2681.316Sjoerg		Default: yes
2691.316Sjoerg
2701.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2711.172Shubertf		Also:
2721.172Shubertf			- don't install the .a libraries
2731.172Shubertf			- don't install _pic.a libraries on PIC systems
2741.172Shubertf			- don't build .a libraries on PIC systems
2751.172Shubertf			- don't install the .so symlink on ELF systems
2761.172Shubertf		I.e, only install the shared library (and the .so.major
2771.172Shubertf		symlink on ELF).
2781.172Shubertf		Default: yes
2791.172Shubertf
2801.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2811.172Shubertf		Default: yes
2821.172Shubertf
2831.261StronMKLVM		If "no", don't build or install the logical volume manager
2841.245Sagc		and device mapper tools and libraries
2851.262Stron		Default: yes
2861.245Sagc
2871.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2881.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2891.172Shubertf		Default: yes
2901.172Shubertf
2911.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
2921.256Sjoerg		catman or html pages.  A directory can be exempted by
2931.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
2941.278Sjoerg		if NOMANDOC.${target} is set to "yes".
2951.292Sjoerg		Default: yes
2961.256Sjoerg
2971.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2981.172Shubertf		Default: no
2991.172Shubertf
3001.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
3011.253Stsarna		(libraries and support programs).
3021.253Stsarna		Default: yes
3031.253Stsarna
3041.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
3051.172Shubertf		definition files.
3061.172Shubertf		Default: yes
3071.172Shubertf
3081.275SrmindMKNPF		If "no", don't build or install the NPF and its modules.
3091.275Srmind		Default: yes
3101.275Srmind
3111.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
3121.172Shubertf		and also acts as "MKOBJDIRS=no".
3131.172Shubertf		Default: yes
3141.172Shubertf
3151.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
3161.172Shubertf		Default: no
3171.172Shubertf
3181.172ShubertfMKPAM		If "no", disables building of PAM authentication
3191.172Shubertf		infrastructure (libraries and support programs).
3201.182Speter		Default: yes
3211.172Shubertf
3221.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
3231.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
3241.210Sgmcgarry		Default: no
3251.210Sgmcgarry
3261.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
3271.172Shubertf		Default: yes
3281.172Shubertf
3291.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
3301.172Shubertf		also acts as "MKPICLIB=no"
3311.301Sabs		Default: yes (for MACHINE_ARCHs that support it)
3321.172Shubertf
3331.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
3341.172Shubertf		Default: yes
3351.172Shubertf
3361.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
3371.172Shubertf		shared object libraries from the .a libraries.
3381.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
3391.172Shubertf		_pic.a library pointing to the .a library.
3401.172Shubertf		Default: yes
3411.172Shubertf
3421.198SchristosMKPIE		If "no", create regular executables. Otherwise create
3431.198Schristos		PIE (Position Independent Executables).
3441.198Schristos		Default: no
3451.198Schristos
3461.272SmrgMKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
3471.271Smrg		Default: no
3481.271Smrg
3491.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
3501.172Shubertf		Default: yes
3511.172Shubertf
3521.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3531.172Shubertf		Default: yes
3541.172Shubertf
3551.295SwizMKREPRO         If "yes", create reproducable builds. This enables
3561.295Swiz		different switches to make two builds from the same source tree
3571.295Swiz		result in the same build results.
3581.295Swiz		Default: no
3591.295Swiz
3601.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3611.172Shubertf		MKMAN=no MKNLS=no".
3621.172Shubertf		I.e, don't build catman pages, documentation, Info
3631.172Shubertf		documentation, man pages, NLS files, ...
3641.172Shubertf		Default: yes
3651.172Shubertf
3661.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3671.172Shubertf		infrastructure (libraries and support programs).
3681.172Shubertf		Default: yes
3691.172Shubertf
3701.319SadamMKSLJIT		If "no", disables building of sljit (stack-less platform
3711.309Salnsn		independent JIT compiler) private library and tests.
3721.309Salnsn		Default: yes on amd64, i386 and sparc, no elsewhere.
3731.309Salnsn
3741.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3751.172Shubertf		generate output containing library calls for floating
3761.172Shubertf		point and possibly soft-float library support.
3771.172Shubertf		Default: no
3781.172Shubertf
3791.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3801.172Shubertf		libraries.
3811.172Shubertf		Default: yes
3821.172Shubertf
3831.306SchristosMKTPM		If "no" then don't build the Trusted Platform Module
3841.306Schristos		infrastructure.
3851.306Schristos		Default: no
3861.306Schristos
3871.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3881.172Shubertf		files or directories, and keep a metadata log of what
3891.172Shubertf		the owner/group/mode should be.  This allows a
3901.172Shubertf		non-root "make install".
3911.172Shubertf		Default: no
3921.172Shubertf
3931.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
3941.172Shubertf		more recently modified in the source directories that their
3951.172Shubertf		installed counterparts.
3961.172Shubertf		Default: no
3971.172Shubertf
3981.237SmrgMKX11		If not "no", depending on the value of ${X11FLAVOUR},
3991.237Smrg		'make build' also descends into either src/x11 (XFree86) or
4001.237Smrg		src/external/mit/xorg (modular Xorg) to cross-build X11 and
4011.237Smrg		automatically enables creation of X sets.
4021.216Smrg		Default: no
4031.216Smrg
4041.251SmrgMKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
4051.251Smrg		install the X fonts.  The xfont set is still created but
4061.251Smrg		will be empty.
4071.251Smrg		Default: yes
4081.251Smrg
4091.318SmbalmerMKX11MOTIF:	If "yes" and ${X11FLAVOUR} is "Xorg", build the native X11
4101.318Smbalmer		libGLw with Motif stubs.  If Motif is not installed in the
4111.318Smbalmer		default location /usr/pkg, the location can be specified
4121.318Smbalmer		using the X11MOTIFPATH variable.
4131.318Smbalmer		Default: no
4141.318Smbalmer
4151.338SmrgMKX11RADEONKMS	If "no", build the xf86-video-ati 6.x driver (the last one
4161.338Smrg		with user-mode switching support), otherwise build the
4171.338Smrg		kernek-mode switching (KMS) requiring driver.
4181.339Smrg		Default: yes on i386 and amd64, no elsewhere.
4191.338Smrg
4201.341SmrgMKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory,
4211.341Smrg		which is necessary for the radeon DRM driver.
4221.341Smrg		Default: yes on i386 and amd64, no elsewhere.
4231.341Smrg
4241.172ShubertfMKYP		If "no", disables building of YP (NIS)
4251.172Shubertf		infrastructure (libraries and support programs).
4261.172Shubertf		Default: yes
4271.172Shubertf
4281.301SabsMKZFS		If "no", do not build and install utilities and libraries
4291.301Sabs		used to manage ZFS file system. Do not build zfs and solaris
4301.340Spooka		compatibility kernel modules.  Note: ZFS requires 64bit
4311.340Spooka		atomic operations.
4321.340Spooka		Default: yes on amd64, no elsewhere.
4331.254Shaad
4341.298SchristosMKRUMP		If "no", do not build and install rump related headers,
4351.298Schristos		libraries, and programs.
4361.298Schristos		Default: yes
4371.298Schristos
4381.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
4391.172Shubertf		various system utilities/libraries that support it.
4401.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
4411.172Shubertf		forced to "no".
4421.172Shubertf
4431.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
4441.172Shubertf		various system utilities/libraries that support it.
4451.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
4461.172Shubertf		forced to "no".
4471.172Shubertf
4481.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
4491.197Sad		designed for improved performance with threaded
4501.197Sad		applications.  The "phkmalloc" allocator as used up
4511.197Sad		before NetBSD-5.0 will be substituted.
4521.197Sad
4531.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
4541.172Shubertf		support into various system utilities/libraries that
4551.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
4561.172Shubertf		will also be forced to "no".
4571.172Shubertf
4581.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
4591.208Slukem		system utilities/libraries that support it.
4601.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
4611.208Slukem
4621.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
4631.172Shubertf		into various system utilities/libraries that support it.
4641.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
4651.172Shubertf
4661.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
4671.172Shubertf		support into various system utilities/libraries that
4681.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
4691.172Shubertf		also be forced to "no".
4701.204Slukem		Default: no
4711.172Shubertf
4721.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
4731.257Stron		detects stack overflows and aborts the program. The
4741.268Snjoly		stack protection code imposes a performance penalty
4751.259Spgoyette		of about 5%.
4761.258Stron		Default: "no", unless "USE_FORT" is set to "yes"
4771.187Schristos
4781.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
4791.246Schristos		functions that do not do bounds checking regularly, but
4801.246Schristos		they could in some cases by using the gcc
4811.301Sabs		__builtin_object_size() function to determine the buffer
4821.246Schristos		size where it is known and detect buffer overflows.
4831.246Schristos		These substitute functions are in /usr/include/ssp.
4841.257Stron		Default: depends on the part of the source tree
4851.246Schristos
4861.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4871.172Shubertf		various system utilities/libraries that support it.
4881.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4891.172Shubertf
4901.284SmattUSE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
4911.327Sapb		Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
4921.327Sapb		and use nbpigz to compress things.
4931.274Smrg		Default: "no".
4941.274Smrg
4951.237SmrgX11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
4961.237Smrg		XFree86 or modular Xorg.  Only matters if MKX11!=no.
4971.242Smrg		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
4981.242Smrg		"XFree86" on everything else.
4991.237Smrg
5001.172ShubertfCOPTS.lib<lib>
5011.177SmrgOBJCOPTS.lib<lib>
5021.172ShubertfLDADD.lib<lib>
5031.172ShubertfCPPFLAGS.lib<lib>
5041.172ShubertfCXXFLAGS.lib<lib>
5051.172ShubertfCOPTS.<prog>
5061.177SmrgOBJCCOPTS.<prog>
5071.172ShubertfLDADD.<prog>
5081.172ShubertfCPPFLAGS.<prog>
5091.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
5101.172Shubertf		variables in a way that applies only to a particular library
5111.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
5121.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
5131.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
5141.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
5151.172Shubertf		the crypto library.
5161.118Slukem
5171.281SjoergThe active compiler is selected using the following variables:
5181.281SjoergAVAILABLE_COMPILER
5191.281Sjoerg		List of available compiler suites.  Processed in order
5201.281Sjoerg		for selecting the active compiler for each frontend.
5211.281SjoergHAVE_PCC	If defined, PCC is present and enabled.
5221.281SjoergHAVE_LLVM	If defined, LLVM/Clang is present and enabled.
5231.281SjoergUNSUPPORTED_COMPILER.xxx
5241.281Sjoerg		If defined, the support for compiler "xxx" is disabled.
5251.281Sjoerg
5261.281SjoergFor the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
5271.281SjoergACTIVE_CC	Active compile suite for the CC frontend.
5281.281SjoergSUPPORTED_CC	Compile suite with support for the CC frontend.
5291.281SjoergTOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
5301.281Sjoerg
5311.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
5321.1Scgd
5331.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
5341.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
5351.1Scgd
5361.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
5371.1Scgd
5381.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
5391.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
5401.17Sthorpeja few global "feature configuration" parameters.
5411.1Scgd
5421.1ScgdIt has no targets.
5431.1Scgd
5441.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
5451.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
5461.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
5471.29Scjsis included.  These files may define any of the variables described below.
5481.17Sthorpej
5491.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
5501.17Sthorpej(defaults are in brackets):
5511.15Scgd
5521.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
5531.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
5541.98Slukem		otherwise BSDSRCDIR will be used as the default.
5551.98Slukem		Various makefiles within the NetBSD source tree will
5561.98Slukem		use this to reference the top level of the source tree.
5571.98Slukem
5581.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
5591.98Slukem		based on the presence of tools/ and build.sh.  This variable
5601.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
5611.98Slukem		determined once and then propagated to all sub-makes.
5621.95Slukem
5631.305Sapb_NETBSD_VERSION_DEPENDS
5641.305Sapb		A list of files which contain information about
5651.305Sapb		the version of the NetBSD being built.  This is
5661.305Sapb		defined only if the current directory appears
5671.305Sapb		to be inside a NetBSD source tree.  The list of
5681.305Sapb		files includes ${NETBSDSRCDIR}/sys/sys/param.h
5691.305Sapb		(which contains the kernel version number),
5701.305Sapb		${NETBSDSRCDIR}/sys/conf/newvers.sh and
5711.305Sapb		${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
5721.305Sapb		interpret the information in sys/sys/param.h), and
5731.305Sapb		${_SRC_TOP_OBJ_}/params (which is an optional file,
5741.305Sapb		created by "make build" in ${_SRC_TOP_}/Makefile,
5751.305Sapb		containing all the variables that may influence the
5761.305Sapb		build).
5771.305Sapb
5781.305Sapb		Targets that depend on the NetBSD version, or on
5791.305Sapb		variables defined at build time, can declare a
5801.305Sapb		dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
5811.305Sapb
5821.305Sapb			version.c: ${_NETBSD_VERSION_DEPENDS}
5831.305Sapb				commands to create version.c
5841.305Sapb
5851.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
5861.116Slukem		will work correctly.  [/usr/src]
5871.15Scgd
5881.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
5891.116Slukem		will work correctly.  [/usr/obj]
5901.15Scgd
5911.116SlukemBINGRP		Binary group.  [wheel]
5921.15Scgd
5931.116SlukemBINOWN		Binary owner.  [root]
5941.15Scgd
5951.116SlukemBINMODE		Binary mode.  [555]
5961.15Scgd
5971.116SlukemNONBINMODE	Mode for non-executable files.  [444]
5981.15Scgd
5991.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
6001.15Scgd
6011.116SlukemMANGRP		Manual group.  [wheel]
6021.15Scgd
6031.116SlukemMANOWN		Manual owner.  [root]
6041.15Scgd
6051.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
6061.15Scgd
6071.222SlukemMANINSTALL	Manual installation type.  Space separated list:
6081.222Slukem			catinstall, htmlinstall, maninstall
6091.293Sjoerg		Default value derived from MKCATPAGES and MKHTML.
6101.76Sfair
6111.76SfairLDSTATIC	Control program linking; if set blank, link everything
6121.129Slukem		dynamically.  If set to "-static", link everything statically.
6131.76Sfair		If not set, programs link according to their makefile.
6141.21Schristos
6151.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
6161.15Scgd
6171.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
6181.15Scgd
6191.116SlukemLIBGRP		Library group.  [${BINGRP}]
6201.15Scgd
6211.116SlukemLIBOWN		Library owner.  [${BINOWN}]
6221.15Scgd
6231.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
6241.15Scgd
6251.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
6261.116Slukem	        installation.  [/usr/share/doc]
6271.62Ssimonb
6281.116SlukemDOCGRP		Documentation group.  [wheel]
6291.15Scgd
6301.116SlukemDOCOWN		Documentation owner.  [root]
6311.15Scgd
6321.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
6331.15Scgd
6341.335SapbGZIP_N_FLAG	Flags to pass to TOOL_GZIP to prevent it from inserting
6351.335Sapb		file names or timestamps in the compressed output.
6361.335Sapb		[-n, or -nT when TOOL_GZIP is really TOOL_PIGZ]
6371.335Sapb
6381.84SkleinkNLSDIR		Base path for Native Language Support files installation.
6391.15Scgd		[/usr/share/nls]
6401.1Scgd
6411.116SlukemNLSGRP		Native Language Support files group.  [wheel]
6421.1Scgd
6431.116SlukemNLSOWN		Native Language Support files owner.  [root]
6441.1Scgd
6451.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
6461.1Scgd
6471.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
6481.255Sapb		if that exists; otherwise /usr/xsrc]
6491.144Slukem
6501.221SmrgX11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
6511.144Slukem
6521.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
6531.144Slukem
6541.221SmrgX11SRCDIR.lib<package>
6551.221SmrgX11SRCDIR.<package>
6561.221Smrg		The path to the xorg src tree for the specificed package>.
6571.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
6581.221Smrg
6591.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
6601.221Smrg		[/usr/X11R7]
6611.144Slukem
6621.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
6631.144Slukem
6641.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
6651.144Slukem
6661.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
6671.144Slukem
6681.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
6691.144Slukem
6701.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
6711.144Slukem
6721.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
6731.144Slukem
6741.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
6751.1Scgd		to be stripped.  This is to be used when building your
6761.1Scgd		own install script so that the entire system can be made
6771.146Slukem		stripped/not-stripped using a single knob.  []
6781.1Scgd
6791.2ScgdCOPY		The flag passed to the install program to cause the binary
6801.2Scgd		to be copied rather than moved.  This is to be used when
6811.2Scgd		building our own install script so that the entire system
6821.2Scgd		can either be installed with copies, or with moves using
6831.116Slukem		a single knob.  [-c]
6841.15Scgd
6851.310SapbMAKEDIRTARGETENV
6861.310Sapb		Environment variables passed to the child make process
6871.310Sapb		invoked by MAKEDIRTARGET.
6881.310Sapb
6891.150SlukemMAKEDIRTARGET dir target [params]
6901.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
6911.150Slukem		displaying a "pretty" message whilst doing so.
6921.150Slukem
6931.152SclRELEASEMACHINEDIR
6941.152Scl		Subdirectory used below RELEASEDIR when building
6951.152Scl		a release.  [${MACHINE}]
6961.152Scl
6971.152SclRELEASEMACHINE	Subdirectory or path component used for the following
6981.152Scl		paths:
6991.152Scl			distrib/${RELEASEMACHINE}
7001.152Scl			distrib/notes/${RELEASEMACHINE}
7011.152Scl			etc/etc.${RELEASEMACHINE}
7021.152Scl		Used when building a release.  [${MACHINE}]
7031.150Slukem
7041.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
7051.214Swizmake configuration file to modify the behavior of the system build
7061.17Sthorpejprocess (default values are in brackets along with comments, if set by
7071.134Slukem<bsd.own.mk>):
7081.33Sjonathan
7091.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
7101.172Shubertf		be used as part of a build in progress.
7111.172Shubertf		Supported values:
7121.172Shubertf
7131.172Shubertf		yes	Use the tools from TOOLDIR.
7141.172Shubertf			Must be set to this if cross-compiling.
7151.172Shubertf
7161.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
7171.172Shubertf			build native compilation tool components that are
7181.172Shubertf			version-specific for that tool.
7191.172Shubertf
7201.172Shubertf		never	Do not use the tools from TOOLDIR, even when
7211.172Shubertf			building native tool components.  This is similar to
7221.172Shubertf			the traditional NetBSD build method, but does not
7231.172Shubertf			verify that the compilation tools in use are
7241.172Shubertf			up-to-date enough in order to build the tree
7251.172Shubertf			successfully.  This may cause build or runtime
7261.172Shubertf			problems when building the whole NetBSD source tree.
7271.172Shubertf
7281.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
7291.172Shubertf		source tree (detected automatically); "no" otherwise
7301.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
7311.172Shubertf		make(1) include files).
7321.142Slukem
7331.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
7341.199Ssimonb		use ELF -- currently all architectures].
7351.33Sjonathan
7361.103SthorpejTOOLCHAIN_MISSING
7371.142Slukem		If not "no", this indicates that the platform being built
7381.103Sthorpej		does not have a working in-tree toolchain.  If the
7391.142Slukem		${MACHINE_ARCH} in question falls into this category,
7401.301Sabs		TOOLCHAIN_MISSING is conditionally assigned the value "yes".
7411.103Sthorpej		Otherwise, the variable is unconditionally assigned the
7421.103Sthorpej		value "no".
7431.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
7441.142Slukem		unconditionally assigned the value "no".
7451.103Sthorpej
7461.103SthorpejEXTERNAL_TOOLCHAIN
7471.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
7481.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
7491.103Sthorpej		access to this variable.  The variable should be defined
7501.103Sthorpej		either in the user's environment or in the user's mk.conf
7511.103Sthorpej		file.  If defined, this variable indicates the root of
7521.103Sthorpej		an external toolchain which will be used to build the
7531.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
7541.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
7551.103Sthorpej		cross-compile framework.
7561.103Sthorpej
7571.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
7581.142Slukem		assigned the value "no", since the external version of the
7591.142Slukem		compiler may not be able to build the library components of
7601.142Slukem		the in-tree compiler.
7611.103Sthorpej
7621.103Sthorpej		NOTE: This variable is not yet used in as many places as
7631.103Sthorpej		it should be.  Expect the exact semantics of this variable
7641.103Sthorpej		to change in the short term as parts of the cross-compile
7651.103Sthorpej		framework continue to be cleaned up.
7661.1Scgd
7671.236SapbThe following variables are defined to commands to perform the
7681.236Sapbappropriate operation, with the default in [brackets].  Note that
7691.236Sapbthe defaults change if USETOOLS == "yes":
7701.236Sapb
7711.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
7721.236Sapb
7731.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
7741.236Sapb
7751.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
7761.236Sapb
7771.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
7781.236Sapb
7791.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
7801.236Sapb
7811.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
7821.236Sapb
7831.236SapbTOOL_CAT		Concatenate and print files.  [cat]
7841.236Sapb
7851.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
7861.236Sapb
7871.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
7881.236Sapb
7891.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
7901.236Sapb
7911.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
7921.236Sapb
7931.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
7941.236Sapb
7951.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
7961.236Sapb
7971.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
7981.236Sapb
7991.236SapbTOOL_EQN		Format equations for groff.  [eqn]
8001.236Sapb
8011.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
8021.236Sapb
8031.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
8041.236Sapb
8051.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
8061.236Sapb
8071.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
8081.236Sapb
8091.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
8101.236Sapb
8111.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
8121.247Ssketch
8131.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
8141.236Sapb
8151.327SapbTOOL_GZIP		Compression/decompression tool.  [gzip]
8161.327Sapb
8171.335SapbTOOL_GZIP_N		Same as TOOL_GZIP, plus a command line option to
8181.335Sapb			prevent it from inserting file names or timestamps
8191.335Sapb			into the compressed output.
8201.335Sapb			[${TOOL_GZIP} ${GZIP_N_FLAG}]
8211.335Sapb
8221.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
8231.236Sapb
8241.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
8251.236Sapb
8261.328SskrllTOOL_HPPAMKBOOT		Make bootable image for hppa.  [hppa-mkboot]
8271.236Sapb
8281.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
8291.236Sapb
8301.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
8311.236Sapb
8321.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
8331.236Sapb
8341.236SapbTOOL_JOIN		Relational database operator.  [join]
8351.236Sapb
8361.236SapbTOOL_M4			M4 macro language processor.  [m4]
8371.236Sapb
8381.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
8391.236Sapb
8401.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
8411.236Sapb
8421.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
8431.236Sapb
8441.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
8451.236Sapb
8461.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
8471.236Sapb
8481.236SapbTOOL_MENUC		Menu compiler.  [menuc]
8491.236Sapb
8501.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
8511.236Sapb			[mips-elf2ecoff]
8521.236Sapb
8531.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
8541.236Sapb
8551.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
8561.236Sapb
8571.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
8581.236Sapb
8591.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
8601.236Sapb
8611.311SjmcneillTOOL_MKNOD		Make device special file.  [mknod]
8621.311Sjmcneill
8631.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
8641.236Sapb
8651.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
8661.236Sapb
8671.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
8681.236Sapb
8691.332SphxTOOL_NCDCS		Turn ELF kernel into a NCD firmware image. [ncdcs]
8701.332Sphx
8711.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
8721.236Sapb
8731.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
8741.236Sapb
8751.273SmrgTOOL_PIGZ		Parallel compressor.  [pigz]
8761.273Smrg
8771.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
8781.236Sapb
8791.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
8801.236Sapb
8811.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
8821.236Sapb
8831.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
8841.236Sapb
8851.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
8861.236Sapb
8871.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
8881.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
8891.236Sapb
8901.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
8911.236Sapb
8921.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
8931.236Sapb
8941.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
8951.236Sapb
8961.236SapbTOOL_SED		Stream editor.  [sed]
8971.236Sapb
8981.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
8991.236Sapb
9001.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
9011.236Sapb			[sparkcrc]
9021.236Sapb
9031.236SapbTOOL_STAT		Display file status.  [stat]
9041.236Sapb
9051.236SapbTOOL_STRFILE		Create a random access file for storing strings.
9061.236Sapb			[strfile]
9071.236Sapb
9081.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
9091.236Sapb
9101.236SapbTOOL_TBL		Format tables for groff.  [tbl]
9111.236Sapb
9121.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
9131.236Sapb
9141.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
9151.236Sapb
9161.236SapbTOOL_ZIC		Time zone compiler.  [zic]
9171.236Sapb
9181.323SmattFor each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
9191.323Smattlist of what ports can be built for it.  This keeps those definitions in
9201.323Smattcentralized place.
9211.323Smatt
9221.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
9231.1Scgdthey use the same default owners etc. as the rest of the tree.
9241.131Slukem
9251.131Slukem
9261.286Sapb=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
9271.286Sapb
9281.286SapbThe include file <bsd.clean.mk> defines the clean and cleandir
9291.286Sapbtargets.  It uses the following variables:
9301.286Sapb
9311.286SapbCLEANFILES	Files to remove for both the clean and cleandir targets.
9321.286Sapb
9331.286SapbCLEANDIRFILES	Files to remove for the cleandir target, but not for
9341.286Sapb		the clean target.
9351.286Sapb
9361.287SapbMKCLEANSRC	Controls whether or not the clean and cleandir targets
9371.287Sapb		will delete files from both the object directory,
9381.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.
9391.287Sapb
9401.287Sapb		If MKCLEANSRC is set to "no", then the file names in
9411.287Sapb		CLEANFILES or CLEANDIRFILES are interpreted relative
9421.287Sapb		to the object directory, ${.OBJDIR}.  This is the
9431.287Sapb		traditional behaviour.
9441.287Sapb
9451.287Sapb		If MKCLEANSRC is set to "yes", then the file deletion
9461.287Sapb		is performed relative to both the object directory,
9471.287Sapb		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
9481.287Sapb		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
9491.287Sapb		Deleting files from ${.CURDIR} is intended to remove
9501.287Sapb		stray output files that had been left in the source
9511.287Sapb		directory by an earlier build that did not use object
9521.287Sapb		directories.
9531.287Sapb
9541.287Sapb		The default is MKCLEANSRC=yes.  If you always build with
9551.287Sapb		separate object directories, and you are sure that there
9561.287Sapb		are no stray files in the source directories, then you
9571.287Sapb		may set MKCLEANSRC=no to save some time.
9581.287Sapb
9591.287SapbMKCLEANVERIFY	Controls whether or not the clean and cleandir targets
9601.287Sapb		will verify that files have been deleted.
9611.287Sapb
9621.287Sapb		If MKCLEANVERIFY is set to "no", then the files will
9631.287Sapb		be deleted using a "rm -f" command, and its success or
9641.287Sapb		failure will be ignored.
9651.287Sapb
9661.287Sapb		If MKCLEANVERIFY is set to "yes", then the success of
9671.287Sapb		the "rm -f" command will be verified using an "ls"
9681.287Sapb		command.
9691.287Sapb
9701.287Sapb		The default is MKCLEANVERIFY=yes.  If you are sure that
9711.287Sapb		there will be no problems caused by file permissions,
9721.287Sapb		read-only file systems, or the like, then you may set
9731.287Sapb		MKCLEANVERIFY=no to save some time.
9741.286Sapb
9751.286SapbTo use the clean and cleandir targets defined in <bsd.clean.mk>, other
9761.286SapbMakefiles or bsd.*.mk files should append file names to the CLEANFILES
9771.286Sapbor CLEANDIRFILES variables.  For example:
9781.286Sapb
9791.286Sapb	    CLEANFILES+= a.out
9801.286Sapb	    CLEANDIRFILES+= .depend
9811.286Sapb
9821.286Sapb	    .include <bsd.clean.mk>
9831.286Sapb
9841.308SapbThe files listed in CLEANFILES and CLEANDIRFILES must not be
9851.308Sapbdirectories, because the potential risk from running "rm -rf" commands
9861.308Sapbin bsd.clean.mk is considered too great.  If you want to recursively
9871.308Sapbdelete a directory as part of "make clean" or "make cleandir" then you
9881.308Sapbneed to provide your own target.
9891.286Sapb
9901.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
9911.131Slukem
9921.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
9931.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
9941.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
9951.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
9961.133Slukemdependencies for the .d files.  In order for this to function correctly,
9971.132Slukemit should be .included after all other .mk files and directives that may
9981.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
9991.132Slukem
10001.132SlukemSRCS		List of source files to build the program.
10011.132Slukem
10021.132SlukemDPSRCS		List of source files which are needed for generating
10031.132Slukem		dependencies, but are not needed in ${SRCS}.
10041.1Scgd
10051.1Scgd
10061.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
10071.106Sthorpej
10081.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
10091.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
10101.124Slukem
10111.124SlukemFILES		The list of files to install.
10121.124Slukem
10131.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
10141.153Slukem		are installed by the `configinstall' target,
10151.153Slukem		not the `install' target.
10161.153Slukem		The FILES* variables documented below also apply.
10171.153Slukem
10181.124SlukemFILESOWN	File owner.  [${BINOWN}]
10191.124Slukem
10201.124SlukemFILESGRP	File group.  [${BINGRP}]
10211.124Slukem
10221.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
10231.124Slukem
10241.124SlukemFILESDIR	The location to install the files.
10251.124Slukem
10261.124SlukemFILESNAME	Optional name to install each file as.
10271.124Slukem
10281.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
10291.153Slukem
10301.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
10311.153Slukem
10321.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
10331.153Slukem
10341.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
10351.153Slukem
10361.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
10371.124Slukem
10381.285SapbFILESBUILD	If this variable is defined, then its value will be
10391.285Sapb		used as the default for all FILESBUILD_<fn> variables.
10401.285Sapb		Otherwise, the default will be "no".
10411.285Sapb
10421.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
10431.243Scube		targets to be built by `realall'.  Users of that variable
10441.243Scube		should provide a target to build the file.
10451.243Scube
10461.135Slukem
10471.139SlukemBUILDSYMLINKS	List of two word items:
10481.135Slukem			lnsrc lntgt
10491.135Slukem		For each lnsrc item, create a symlink named lntgt.
10501.135Slukem		The lntgt symlinks are removed by the cleandir target.
10511.106Sthorpej
10521.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
10531.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
10541.301Sabs		The source files have a `.uue' suffix, the generated files do
10551.148Sjmc		not.
10561.149Sjmc
10571.202SuweUUDECODE_FILES_RENAME_<fn>
10581.202Suwe		Rename the output from the decode to the provided name.
10591.148Sjmc		
10601.148Sjmc		*NOTE: These files are simply decoded, with no install or other
10611.148Sjmc		       rule applying implicitly except being added to the clean
10621.148Sjmc		       target.
10631.106Sthorpej
10641.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
10651.113Sthorpej
10661.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
10671.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
10681.134Slukembefore <bsd.gcc.mk>.
10691.113Sthorpej
10701.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
10711.113Sthorpejof which need to know where to find certain GCC support libraries.
10721.113Sthorpej
10731.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
10741.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
10751.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
10761.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
10771.113Sthorpej
10781.134Slukem<bsd.gcc.mk> sets the following variables:
10791.113Sthorpej
10801.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
10811.118Slukem
10821.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
10831.118Slukem
10841.118Slukem_GCC_CRTEND	The full path name to crtend.o.
10851.118Slukem
10861.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
10871.118Slukem
10881.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
10891.118Slukem
10901.118Slukem
10911.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
10921.118Slukem
10931.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
10941.118Slukemvariables:
10951.118Slukem
10961.124SlukemINCS		The list of include files.
10971.118Slukem
10981.118SlukemINCSDIR		The location to install the include files.
10991.118Slukem
11001.118SlukemINCSNAME	Target name of the include file, if only one; same as
11011.118Slukem		FILESNAME, but for include files.
11021.118Slukem
11031.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
11041.134Slukem		are installed in the 'includes' target and not the
11051.134Slukem		(much later) 'install' target.
11061.134Slukem
11071.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
11081.118Slukem		same as FILESNAME_<file>, but for include files.
11091.118Slukem
11101.118Slukem
11111.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
11121.118Slukem
11131.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
11141.118Slukemdocumentation from respective Texinfo source files.  It defines three
11151.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
11161.118Slukemfollowing variables:
11171.118Slukem
11181.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
11191.118Slukem		consist of single files with the extension replaced by
11201.118Slukem		.info.
11211.118Slukem
11221.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
11231.118Slukem
11241.118Slukem
11251.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
11261.118Slukem
11271.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
11281.118Slukemlocation of kernel sources and object directories.
11291.118Slukem
11301.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
11311.124Slukem		[${_SRC_TOP_}/sys]
11321.118Slukem
11331.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
11341.124Slukem		[arch/${MACHINE}]
11351.120Slukem
11361.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
11371.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
11381.118Slukem
11391.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
11401.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
11411.118Slukem		The default value is
11421.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
11431.118Slukem		if it exists or the target 'obj' is being made.
11441.118Slukem		Otherwise the default is
11451.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
11461.118Slukem
11471.118SlukemIt is important that Makefiles (such as those under src/distrib) that
11481.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
11491.118Slukemrather than make assumptions about the location of the compiled kernel.
11501.118Slukem
11511.118Slukem
11521.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
11531.118Slukem
11541.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
11551.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
11561.118Slukeminclude file installation.  It is intended to be included alone, by
11571.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
11581.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
11591.134Slukemin that file up to date.
11601.118Slukem
11611.325Schristos=-=-=-=-=   bsd.syscall.mk =-=-=-=-=
11621.325Schristos
11631.325SchristosThe include file <bsd.syscall.mk> contains the logic to create syscall
11641.325Schristosfiles for various emulations. It includes <bsd.kinc.mk> to handle the
11651.325Schristosrest of the targets.
11661.118Slukem
11671.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
11681.118Slukem
11691.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
11701.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
11711.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
11721.118Slukemwhich checks for installed shared object libraries whose version is greater
11731.118Slukemthat the version of the source. It has a limited number of suffixes,
11741.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
11751.118Slukem<bsd.shlib.mk> to get shared library parameters.
11761.118Slukem
11771.118SlukemIt sets/uses the following variables:
11781.118Slukem
11791.118SlukemLIB		The name of the library to build.
11801.118Slukem
11811.118SlukemLIBDIR		Target directory for libraries.
11821.118Slukem
11831.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
11841.248Sperry		permissions in files inside its archives to those of
11851.248Sperry		the file it was fed. This leads to non-reproduceable
11861.324Sapb		builds. If MKARZERO is set to "yes" (default is the
11871.324Sapb		same as MKREPRO, or "no" if MKREPRO is not defined),
11881.248Sperry		then the "D" flag is passed to ar, causing the
11891.248Sperry		timestamp, uid and gid to be zeroed and the file
11901.248Sperry		permissions to be set to 644. This allows .a files
11911.248Sperry		from different builds to be bit identical.
11921.248Sperry
11931.300SjoergSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
11941.300Sjoerg		is not "no".
11951.300Sjoerg
11961.263SabsSHLIB_MAJOR
11971.263SabsSHLIB_MINOR
11981.263SabsSHLIB_TEENY	Major, minor, and teeny version numbers of shared library
11991.263Sabs
12001.300SjoergUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
12011.118Slukem		as the path to install shared libraries to.
12021.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
12031.130Slukem		Default: no
12041.118Slukem
12051.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
12061.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
12071.218Slukem		MKPROFILE=no MKSTATICLIB=no".
12081.218Slukem		Default: no
12091.218Slukem
12101.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
12111.211Slukem		MKPROFILE=no", and don't install the (.a) library.
12121.154Slukem		This is useful for "build only" helper libraries.
12131.154Slukem		Default: no
12141.154Slukem
12151.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
12161.244Smrg		shared libraries.
12171.244Smrg		This is useful for C++ libraries.
12181.244Smrg		Default: no
12191.244Smrg
12201.118SlukemLINTLIBDIR	Target directory for lint libraries.
12211.118Slukem
12221.118SlukemLIBGRP		Library group.
12231.118Slukem
12241.118SlukemLIBOWN		Library owner.
12251.118Slukem
12261.118SlukemLIBMODE		Library mode.
12271.118Slukem
12281.118SlukemLDADD		Additional loader objects.
12291.118Slukem
12301.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
12311.118Slukem
12321.118SlukemNOCHECKVER_<library>
12331.118SlukemNOCHECKVER	If set, disables checking for installed shared object
12341.118Slukem		libraries with versions greater than the source.  A
12351.118Slukem		particular library name, without the "lib" prefix, may
12361.118Slukem		be appended to the variable name to disable the check for
12371.118Slukem		only that library.
12381.118Slukem
12391.118SlukemSRCS		List of source files to build the library.  Suffix types
12401.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
12411.118Slukem		to .c files of the same name.  (This is not the default for
12421.118Slukem		versions of make.)
12431.118Slukem
12441.157SlukemLIBDPLIBS	A list of the tuples:
12451.157Slukem			libname  path-to-srcdir-of-libname
12461.157Slukem
12471.157Slukem		For each tuple;
12481.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
12491.157Slukem			`libname', and if it is not set it is determined
12501.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
12511.157Slukem			latter is to allow for build time optimization).
12521.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
12531.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
12541.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
12551.157Slukem
12561.307Spooka		The special value "_external" for LIBDO.lib makes the
12571.307Spooka		build system to assume the library comes from outside
12581.307Spooka		of the NetBSD source tree and only causes -llibname
12591.307Spooka		to be added to LDADD.
12601.307Spooka
12611.157Slukem		This variable may be used for individual libraries, as
12621.301Sabs		well as in parent directories to cache common libraries
12631.157Slukem		as a build-time optimization.
12641.157Slukem
12651.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
12661.118Slukemif it exists, as well as the include file <bsd.man.mk>.
12671.118Slukem
12681.118SlukemIt has rules for building profiled objects; profiled libraries are
12691.118Slukembuilt by default.
12701.118Slukem
12711.118SlukemLibraries are ranlib'd when made.
12721.118Slukem
12731.118Slukem
12741.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
12751.118Slukem
12761.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
12771.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
12781.134Slukem
12791.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
12801.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
12811.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
12821.249Sapbby a method for explicitly recording hard links in a metadata log.
12831.249Sapb
12841.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
12851.134Slukem			source-file target-file
12861.134Slukem		${DESTDIR} is prepended to both paths before linking.
12871.134Slukem		For example, to link /bin/test and /bin/[, use:
12881.134Slukem			LINKS=/bin/test /bin/[
12891.134Slukem
12901.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
12911.153Slukem		are installed by the `configinstall' target,
12921.153Slukem		not the `install' target.
12931.153Slukem
12941.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
12951.134Slukem			source-file target-file
12961.134Slukem		${DESTDIR} is only prepended to target-file before linking.
12971.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
12981.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
12991.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
13001.118Slukem
13011.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
13021.153Slukem		are installed by the `configinstall' target,
13031.153Slukem		not the `install' target.
13041.153Slukem
13051.249SapbLINKSOWN	Link owner.  [${BINOWN}]
13061.249Sapb
13071.249SapbLINKSGRP	Link group.  [${BINGRP}]
13081.249Sapb
13091.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
13101.249Sapb
13111.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
13121.249Sapb
13131.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
13141.249Sapb
13151.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
13161.249Sapb
13171.118Slukem
13181.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
13191.118Slukem
13201.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
13211.118Slukemlinks.
13221.118Slukem
13231.222SlukemIt has a three targets:
13241.118Slukem
13251.222Slukem	catinstall:
13261.222Slukem		Install the preformatted manual pages and their links.
13271.222Slukem	htmlinstall:
13281.222Slukem		Install the HTML manual pages and their links.
13291.118Slukem	maninstall:
13301.118Slukem		Install the manual page sources and their links.
13311.118Slukem
13321.118SlukemIt sets/uses the following variables:
13331.118Slukem
13341.118SlukemMANDIR		Base path for manual installation.
13351.118Slukem
13361.118SlukemMANGRP		Manual group.
13371.118Slukem
13381.118SlukemMANOWN		Manual owner.
13391.118Slukem
13401.118SlukemMANMODE		Manual mode.
13411.118Slukem
13421.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
13431.118Slukem		or "/tahoe" for machine specific manual pages.
13441.118Slukem
13451.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
13461.118Slukem
13471.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
13481.118Slukem		linked-to file must come first, the linked file second,
13491.276Sreed		and there may be multiple pairs.
13501.118Slukem
13511.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
13521.118Slukemit exists.
13531.118Slukem
13541.118Slukem
13551.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
13561.118Slukem
13571.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
13581.118Slukemand use of separated object and source directories.
13591.118Slukem
13601.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
13611.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
13621.118Slukemit exists.  Otherwise make(1) looks for the existence of a
13631.118Slukemsubdirectory (or a symlink to a directory) of the source directory
13641.118Slukeminto which built targets should be placed.  If an environment variable
13651.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
13661.118Slukemobject directory; failing that, make first looks for a subdirectory
13671.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
13681.118Slukem
13691.118SlukemObject directories are not created automatically by make(1) if they
13701.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
13711.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
13721.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
13731.118Slukemand this is determined by a simple string prefix comparison -- object
13741.118Slukemdirectories are created in a separate object directory tree, and a
13751.118Slukemsymlink to the object directory in that tree is created in the source
13761.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
13771.118Slukemsource tree and that it's not safe to use a separate object tree.
13781.118Slukem
13791.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
13801.118Slukemdirectories and links get created during a "make obj":
13811.118Slukem
13821.118SlukemMAKEOBJDIR	If set, this is the component name of the object
13831.118Slukem		directory.
13841.118Slukem
13851.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
13861.118Slukem		object directories or links named "obj.${MACHINE}";
13871.118Slukem		otherwise, just creates ones named "obj".
13881.118Slukem
13891.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
13901.118Slukem		${BSDSRCDIR}, create object directory in the
13911.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
13921.118Slukem		otherwise, create it in the corresponding subdirectory
13931.118Slukem		of ${BSDOBJDIR}
13941.113Sthorpej
13951.118SlukemBUILDID		If set, the contents of this variable are appended
13961.118Slukem		to the object directory name.  If OBJMACHINE is also
13971.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
13981.113Sthorpej
13991.106Sthorpej
14001.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
14011.106Sthorpej
14021.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
14031.1Scgdmore source files, along with their manual pages.  It has a limited number
14041.301Sabsof suffixes, consistent with the current needs of the BSD tree.
14051.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
14061.1Scgd
14071.16SjtcIt has eight targets:
14081.1Scgd
14091.1Scgd	all:
14101.102Sthorpej		build the program and its manual page.  This also
14111.102Sthorpej		creates a GDB initialization file (.gdbinit) in
14121.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
14131.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
14141.1Scgd	clean:
14151.1Scgd		remove the program, any object files and the files a.out,
14161.24Smikel		Errs, errs, mklog, and ${PROG}.core.
14171.1Scgd	cleandir:
14181.1Scgd		remove all of the files removed by the target clean, as
14191.1Scgd		well as .depend, tags, and any manual pages.
14201.42Slukem		`distclean' is a synonym for `cleandir'.
14211.1Scgd	depend:
14221.1Scgd		make the dependencies for the source files, and store
14231.1Scgd		them in the file .depend.
14241.16Sjtc	includes:
14251.16Sjtc		install any header files.
14261.1Scgd	install:
14271.1Scgd		install the program and its manual pages; if the Makefile
14281.1Scgd		does not itself define the target install, the targets
14291.1Scgd		beforeinstall and afterinstall may also be used to cause
14301.1Scgd		actions immediately before and after the install target
14311.1Scgd		is executed.
14321.1Scgd	lint:
14331.1Scgd		run lint on the source files
14341.1Scgd	tags:
14351.1Scgd		create a tags file for the source files.
14361.1Scgd
14371.1ScgdIt sets/uses the following variables:
14381.1Scgd
14391.1ScgdBINGRP		Binary group.
14401.1Scgd
14411.1ScgdBINOWN		Binary owner.
14421.1Scgd
14431.1ScgdBINMODE		Binary mode.
14441.1Scgd
14451.286SapbCLEANDIRFILES	Additional files to remove for the cleandir target.
14461.286Sapb
14471.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
14481.1Scgd
14491.337SuebayasiCONFIGOPTS	Additional flags to config(1) when building kernels.
14501.337Suebayasi
14511.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
14521.112Sthorpej
14531.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
14541.125Slukem		C objects for <fn>.
14551.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14561.125Slukem
14571.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
14581.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
14591.35Slukem
14601.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
14611.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14621.125Slukem
14631.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
14641.125Slukem
14651.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
14661.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
14671.102Sthorpej
14681.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
14691.102Sthorpej		directives in the .gdbinit file that is created in the
14701.102Sthorpej		objdir.
14711.1Scgd
14721.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
14731.1Scgd		For example, to load with the compatibility and utility
14741.1Scgd		libraries, use:
14751.1Scgd
14761.5Sjtc			LDADD+=-lutil -lcompat
14771.1Scgd
14781.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
14791.1Scgd
14801.134SlukemLINKS		See <bsd.links.mk>
14811.134Slukem
14821.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
14831.177Smrg
14841.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
14851.177Smrg		ObjC objects for <fn>.
14861.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
14871.177Smrg
14881.134SlukemSYMLINKS	See <bsd.links.mk>
14891.1Scgd
14901.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
14911.8Scgd		defined, "MAN=${PROG}.1" is assumed.
14921.1Scgd
14931.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
14941.212Slukem		time, with the value of this variable as args to paxctl(1).
14951.193Sperry
14961.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
14971.193Sperry
14981.1ScgdPROG		The name of the program to build.  If not supplied, nothing
14991.1Scgd		is built.
15001.1Scgd
15011.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
15021.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
15031.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
15041.88Sthorpej		the value of PROG if PROG is also set.
15051.87Sthorpej
15061.21SchristosPROGNAME	The name that the above program will be installed as, if
15071.21Schristos		different from ${PROG}.
15081.21Schristos
15091.37StvSRCS		List of source files to build the program.  If SRCS is not
15101.1Scgd		defined, it's assumed to be ${PROG}.c.
15111.108Sjwise
15121.108SjwiseDPSRCS		List of source files which are needed for generating
15131.108Sjwise		dependencies, but are not needed in ${SRCS}.
15141.1Scgd
15151.1ScgdDPADD		Additional dependencies for the program.  Usually used for
15161.1Scgd		libraries.  For example, to depend on the compatibility and
15171.1Scgd		utility libraries use:
15181.1Scgd
15191.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
15201.1Scgd
15211.288Schristos		The following system libraries are predefined for DPADD:
15221.1Scgd
15231.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
15241.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
15251.279Sjmmv		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
15261.279Sjmmv		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
15271.288Schristos		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
15281.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
15291.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
15301.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
15311.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
15321.288Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
15331.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
15341.288Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
15351.322Sjoerg		LIBCRTI?=	${DESTDIR}/usr/lib/crti.o
15361.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
15371.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
15381.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
15391.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
15401.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
15411.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
15421.288Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
15431.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
15441.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
15451.288Schristos		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
15461.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
15471.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
15481.315Schristos		LIBEVENT_OPENSSL?=	${DESTDIR}/usr/lib/libevent_openssl.a
15491.315Schristos		LIBEVENT_PTHREADS?=	${DESTDIR}/usr/lib/libevent_pthreads.a
15501.294Stron		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
15511.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
15521.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
15531.288Schristos		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
15541.288Schristos		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
15551.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
15561.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
15571.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
15581.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
15591.288Schristos		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
15601.288Schristos		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
15611.288Schristos		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
15621.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
15631.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
15641.288Schristos		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
15651.288Schristos		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
15661.288Schristos		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
15671.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
15681.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
15691.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
15701.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
15711.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
15721.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
15731.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
15741.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
15751.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
15761.277Smbalmer		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
15771.313Sjmmv		LIBLUTOK?=	${DESTDIR}/usr/lib/liblutok.a
15781.288Schristos		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
15791.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
15801.288Schristos		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
15811.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
15821.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
15831.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
15841.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
15851.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
15861.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
15871.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
15881.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
15891.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
15901.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
15911.288Schristos		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
15921.288Schristos		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
15931.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
15941.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
15951.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
15961.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
15971.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
15981.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
15991.288Schristos		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
16001.289Schristos		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
16011.289Schristos		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
16021.289Schristos		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
16031.289Schristos		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
16041.289Schristos		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
16051.289Schristos		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
16061.289Schristos		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
16071.289Schristos		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
16081.289Schristos		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
16091.289Schristos		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
16101.289Schristos		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
16111.289Schristos		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
16121.289Schristos		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
16131.288Schristos		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
16141.288Schristos		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
16151.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
16161.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
16171.288Schristos		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
16181.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
16191.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
16201.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
16211.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
16221.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
16231.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
16241.264Sroy		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
16251.290Schristos		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
16261.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
16271.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
16281.288Schristos		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
16291.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
16301.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
16311.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
16321.1Scgd
16331.288Schristos		The following X-Windows libraries are predefined for DPADD:
16341.288Schristos
16351.288Schristos		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
16361.288Schristos		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
16371.288Schristos		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
16381.288Schristos		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
16391.288Schristos		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
16401.288Schristos		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
16411.317Smrg		LIBX11_XCB?=	${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
16421.288Schristos		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
16431.288Schristos		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
16441.288Schristos		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
16451.320Schristos		LIBXCB?=	${DESTDIR}/usr/X11R7/lib/libxcb.a
16461.288Schristos		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
16471.288Schristos		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
16481.288Schristos		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
16491.288Schristos		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
16501.288Schristos		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
16511.288Schristos		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
16521.288Schristos		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
16531.288Schristos		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
16541.288Schristos		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
16551.288Schristos		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
16561.288Schristos		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
16571.288Schristos		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
16581.288Schristos		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
16591.288Schristos		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
16601.288Schristos		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
16611.288Schristos		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
16621.288Schristos		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
16631.288Schristos		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
16641.288Schristos		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
16651.288Schristos		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
16661.288Schristos		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
16671.288Schristos		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
16681.288Schristos		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
16691.288Schristos		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
16701.288Schristos		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
16711.288Schristos		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
16721.288Schristos
16731.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
16741.12Schristos		strings, using xstr(1). Note that this will not work with
16751.12Schristos		parallel makes.
16761.1Scgd
16771.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
16781.1Scgd		to be stripped.
16791.1Scgd
16801.1ScgdSUBDIR		A list of subdirectories that should be built as well.
16811.1Scgd		Each of the targets will execute the same target in the
16821.1Scgd		subdirectories.
16831.1Scgd
16841.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
16851.21Schristos		These are installed exactly like programs.
16861.21Schristos
16871.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
16881.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
16891.166Srtr
16901.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
16911.21Schristos		different from ${SCRIPTS}. These can be further specialized
16921.21Schristos		by setting SCRIPTSNAME_<script>.
16931.21Schristos
16941.124SlukemFILES		See description of <bsd.files.mk>.
16951.21Schristos
16961.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
16971.106Sthorpej		<bsd.own.mk> for additional information about this variable.
16981.130Slukem
16991.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
17001.1Scgdif it exists, as well as the include file <bsd.man.mk>.
17011.1Scgd
17021.1ScgdSome simple examples:
17031.1Scgd
17041.1ScgdTo build foo from foo.c with a manual page foo.1, use:
17051.1Scgd
17061.1Scgd	PROG=	foo
17071.1Scgd
17081.1Scgd	.include <bsd.prog.mk>
17091.1Scgd
17101.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
17111.1Scgd
17121.9Scgd	MAN=	foo.2
17131.1Scgd
17141.1ScgdIf foo does not have a manual page at all, add the line:
17151.1Scgd
17161.75Sagc	MKMAN=	no
17171.1Scgd
17181.1ScgdIf foo has multiple source files, add the line:
17191.1Scgd
17201.1Scgd	SRCS=	a.c b.c c.c d.c
17211.1Scgd
17221.1Scgd
17231.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
17241.118Slukem
17251.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
17261.118Slukemconstruct source files built by rpcgen.
17271.72Ssommerfe
17281.118SlukemThe following macros may be defined in makefiles which include
17291.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
17301.118Slukemare to be built:
17311.21Schristos
17321.118SlukemRPC_INCS:	construct .h file from .x file
17331.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
17341.118Slukem		(for marshalling/unmarshalling data types)
17351.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
17361.118Slukem		(server-side stubs)
17371.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
17381.21Schristos
17391.118SlukemRPC_XDIR:	Directory containing .x/.h files
17401.23Schristos
17411.23Schristos
17421.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
17431.21Schristos
17441.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
17451.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
17461.134Slukemincluded before <bsd.shlib.mk>.
17471.21Schristos
17481.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
17491.118Slukem(defaults are in brackets):
17501.21Schristos
17511.300SjoergSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
17521.300Sjoerg		instead of ${LIBDIR} as the base path for shared library
17531.300Sjoerg		installation.  [/lib]
17541.300Sjoerg
17551.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
17561.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
17571.118Slukem		for all others.]
17581.81Swiz
17591.300Sjoerg_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
17601.118Slukem		otherwise set to ${LIBDIR}
17611.81Swiz
17621.300SjoergSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
17631.300Sjoerg
17641.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
17651.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
17661.118Slukem		all others.]
17671.39Scgd
17681.13Schristos
17691.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
17701.13Schristos
17711.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
17721.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
17731.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
17741.233Sapbfollowing variables:
17751.233Sapb
17761.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
17771.233Sapb		will be ignored and subdirectories will not be processed.
17781.233Sapb
17791.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
17801.233Sapb		specified directory will be visited and the target made.
17811.233Sapb
17821.233Sapb		As a special case, the use of a token .WAIT as an
17831.233Sapb		entry in SUBDIR acts as a synchronization barrier
17841.233Sapb		when multiple make jobs are run; subdirs before the
17851.233Sapb		.WAIT must complete before any subdirs after .WAIT are
17861.233Sapb		started.  See make(1) for some caveats on use of .WAIT
17871.233Sapb		and other special sources.
17881.47Stv
17891.47Stv
17901.326Schristos=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
17911.326Schristos
17921.326SchristosThe include file <bsd.x11.mk> contains parameters and targets for
17931.326Schristoscross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
17941.326SchristosIt should be included after the general Makefile contents but before
17951.326Schristosthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
17961.326Schristos
17971.326SchristosIt provides the following targets:
17981.326Schristos	.man.1 .man.3 .man.4 .man.5 .man.7:
17991.326Schristos		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
18001.326Schristos		these rules convert from X11's manual page source
18011.326Schristos		into an mdoc.old source file.
18021.326Schristos
18031.326SchristosIt sets the following variables:
18041.326Schristos
18051.326SchristosBINDIR			Set to ${X11BINDIR}.
18061.326Schristos			To override, define after including <bsd.x11.mk>
18071.326Schristos
18081.326SchristosLIBDIR			Set to ${X11USRLIBDIR}.
18091.326Schristos			To override, define after including <bsd.x11.mk>
18101.326Schristos
18111.326SchristosMANDIR			Set to ${X11MANDIR}.
18121.326Schristos			To override, define after including <bsd.x11.mk>
18131.326Schristos
18141.326SchristosCPPFLAGS		Appended with definitions to include from
18151.326Schristos			${DESTDIR}${X11INCDIR}
18161.326Schristos
18171.326SchristosLDFLAGS			Appended with definitions to link from
18181.326Schristos			${DESTDIR}${X11USRLIBDIR}
18191.326Schristos
18201.326SchristosX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
18211.326Schristos
18221.326SchristosX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
18231.326Schristos
18241.326SchristosX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
18251.326Schristos
18261.326SchristosX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
18271.326Schristos
18281.326SchristosX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
18291.326Schristos
18301.326SchristosX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
18311.326Schristos
18321.326SchristosX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
18331.326Schristos
18341.326SchristosX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
18351.326Schristos
18361.326SchristosX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
18371.326Schristos
18381.326SchristosX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
18391.326Schristos
18401.326SchristosIt uses the following variables:
18411.326Schristos
18421.326SchristosAPPDEFS			List of app-default files to install.
18431.326Schristos
18441.326SchristosCPPSCRIPTS		List of files/scripts to run through cpp(1)
18451.326Schristos			and then ${X11TOOL_UNXCOMM}.  The source files
18461.326Schristos			have a `.cpp' suffix, the generated files do not.
18471.326Schristos
18481.326SchristosCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
18491.326Schristos
18501.326SchristosCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
18511.326Schristos
18521.326Schristos
18531.326Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
18541.326Schristos
18551.326SchristosThe following files are described here for completion, but they are not
18561.326Schristossupposed to be included directly from other Makefiles; they are used
18571.326Schristosinternally by other system files.
18581.326Schristos
18591.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
18601.47Stv
18611.326SchristosThe include file <bsd.sys.mk> is used by other system mk files and
18621.326Schristosit is not intended to be included standalone. It contains rules and
18631.326Schristossystem build variables. It requires bsd.own.mk to be included first.
18641.326SchristosIt contains overrides that are used when building the NetBSD source tree.
18651.133Slukem
18661.133SlukemThe following variables control how various files are compiled/built.
18671.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
18681.133Slukem
18691.133SlukemAR		Create, modify, and extract from archives.  [ar]
18701.133Slukem
18711.133SlukemARFLAGS		Options to ${AR}.  [rl]
18721.133Slukem
18731.151SlukemAS		Assembler.  [as]
18741.151Slukem
18751.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
18761.211Slukem		assembly source files.  []
18771.151Slukem
18781.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
18791.217Sjoerg		If this option is present, seed the random number
18801.217Sjoerg		generator based on the value, source file names and
18811.217Sjoerg		the output file name to make builds more deterministic.
18821.217Sjoerg		Additional information is available in the GCC
18831.217Sjoerg		documentation of -frandom-seed.
18841.217Sjoerg
18851.133SlukemCC		C compiler.  [cc]
18861.133Slukem
18871.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
18881.133Slukem
18891.133SlukemCPP		C Pre-Processor.  [cpp]
18901.133Slukem
18911.133SlukemCPPFLAGS	Options to ${CPP}.  []
18921.133Slukem
18931.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
18941.133Slukem
18951.133SlukemCXX		C++ compiler.  [c++]
18961.133Slukem
18971.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
18981.133Slukem
18991.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
19001.133Slukem
19011.133SlukemFC		Fortran compiler.  [f77]
19021.133Slukem
19031.133SlukemFFLAGS		Options to {$FC}.  [-O]
19041.133Slukem
19051.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
19061.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
19071.235Sapb
19081.133SlukemINSTALL		install(1) command.  [install]
19091.133Slukem
19101.133SlukemLEX		Lexical analyzer.  [lex]
19111.133Slukem
19121.133SlukemLFLAGS		Options to ${LEX}.  []
19131.133Slukem
19141.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
19151.145Sjwise
19161.133SlukemLD		Linker.  [ld]
19171.133Slukem
19181.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
19191.133Slukem
19201.133SlukemLINT		C program verifier.  [lint]
19211.133Slukem
19221.330SchristosLINTFLAGS	Options to ${LINT}.  [-chapbxzgFS]
19231.133Slukem
19241.133SlukemLORDER		List dependencies for object files.  [lorder]
19251.133Slukem
19261.133SlukemMAKE		make(1).  [make]
19271.133Slukem
19281.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
19291.133Slukem
19301.321SmrgMKDEPCXX	Construct Makefile dependency list for C++ files.  [mkdep]
19311.321Smrg
19321.133SlukemNM		List symbols from object files.  [nm]
19331.133Slukem
19341.133SlukemPC		Pascal compiler.  [pc]  (Not present)
19351.133Slukem
19361.133SlukemPFLAGS		Options to ${PC}.  []
19371.133Slukem
19381.133SlukemOBJC		Objective C compiler.  [${CC}]
19391.133Slukem
19401.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
19411.133Slukem
19421.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
19431.133Slukem
19441.291SchristosOBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
19451.291Schristos		being built. [${.TARGET} =~ "*.po" ? -X : -x]
19461.291Schristos
19471.168SrizOBJDUMP		Display information from object files.  [objdump]
19481.168Sriz
19491.133SlukemRANLIB		Generate index to archive.  [ranlib]
19501.133Slukem
19511.133SlukemSIZE		List section sizes and total size.  [size]
19521.133Slukem
19531.133SlukemSTRIP		Discard symbols from object files.  [strip]
19541.133Slukem
19551.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
19561.133Slukem
19571.133SlukemYACC		LALR(1) parser generator.  [yacc]
19581.133Slukem
19591.133SlukemYFLAGS		Options to ${YACC}.  []
19601.133Slukem
19611.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
19621.133Slukem		from <file>.y to <file>.h and <file>.c, and add
19631.133Slukem		<foo>.h to CLEANFILES.
19641.133Slukem
19651.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
19661.133Slukem
19671.116Slukem
19681.69SsommerfeOther variables of note (incomplete list):
19691.69Ssommerfe
19701.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
19711.213Slukem		that cause warnings to be fatal, such as:
19721.213Slukem			-Werror -Wa,--fatal-warnings
19731.213Slukem		(The latter being for as(1).)
19741.212Slukem
19751.283SjoergNOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
19761.283Sjoerg		passed to it.
19771.283Sjoerg
19781.296SplunkyWARNS		Crank up compiler warning options; the distinct levels are:
19791.82Slukem			WARNS=1
19801.82Slukem			WARNS=2
19811.82Slukem			WARNS=3
19821.164Smatt			WARNS=4
19831.296Splunky			WARNS=5
19841.336Schristos			WARNS=6
19851.69Ssommerfe
19861.326Schristos=-=-=-=-=   bsd.host.mk  =-=-=-=-=
19871.144Slukem
19881.326SchristosThis file is automatically included from bsd.own.mk. It contains settings
19891.326Schristosfor all the HOST_* variables that are used in host programs and libraries.
19901.144Slukem
19911.326SchristosHOST_AR			The host archive processing command
19921.144Slukem
19931.326SchristosHOST_CC			The host c compiler
19941.144Slukem
19951.326SchristosHOST_CFLAGS		The host c compiler flags
19961.144Slukem
19971.326SchristosHOST_COMPILE.c		The host c compiler line with flags
19981.144Slukem
19991.326SchristosHOST_COMPILE.cc		The host c++ compiler line with flags
20001.144Slukem
20011.326SchristosHOST_CPP		The host c pre-processor
20021.144Slukem
20031.326SchristosHOST_CPPFLAGS		The cost c pre-processor flags
20041.144Slukem
20051.326SchristosHOST_CXX		The host c++ compiler
20061.144Slukem
20071.326SchristosHOST_CXXFLAGS		The host c++ compiler flags
20081.144Slukem
20091.326SchristosHOST_INSTALL_DIR	The host command to install a directory
20101.144Slukem
20111.326SchristosHOST_INSTALL_FILE	The host command to install a file
20121.144Slukem
20131.326SchristosHOST_INSTALL_SYMLINK	The host command to install a symlink
20141.144Slukem
20151.326SchristosHOST_LD			The host linker command
20161.144Slukem
20171.326SchristosHOST_LDFLAGS		The host linker flags
20181.144Slukem
20191.326SchristosHOST_LINK.c		The host c linker line with flags
20201.221Smrg
20211.326SchristosHOST_LINK.cc		The host c++ linker line with flags
20221.144Slukem
20231.326SchristosHOST_LN			The host command to link two files
20241.144Slukem
20251.326SchristosHOST_MKDEP		The host command to create dependencies for c programs
20261.144Slukem
20271.326SchristosHOST_MKDEPCXX		The host command to create dependencies for c++ programs
20281.144Slukem
20291.326SchristosHOST_OSTYPE		The host OSNAME-RELEASE-ARCH tupple
20301.144Slukem
20311.326SchristosHOST_RANLIB		The host command to create random access archives
20321.144Slukem
20331.326SchristosHOST_SH			The host Bourne shell interpreter name (absolute path)
20341.144Slukem
20351.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2036