bsd.README revision 1.257
11.257Stron#	$NetBSD: bsd.README,v 1.257 2009/11/12 13:22:34 tron 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.21Schristosobject, and ".so" denotes a shared (position-independent) object.
601.97Sitojun
611.142SlukemThere are various make variables used during the build.
621.142Slukem
631.142SlukemMany variables support a (case sensitive) value of "no" or "yes",
641.142Slukemand are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
651.142Slukem
661.142Slukem
671.172ShubertfThe basic rule for the variable naming scheme is as follows:
681.172Shubertf
691.231SapbHOST_xxx	A command that runs on the host machine regardless of
701.231Sapb		whether or not the system is being cross compiled, or
711.231Sapb		flags for such a command.
721.231Sapb
731.172ShubertfMKxxx		Can be set to "no" to disable functionality, or
741.172Shubertf		"yes" to enable it.
751.172Shubertf		Usually defaults to "yes", although some variables
761.172Shubertf		default to "no".
771.172Shubertf		Due to make(1) implementation issues, if a temporary
781.224Slukem		command-line override of a mk.conf(5) or <bsd.own.mk>
791.214Swiz		setting is required whilst still honoring a particular
801.172Shubertf		Makefile's setting of MKxxx, use
811.172Shubertf			env MKxxx=value make
821.172Shubertf		instead of
831.172Shubertf			make MKxxx=value
841.172Shubertf
851.172ShubertfNOxxx		If defined, disables a feature.
861.172Shubertf		Not intended for users.
871.172Shubertf		This is to allow Makefiles to disable functionality
881.172Shubertf		that they don't support (such as missing man pages).
891.172Shubertf		NOxxx variables must be defined before <bsd.own.mk>
901.172Shubertf		is included.
911.172Shubertf
921.231SapbTOOL_xxx	A tool that is provided as part of the USETOOLS
931.231Sapb		framework.  When not using the USETOOLS framework,
941.231Sapb		TOOL_xxx variables should refer to tools that are
951.231Sapb		already installed on the host system.
961.231Sapb
971.172ShubertfThe following variables that control how things are made/installed that
981.172Shubertfare not set by default. These should not be set by Makefiles; they're for
991.224Slukemthe user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
1001.224Slukemor on the make(1) command line:
1011.172Shubertf
1021.172ShubertfBUILD 		If defined, 'make install' checks that the targets in the
1031.172Shubertf		source directories are up-to-date and remakes them if they
1041.172Shubertf                are out of date, instead of blindly trying to install
1051.172Shubertf                out of date or non-existent targets.
1061.172Shubertf
1071.172ShubertfMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
1081.172Shubertf		Default: 2
1091.172Shubertf		Supported values:
1101.172Shubertf		    0	Minimal output ("quiet")
1111.172Shubertf		    1	Describe what is occurring
1121.172Shubertf		    2	Describe what is occurring and echo the actual command
1131.241Sapb		    3	Ignore the effect of the "@" prefix in make commands
1141.241Sapb		    4	Trace shell commands using the shell's -x flag
1151.172Shubertf
1161.210SgmcgarryMKATF		If "no", don't build libatf-c, libatf-c++ libraries associated
1171.210Sgmcgarry		with the Automated Testing Framework (ATF).
1181.210Sgmcgarry		Default: yes
1191.210Sgmcgarry
1201.252SskrllMKBFD		Obsolete, use MKBINUTILS
1211.252Sskrll
1221.252SskrllMKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd, libopcodes)
1231.172Shubertf		Default: yes
1241.172Shubertf
1251.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1261.172Shubertf		Default: yes
1271.172Shubertf
1281.234SmrgMKCOMPAT  	If "no", don't build or install the src/compat.
1291.234Smrg		Default: yes on amd64/sparc64, no elsewhere.
1301.234Smrg
1311.210SgmcgarryMKCOMPLEX	If "no", don't build libm support for <complex.h>
1321.210Sgmcgarry		Default: yes
1331.210Sgmcgarry
1341.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1351.174Schristos		and also acts as "MKKERBEROS=no".
1361.172Shubertf		Default: yes
1371.172Shubertf
1381.172ShubertfMKCRYPTO_IDEA	If not "no", IDEA support will be built into libcrypto_idea.a.
1391.172Shubertf		Default: no
1401.172Shubertf
1411.172ShubertfMKCRYPTO_MDC2	If not "no", MDC2 support will be built into libcrypto_mdc2.a
1421.172Shubertf		Default: no
1431.172Shubertf
1441.172ShubertfMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
1451.172Shubertf		Default: no
1461.172Shubertf
1471.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1481.172Shubertf		Default: yes
1491.172Shubertf
1501.184SlukemMKDEBUG		If "no", don't build and install separate debugging symbols
1511.184Slukem		into /usr/libdata/debug.
1521.184Slukem		Default: no
1531.184Slukem
1541.219SlukemMKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
1551.219Slukem		with -DDEBUG.
1561.176Schristos		Default: no
1571.176Schristos
1581.172ShubertfMKDOC		If "no", don't build or install the documentation.
1591.172Shubertf		Default: yes
1601.172Shubertf
1611.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1621.172Shubertf		don't install certain libraries in /lib, and don't
1631.172Shubertf		install the shared linker into /libexec.
1641.172Shubertf		Default: yes
1651.172Shubertf
1661.201SlukemMKGCC		If "no", don't build gcc(1) or any of the GCC-related
1671.186Smrg		libraries (libgcc, libobjc, libstdc++).
1681.172Shubertf		Default: yes
1691.172Shubertf
1701.201SlukemMKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
1711.201Slukem		libraries (libgcc, libobjc, libstdc++).
1721.172Shubertf		Default: yes
1731.172Shubertf
1741.172ShubertfMKGDB		If "no", don't build gdb(1).
1751.172Shubertf		Default: yes
1761.172Shubertf
1771.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
1781.172Shubertf		(libraries and support programs).
1791.172Shubertf		Default: yes
1801.172Shubertf
1811.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
1821.172Shubertf		host, the name, release, and architecture of the host
1831.172Shubertf		operating system will be suffixed to the name of the object
1841.172Shubertf		directory created by "make obj".
1851.172Shubertf		Default: no
1861.172Shubertf
1871.222SlukemMKHTML		If "no", don't build or install the HTML man pages.
1881.222Slukem		Default: yes
1891.172Shubertf
1901.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
1911.172Shubertf		Has no effect on most platforms.
1921.172Shubertf		Default: yes
1931.172Shubertf
1941.225SjoergMKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
1951.225Sjoerg		Default: no
1961.225Sjoerg
1971.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
1981.172Shubertf		(libraries and support programs).
1991.172Shubertf		Default: yes
2001.172Shubertf
2011.172ShubertfMKINFO		If "no", don't build or install Info documentation from
2021.172Shubertf		Texinfo source files.
2031.172Shubertf		Default: yes
2041.172Shubertf
2051.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
2061.172Shubertf		Default: yes
2071.172Shubertf
2081.208SlukemMKISCSI		If "no", don't build or install iSCSI library or applications
2091.181Smrg		(depends on libpthread.)
2101.181Smrg		Default: yes
2111.181Smrg
2121.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
2131.172Shubertf		infrastructure (libraries and support programs).
2141.172Shubertf		Default: yes
2151.172Shubertf
2161.208SlukemMKLDAP		If "no", disables building of LDAP infrastructure
2171.208Slukem		(libraries and support programs).
2181.208Slukem		Default: yes
2191.208Slukem
2201.206SlukemMKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
2211.172Shubertf		Also:
2221.172Shubertf			- don't install the .a libraries
2231.172Shubertf			- don't install _pic.a libraries on PIC systems
2241.172Shubertf			- don't build .a libraries on PIC systems
2251.172Shubertf			- don't install the .so symlink on ELF systems
2261.172Shubertf		I.e, only install the shared library (and the .so.major
2271.172Shubertf		symlink on ELF).
2281.172Shubertf		Default: yes
2291.172Shubertf
2301.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
2311.172Shubertf		Default: yes
2321.172Shubertf
2331.245SagcMKLVM		If "no", don't build or install teh logical volume manager
2341.245Sagc		and device mapper tools and libraries
2351.245Sagc		Default: no
2361.245Sagc
2371.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
2381.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
2391.172Shubertf		Default: yes
2401.172Shubertf
2411.256SjoergMKMANDOC	If "yes", mandoc is built as tool and used to compile
2421.256Sjoerg		catman or html pages.  A directory can be exempted by
2431.256Sjoerg		defining NOMANDOC.  Individual man pages are exempted
2441.256Sjoerg		if USETBL is set or NOMANDOC.${target} is set to "yes".
2451.256Sjoerg		Default: no
2461.256Sjoerg
2471.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2481.172Shubertf		Default: no
2491.172Shubertf
2501.253StsarnaMKMDNS		If "no", disables building of mDNS infrastructure
2511.253Stsarna		(libraries and support programs).
2521.253Stsarna		Default: yes
2531.253Stsarna
2541.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2551.172Shubertf		definition files.
2561.172Shubertf		Default: yes
2571.172Shubertf
2581.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2591.172Shubertf		and also acts as "MKOBJDIRS=no".
2601.172Shubertf		Default: yes
2611.172Shubertf
2621.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
2631.172Shubertf		Default: no
2641.172Shubertf
2651.172ShubertfMKPAM		If "no", disables building of PAM authentication
2661.172Shubertf		infrastructure (libraries and support programs).
2671.182Speter		Default: yes
2681.172Shubertf
2691.210SgmcgarryMKPCC		If "no", don't build pcc(1) or any of the PCC-related
2701.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
2711.210Sgmcgarry		Default: no
2721.210Sgmcgarry
2731.210SgmcgarryMKPCCCMDS	If "no", don't build pcc(1), but do build the PCC-related
2741.210Sgmcgarry		libraries (libpcc, libpccsoftfloat).
2751.210Sgmcgarry		Default: no
2761.210Sgmcgarry
2771.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
2781.172Shubertf		Default: yes
2791.172Shubertf
2801.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
2811.172Shubertf		also acts as "MKPICLIB=no"
2821.172Shubertf		Default: yes (for MACHINE_ARCHs that support it) 
2831.172Shubertf
2841.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2851.172Shubertf		Default: yes
2861.172Shubertf
2871.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2881.172Shubertf		shared object libraries from the .a libraries.
2891.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
2901.172Shubertf		_pic.a library pointing to the .a library.
2911.172Shubertf		Default: yes
2921.172Shubertf
2931.198SchristosMKPIE		If "no", create regular executables. Otherwise create
2941.198Schristos		PIE (Position Independent Executables).
2951.198Schristos		Default: no
2961.198Schristos
2971.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
2981.172Shubertf		Default: yes
2991.172Shubertf
3001.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
3011.172Shubertf		Default: yes
3021.172Shubertf
3031.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
3041.172Shubertf		MKMAN=no MKNLS=no".
3051.172Shubertf		I.e, don't build catman pages, documentation, Info
3061.172Shubertf		documentation, man pages, NLS files, ...
3071.172Shubertf		Default: yes
3081.172Shubertf
3091.172ShubertfMKSKEY		If "no", disables building of S/key authentication
3101.172Shubertf		infrastructure (libraries and support programs).
3111.172Shubertf		Default: yes
3121.172Shubertf
3131.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
3141.172Shubertf		generate output containing library calls for floating
3151.172Shubertf		point and possibly soft-float library support.
3161.172Shubertf		Default: no
3171.172Shubertf
3181.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
3191.172Shubertf		libraries.
3201.172Shubertf		Default: yes
3211.172Shubertf
3221.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
3231.172Shubertf		files or directories, and keep a metadata log of what
3241.172Shubertf		the owner/group/mode should be.  This allows a
3251.172Shubertf		non-root "make install".
3261.172Shubertf		Default: no
3271.172Shubertf
3281.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
3291.172Shubertf		more recently modified in the source directories that their
3301.172Shubertf		installed counterparts.
3311.172Shubertf		Default: no
3321.172Shubertf
3331.237SmrgMKX11		If not "no", depending on the value of ${X11FLAVOUR},
3341.237Smrg		'make build' also descends into either src/x11 (XFree86) or
3351.237Smrg		src/external/mit/xorg (modular Xorg) to cross-build X11 and
3361.237Smrg		automatically enables creation of X sets.
3371.216Smrg		Default: no
3381.216Smrg
3391.251SmrgMKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
3401.251Smrg		install the X fonts.  The xfont set is still created but
3411.251Smrg		will be empty.
3421.251Smrg		Default: yes
3431.251Smrg
3441.172ShubertfMKYP		If "no", disables building of YP (NIS)
3451.172Shubertf		infrastructure (libraries and support programs).
3461.172Shubertf		Default: yes
3471.172Shubertf
3481.254ShaadMKZFS		If "no", do not build and install utilities and libraries 
3491.254Shaad		used to manage ZFS file system. Do not build zfs and solaris 
3501.254Shaad		compatibility kernel modules.
3511.254Shaad		Default: no
3521.254Shaad
3531.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
3541.172Shubertf		various system utilities/libraries that support it.
3551.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
3561.172Shubertf		forced to "no".
3571.172Shubertf
3581.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
3591.172Shubertf		various system utilities/libraries that support it.
3601.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
3611.172Shubertf		forced to "no".
3621.172Shubertf
3631.197SadUSE_JEMALLOC	If "no", disables building the "jemalloc" allocator
3641.197Sad		designed for improved performance with threaded
3651.197Sad		applications.  The "phkmalloc" allocator as used up
3661.197Sad		before NetBSD-5.0 will be substituted.
3671.197Sad
3681.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
3691.172Shubertf		support into various system utilities/libraries that
3701.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
3711.172Shubertf		will also be forced to "no".
3721.172Shubertf
3731.208SlukemUSE_LDAP	If "no", disables building LDAP support into various
3741.208Slukem		system utilities/libraries that support it.
3751.208Slukem		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
3761.208Slukem
3771.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
3781.172Shubertf		into various system utilities/libraries that support it.
3791.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
3801.172Shubertf
3811.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
3821.172Shubertf		support into various system utilities/libraries that
3831.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
3841.172Shubertf		also be forced to "no".
3851.204Slukem		Default: no
3861.172Shubertf
3871.201SlukemUSE_SSP		If "no", disables GCC stack protection code, which
3881.257Stron		detects stack overflows and aborts the program. The
3891.257Stron		stack protecion code imposes a performance penalty
3901.257Stron		of about 5%
3911.257Stron		Default: no, unless "USE_FORT" is set to "yes"
3921.257Stron
3931.257StronUSE_SSP_DEFAULT	The default of "USE_SSP" for part of the tree (e.g. kernels)
3941.257Stron		that are not compiled with "USE_FORT" set to "yes".
3951.257Stron		Default: "yes" for amd64 and i386, "no" otherwise
3961.187Schristos
3971.246SchristosUSE_FORT 	If "yes" turns on substitute wrappers for commonly used
3981.246Schristos		functions that do not do bounds checking regularly, but
3991.246Schristos		they could in some cases by using the gcc
4001.246Schristos		__builtin_object_size() function to determine the buffer 
4011.246Schristos		size where it is known and detect buffer overflows.
4021.246Schristos		These substitute functions are in /usr/include/ssp.
4031.257Stron		Default: depends on the part of the source tree
4041.246Schristos
4051.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
4061.172Shubertf		various system utilities/libraries that support it.
4071.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
4081.172Shubertf
4091.237SmrgX11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
4101.237Smrg		XFree86 or modular Xorg.  Only matters if MKX11!=no.
4111.242Smrg		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
4121.242Smrg		"XFree86" on everything else.
4131.237Smrg
4141.172ShubertfCOPTS.lib<lib>
4151.177SmrgOBJCOPTS.lib<lib>
4161.172ShubertfLDADD.lib<lib>
4171.172ShubertfCPPFLAGS.lib<lib>
4181.172ShubertfCXXFLAGS.lib<lib>
4191.172ShubertfCOPTS.<prog>
4201.177SmrgOBJCCOPTS.<prog>
4211.172ShubertfLDADD.<prog>
4221.172ShubertfCPPFLAGS.<prog>
4231.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
4241.172Shubertf		variables in a way that applies only to a particular library
4251.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
4261.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
4271.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
4281.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
4291.172Shubertf		the crypto library.
4301.118Slukem
4311.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
4321.1Scgd
4331.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
4341.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
4351.1Scgd
4361.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
4371.1Scgd
4381.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
4391.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
4401.17Sthorpeja few global "feature configuration" parameters.
4411.1Scgd
4421.1ScgdIt has no targets.
4431.1Scgd
4441.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
4451.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
4461.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
4471.29Scjsis included.  These files may define any of the variables described below.
4481.17Sthorpej
4491.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
4501.17Sthorpej(defaults are in brackets):
4511.15Scgd
4521.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
4531.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
4541.98Slukem		otherwise BSDSRCDIR will be used as the default.
4551.98Slukem		Various makefiles within the NetBSD source tree will
4561.98Slukem		use this to reference the top level of the source tree.
4571.98Slukem
4581.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
4591.98Slukem		based on the presence of tools/ and build.sh.  This variable
4601.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
4611.98Slukem		determined once and then propagated to all sub-makes.
4621.95Slukem
4631.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
4641.116Slukem		will work correctly.  [/usr/src]
4651.15Scgd
4661.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
4671.116Slukem		will work correctly.  [/usr/obj]
4681.15Scgd
4691.116SlukemBINGRP		Binary group.  [wheel]
4701.15Scgd
4711.116SlukemBINOWN		Binary owner.  [root]
4721.15Scgd
4731.116SlukemBINMODE		Binary mode.  [555]
4741.15Scgd
4751.116SlukemNONBINMODE	Mode for non-executable files.  [444]
4761.15Scgd
4771.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
4781.15Scgd
4791.116SlukemMANGRP		Manual group.  [wheel]
4801.15Scgd
4811.116SlukemMANOWN		Manual owner.  [root]
4821.15Scgd
4831.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
4841.15Scgd
4851.222SlukemMANINSTALL	Manual installation type.  Space separated list:
4861.222Slukem			catinstall, htmlinstall, maninstall
4871.222Slukem		[catinstall maninstall htmlinstall]
4881.76Sfair
4891.76SfairLDSTATIC	Control program linking; if set blank, link everything
4901.129Slukem		dynamically.  If set to "-static", link everything statically.
4911.76Sfair		If not set, programs link according to their makefile.
4921.21Schristos
4931.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
4941.15Scgd
4951.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
4961.15Scgd
4971.116SlukemLIBGRP		Library group.  [${BINGRP}]
4981.15Scgd
4991.116SlukemLIBOWN		Library owner.  [${BINOWN}]
5001.15Scgd
5011.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
5021.15Scgd
5031.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
5041.116Slukem	        installation.  [/usr/share/doc]
5051.62Ssimonb
5061.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
5071.62Ssimonb		[/usr/share/doc/html]
5081.15Scgd
5091.116SlukemDOCGRP		Documentation group.  [wheel]
5101.15Scgd
5111.116SlukemDOCOWN		Documentation owner.  [root]
5121.15Scgd
5131.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
5141.15Scgd
5151.84SkleinkNLSDIR		Base path for Native Language Support files installation.
5161.15Scgd		[/usr/share/nls]
5171.1Scgd
5181.116SlukemNLSGRP		Native Language Support files group.  [wheel]
5191.1Scgd
5201.116SlukemNLSOWN		Native Language Support files owner.  [root]
5211.1Scgd
5221.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
5231.1Scgd
5241.255SapbX11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
5251.255Sapb		if that exists; otherwise /usr/xsrc]
5261.144Slukem
5271.221SmrgX11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
5281.144Slukem
5291.221SmrgX11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
5301.144Slukem
5311.221SmrgX11SRCDIR.lib<package>
5321.221SmrgX11SRCDIR.<package>
5331.221Smrg		The path to the xorg src tree for the specificed package>.
5341.221Smrg		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
5351.221Smrg
5361.221SmrgX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
5371.221Smrg		[/usr/X11R7]
5381.144Slukem
5391.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
5401.144Slukem
5411.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
5421.144Slukem
5431.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
5441.144Slukem
5451.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
5461.144Slukem
5471.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
5481.144Slukem
5491.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
5501.144Slukem
5511.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
5521.1Scgd		to be stripped.  This is to be used when building your
5531.1Scgd		own install script so that the entire system can be made
5541.146Slukem		stripped/not-stripped using a single knob.  []
5551.1Scgd
5561.2ScgdCOPY		The flag passed to the install program to cause the binary
5571.2Scgd		to be copied rather than moved.  This is to be used when
5581.2Scgd		building our own install script so that the entire system
5591.2Scgd		can either be installed with copies, or with moves using
5601.116Slukem		a single knob.  [-c]
5611.15Scgd
5621.150SlukemMAKEDIRTARGET dir target [params]
5631.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
5641.150Slukem		displaying a "pretty" message whilst doing so.
5651.150Slukem
5661.152SclRELEASEMACHINEDIR
5671.152Scl		Subdirectory used below RELEASEDIR when building
5681.152Scl		a release.  [${MACHINE}]
5691.152Scl
5701.152SclRELEASEMACHINE	Subdirectory or path component used for the following
5711.152Scl		paths:
5721.152Scl			distrib/${RELEASEMACHINE}
5731.152Scl			distrib/notes/${RELEASEMACHINE}
5741.152Scl			etc/etc.${RELEASEMACHINE}
5751.152Scl		Used when building a release.  [${MACHINE}]
5761.150Slukem
5771.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
5781.214Swizmake configuration file to modify the behavior of the system build
5791.17Sthorpejprocess (default values are in brackets along with comments, if set by
5801.134Slukem<bsd.own.mk>):
5811.33Sjonathan
5821.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
5831.172Shubertf		be used as part of a build in progress.
5841.172Shubertf		Supported values:
5851.172Shubertf
5861.172Shubertf		yes	Use the tools from TOOLDIR.
5871.172Shubertf			Must be set to this if cross-compiling.
5881.172Shubertf
5891.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
5901.172Shubertf			build native compilation tool components that are
5911.172Shubertf			version-specific for that tool.
5921.172Shubertf
5931.172Shubertf		never	Do not use the tools from TOOLDIR, even when
5941.172Shubertf			building native tool components.  This is similar to
5951.172Shubertf			the traditional NetBSD build method, but does not
5961.172Shubertf			verify that the compilation tools in use are
5971.172Shubertf			up-to-date enough in order to build the tree
5981.172Shubertf			successfully.  This may cause build or runtime
5991.172Shubertf			problems when building the whole NetBSD source tree.
6001.172Shubertf
6011.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
6021.172Shubertf		source tree (detected automatically); "no" otherwise
6031.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
6041.172Shubertf		make(1) include files).
6051.142Slukem
6061.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
6071.199Ssimonb		use ELF -- currently all architectures].
6081.33Sjonathan
6091.103SthorpejTOOLCHAIN_MISSING
6101.142Slukem		If not "no", this indicates that the platform being built
6111.103Sthorpej		does not have a working in-tree toolchain.  If the
6121.142Slukem		${MACHINE_ARCH} in question falls into this category,
6131.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
6141.103Sthorpej		Otherwise, the variable is unconditionally assigned the
6151.103Sthorpej		value "no".
6161.252Sskrll		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
6171.142Slukem		unconditionally assigned the value "no".
6181.103Sthorpej
6191.103SthorpejEXTERNAL_TOOLCHAIN
6201.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
6211.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
6221.103Sthorpej		access to this variable.  The variable should be defined
6231.103Sthorpej		either in the user's environment or in the user's mk.conf
6241.103Sthorpej		file.  If defined, this variable indicates the root of
6251.103Sthorpej		an external toolchain which will be used to build the
6261.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
6271.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
6281.103Sthorpej		cross-compile framework.
6291.103Sthorpej
6301.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
6311.142Slukem		assigned the value "no", since the external version of the
6321.142Slukem		compiler may not be able to build the library components of
6331.142Slukem		the in-tree compiler.
6341.103Sthorpej
6351.103Sthorpej		NOTE: This variable is not yet used in as many places as
6361.103Sthorpej		it should be.  Expect the exact semantics of this variable
6371.103Sthorpej		to change in the short term as parts of the cross-compile
6381.103Sthorpej		framework continue to be cleaned up.
6391.1Scgd
6401.236SapbThe following variables are defined to commands to perform the
6411.236Sapbappropriate operation, with the default in [brackets].  Note that
6421.236Sapbthe defaults change if USETOOLS == "yes":
6431.236Sapb
6441.236SapbTOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
6451.236Sapb
6461.236SapbTOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
6471.236Sapb
6481.236SapbTOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
6491.236Sapb
6501.236SapbTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
6511.236Sapb
6521.236SapbTOOL_ATF_COMPILE	Generate POSIX shell test programs.  [atf-compile]
6531.236Sapb
6541.236SapbTOOL_AWK		Pattern-directed scanning/processing language.  [awk]
6551.236Sapb
6561.236SapbTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
6571.236Sapb
6581.236SapbTOOL_CAT		Concatenate and print files.  [cat]
6591.236Sapb
6601.236SapbTOOL_CKSUM		Display file checksums.  [cksum]
6611.236Sapb
6621.236SapbTOOL_COMPILE_ET		Error table compiler.  [compile_et]
6631.236Sapb
6641.236SapbTOOL_CONFIG		Build kernel compilation directories.  [config]
6651.236Sapb
6661.236SapbTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
6671.236Sapb
6681.236SapbTOOL_CTAGS		Create a tags file.  [ctags]
6691.236Sapb
6701.236SapbTOOL_DB			Manipulate db(3) databases.  [db]
6711.236Sapb
6721.236SapbTOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
6731.236Sapb
6741.236SapbTOOL_EQN		Format equations for groff.  [eqn]
6751.236Sapb
6761.236SapbTOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
6771.236Sapb
6781.236SapbTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
6791.236Sapb
6801.236SapbTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
6811.236Sapb
6821.236SapbTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
6831.236Sapb
6841.236SapbTOOL_GMAKE		GNU make utility.  [gmake]
6851.236Sapb
6861.247SsketchTOOL_GREP		Print lines matching a pattern.  [grep]
6871.247Ssketch
6881.236SapbTOOL_GROFF		Front end for groff document formatting system.  [groff]
6891.236Sapb
6901.236SapbTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
6911.236Sapb
6921.236SapbTOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
6931.236Sapb
6941.236SapbTOOL_HP700MKBOOT	Make bootable image for hp700.  [hp700-mkboot]
6951.236Sapb
6961.236SapbTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
6971.236Sapb
6981.236SapbTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
6991.236Sapb
7001.236SapbTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
7011.236Sapb
7021.236SapbTOOL_JOIN		Relational database operator.  [join]
7031.236Sapb
7041.236SapbTOOL_M4			M4 macro language processor.  [m4]
7051.236Sapb
7061.236SapbTOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
7071.236Sapb
7081.236SapbTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
7091.236Sapb
7101.236SapbTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
7111.236Sapb
7121.236SapbTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
7131.236Sapb
7141.236SapbTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
7151.236Sapb
7161.236SapbTOOL_MENUC		Menu compiler.  [menuc]
7171.236Sapb
7181.236SapbTOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
7191.236Sapb			[mips-elf2ecoff]
7201.236Sapb
7211.236SapbTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
7221.236Sapb
7231.236SapbTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
7241.236Sapb
7251.236SapbTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
7261.236Sapb
7271.236SapbTOOL_MKMAGIC		Create database for file(1).  [file]
7281.236Sapb
7291.236SapbTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
7301.236Sapb
7311.236SapbTOOL_MSGC		Simple message list compiler.  [msgc]
7321.236Sapb
7331.236SapbTOOL_MTREE		Map a directory hierarchy.  [mtree]
7341.236Sapb
7351.236SapbTOOL_PAX		Manipulate file archives and copy directories.  [pax]
7361.236Sapb
7371.236SapbTOOL_PIC		Compile pictures for groff.  [pic]
7381.236Sapb
7391.236SapbTOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
7401.236Sapb
7411.236SapbTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
7421.236Sapb
7431.236SapbTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
7441.236Sapb
7451.236SapbTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
7461.236Sapb
7471.236SapbTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
7481.236Sapb
7491.236SapbTOOL_ROFF_HTML		Generate HTML groff output.
7501.236Sapb			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
7511.236Sapb
7521.236SapbTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
7531.236Sapb
7541.236SapbTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
7551.236Sapb
7561.236SapbTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
7571.236Sapb
7581.236SapbTOOL_SED		Stream editor.  [sed]
7591.236Sapb
7601.236SapbTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
7611.236Sapb
7621.236SapbTOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
7631.236Sapb			[sparkcrc]
7641.236Sapb
7651.236SapbTOOL_STAT		Display file status.  [stat]
7661.236Sapb
7671.236SapbTOOL_STRFILE		Create a random access file for storing strings.
7681.236Sapb			[strfile]
7691.236Sapb
7701.236SapbTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
7711.236Sapb
7721.236SapbTOOL_TBL		Format tables for groff.  [tbl]
7731.236Sapb
7741.236SapbTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
7751.236Sapb
7761.236SapbTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
7771.236Sapb
7781.236SapbTOOL_ZIC		Time zone compiler.  [zic]
7791.236Sapb
7801.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
7811.1Scgdthey use the same default owners etc. as the rest of the tree.
7821.131Slukem
7831.131Slukem
7841.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
7851.131Slukem
7861.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
7871.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
7881.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
7891.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
7901.133Slukemdependencies for the .d files.  In order for this to function correctly,
7911.132Slukemit should be .included after all other .mk files and directives that may
7921.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
7931.132Slukem
7941.132SlukemSRCS		List of source files to build the program.
7951.132Slukem
7961.132SlukemDPSRCS		List of source files which are needed for generating
7971.132Slukem		dependencies, but are not needed in ${SRCS}.
7981.1Scgd
7991.1Scgd
8001.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
8011.106Sthorpej
8021.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
8031.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
8041.124Slukem
8051.124SlukemFILES		The list of files to install.
8061.124Slukem
8071.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
8081.153Slukem		are installed by the `configinstall' target,
8091.153Slukem		not the `install' target.
8101.153Slukem		The FILES* variables documented below also apply.
8111.153Slukem
8121.124SlukemFILESOWN	File owner.  [${BINOWN}]
8131.124Slukem
8141.124SlukemFILESGRP	File group.  [${BINGRP}]
8151.124Slukem
8161.203SdhollandFILESMODE	File mode.  [${NONBINMODE}]
8171.124Slukem
8181.124SlukemFILESDIR	The location to install the files.
8191.124Slukem
8201.124SlukemFILESNAME	Optional name to install each file as.
8211.124Slukem
8221.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
8231.153Slukem
8241.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
8251.153Slukem
8261.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
8271.153Slukem
8281.202SuweFILESDIR_<fn>	The location to install the specific file <fn>.
8291.153Slukem
8301.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
8311.124Slukem
8321.243ScubeFILESBUILD_<fn>	A value different from "no" will add the file to the list of
8331.243Scube		targets to be built by `realall'.  Users of that variable
8341.243Scube		should provide a target to build the file.
8351.243Scube
8361.135Slukem
8371.139SlukemBUILDSYMLINKS	List of two word items:
8381.135Slukem			lnsrc lntgt
8391.135Slukem		For each lnsrc item, create a symlink named lntgt.
8401.135Slukem		The lntgt symlinks are removed by the cleandir target.
8411.106Sthorpej
8421.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
8431.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
8441.148Sjmc		The source files have a `.uue' suffix, the generated files do 
8451.148Sjmc		not.
8461.149Sjmc
8471.202SuweUUDECODE_FILES_RENAME_<fn>
8481.202Suwe		Rename the output from the decode to the provided name.
8491.148Sjmc		
8501.148Sjmc		*NOTE: These files are simply decoded, with no install or other
8511.148Sjmc		       rule applying implicitly except being added to the clean
8521.148Sjmc		       target.
8531.106Sthorpej
8541.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
8551.113Sthorpej
8561.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
8571.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
8581.134Slukembefore <bsd.gcc.mk>.
8591.113Sthorpej
8601.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
8611.113Sthorpejof which need to know where to find certain GCC support libraries.
8621.113Sthorpej
8631.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
8641.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
8651.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
8661.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
8671.113Sthorpej
8681.134Slukem<bsd.gcc.mk> sets the following variables:
8691.113Sthorpej
8701.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
8711.118Slukem
8721.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
8731.118Slukem
8741.118Slukem_GCC_CRTEND	The full path name to crtend.o.
8751.118Slukem
8761.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
8771.118Slukem
8781.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
8791.118Slukem
8801.118Slukem
8811.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
8821.118Slukem
8831.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
8841.118Slukemvariables:
8851.118Slukem
8861.124SlukemINCS		The list of include files.
8871.118Slukem
8881.118SlukemINCSDIR		The location to install the include files.
8891.118Slukem
8901.118SlukemINCSNAME	Target name of the include file, if only one; same as
8911.118Slukem		FILESNAME, but for include files.
8921.118Slukem
8931.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
8941.134Slukem		are installed in the 'includes' target and not the
8951.134Slukem		(much later) 'install' target.
8961.134Slukem
8971.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
8981.118Slukem		same as FILESNAME_<file>, but for include files.
8991.118Slukem
9001.118Slukem
9011.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
9021.118Slukem
9031.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
9041.118Slukemdocumentation from respective Texinfo source files.  It defines three
9051.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
9061.118Slukemfollowing variables:
9071.118Slukem
9081.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
9091.118Slukem		consist of single files with the extension replaced by
9101.118Slukem		.info.
9111.118Slukem
9121.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
9131.118Slukem
9141.118Slukem
9151.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
9161.118Slukem
9171.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
9181.118Slukemlocation of kernel sources and object directories.
9191.118Slukem
9201.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
9211.124Slukem		[${_SRC_TOP_}/sys]
9221.118Slukem
9231.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
9241.124Slukem		[arch/${MACHINE}]
9251.120Slukem
9261.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
9271.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
9281.118Slukem
9291.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
9301.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
9311.118Slukem		The default value is
9321.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
9331.118Slukem		if it exists or the target 'obj' is being made.
9341.118Slukem		Otherwise the default is
9351.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
9361.118Slukem
9371.118SlukemIt is important that Makefiles (such as those under src/distrib) that
9381.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
9391.118Slukemrather than make assumptions about the location of the compiled kernel.
9401.118Slukem
9411.118Slukem
9421.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
9431.118Slukem
9441.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
9451.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
9461.118Slukeminclude file installation.  It is intended to be included alone, by
9471.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
9481.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
9491.134Slukemin that file up to date.
9501.118Slukem
9511.118Slukem
9521.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
9531.118Slukem
9541.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
9551.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
9561.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
9571.118Slukemwhich checks for installed shared object libraries whose version is greater
9581.118Slukemthat the version of the source. It has a limited number of suffixes,
9591.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
9601.118Slukem<bsd.shlib.mk> to get shared library parameters.
9611.118Slukem
9621.118SlukemIt sets/uses the following variables:
9631.118Slukem
9641.118SlukemLIB		The name of the library to build.
9651.118Slukem
9661.118SlukemLIBDIR		Target directory for libraries.
9671.118Slukem
9681.248SperryMKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
9691.248Sperry		permissions in files inside its archives to those of
9701.248Sperry		the file it was fed. This leads to non-reproduceable
9711.248Sperry		builds. If MKARZERO is set to "yes" (default is "no")
9721.248Sperry		then the "D" flag is passed to ar, causing the
9731.248Sperry		timestamp, uid and gid to be zeroed and the file
9741.248Sperry		permissions to be set to 644. This allows .a files
9751.248Sperry		from different builds to be bit identical.
9761.248Sperry
9771.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
9781.142Slukem		is not "no".
9791.118Slukem
9801.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
9811.118Slukem		as the path to install shared libraries to.
9821.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
9831.130Slukem		Default: no
9841.118Slukem
9851.218SlukemLIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
9861.218Slukem		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
9871.218Slukem		MKPROFILE=no MKSTATICLIB=no".
9881.218Slukem		Default: no
9891.218Slukem
9901.211SlukemLIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
9911.211Slukem		MKPROFILE=no", and don't install the (.a) library.
9921.154Slukem		This is useful for "build only" helper libraries.
9931.154Slukem		Default: no
9941.154Slukem
9951.244SmrgLIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
9961.244Smrg		shared libraries.
9971.244Smrg		This is useful for C++ libraries.
9981.244Smrg		Default: no
9991.244Smrg
10001.118SlukemLINTLIBDIR	Target directory for lint libraries.
10011.118Slukem
10021.118SlukemLIBGRP		Library group.
10031.118Slukem
10041.118SlukemLIBOWN		Library owner.
10051.118Slukem
10061.118SlukemLIBMODE		Library mode.
10071.118Slukem
10081.118SlukemLDADD		Additional loader objects.
10091.118Slukem
10101.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
10111.118Slukem
10121.118SlukemNOCHECKVER_<library>
10131.118SlukemNOCHECKVER	If set, disables checking for installed shared object
10141.118Slukem		libraries with versions greater than the source.  A
10151.118Slukem		particular library name, without the "lib" prefix, may
10161.118Slukem		be appended to the variable name to disable the check for
10171.118Slukem		only that library.
10181.118Slukem
10191.118SlukemSRCS		List of source files to build the library.  Suffix types
10201.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
10211.118Slukem		to .c files of the same name.  (This is not the default for
10221.118Slukem		versions of make.)
10231.118Slukem
10241.157SlukemLIBDPLIBS	A list of the tuples:
10251.157Slukem			libname  path-to-srcdir-of-libname
10261.157Slukem
10271.157Slukem		For each tuple;
10281.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
10291.157Slukem			`libname', and if it is not set it is determined
10301.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
10311.157Slukem			latter is to allow for build time optimization).
10321.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
10331.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
10341.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
10351.157Slukem
10361.157Slukem		This variable may be used for individual libraries, as
10371.157Slukem		well as in parent directories to cache common libraries 
10381.157Slukem		as a build-time optimization.
10391.157Slukem
10401.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
10411.118Slukemif it exists, as well as the include file <bsd.man.mk>.
10421.118Slukem
10431.118SlukemIt has rules for building profiled objects; profiled libraries are
10441.118Slukembuilt by default.
10451.118Slukem
10461.118SlukemLibraries are ranlib'd when made.
10471.118Slukem
10481.118Slukem
10491.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
10501.118Slukem
10511.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
10521.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
10531.134Slukem
10541.249SapbLINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
10551.249Sapbis used. The defaults may be modified by other bsd.*.mk files which
10561.249Sapbinclude bsd.links.mk.  In the future, these variables may be replaced
10571.249Sapbby a method for explicitly recording hard links in a metadata log.
10581.249Sapb
10591.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
10601.134Slukem			source-file target-file
10611.134Slukem		${DESTDIR} is prepended to both paths before linking.
10621.134Slukem		For example, to link /bin/test and /bin/[, use:
10631.134Slukem			LINKS=/bin/test /bin/[
10641.134Slukem
10651.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
10661.153Slukem		are installed by the `configinstall' target,
10671.153Slukem		not the `install' target.
10681.153Slukem
10691.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
10701.134Slukem			source-file target-file
10711.134Slukem		${DESTDIR} is only prepended to target-file before linking.
10721.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
10731.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
10741.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
10751.118Slukem
10761.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
10771.153Slukem		are installed by the `configinstall' target,
10781.153Slukem		not the `install' target.
10791.153Slukem
10801.249SapbLINKSOWN	Link owner.  [${BINOWN}]
10811.249Sapb
10821.249SapbLINKSGRP	Link group.  [${BINGRP}]
10831.249Sapb
10841.249SapbLINKSMODE	Link mode.  [${NONBINMODE}]
10851.249Sapb
10861.249SapbLINKSOWN_<fn>	Link owner of the specific file <fn>.
10871.249Sapb
10881.249SapbLINKSGRP_<fn>	Link group of the specific file <fn>.
10891.249Sapb
10901.249SapbLINKSMODE_<fn>	Link mode of the specific file <fn>.
10911.249Sapb
10921.118Slukem
10931.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
10941.118Slukem
10951.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
10961.118Slukemlinks.
10971.118Slukem
10981.222SlukemIt has a three targets:
10991.118Slukem
11001.222Slukem	catinstall:
11011.222Slukem		Install the preformatted manual pages and their links.
11021.222Slukem	htmlinstall:
11031.222Slukem		Install the HTML manual pages and their links.
11041.118Slukem	maninstall:
11051.118Slukem		Install the manual page sources and their links.
11061.118Slukem
11071.118SlukemIt sets/uses the following variables:
11081.118Slukem
11091.118SlukemMANDIR		Base path for manual installation.
11101.118Slukem
11111.118SlukemMANGRP		Manual group.
11121.118Slukem
11131.118SlukemMANOWN		Manual owner.
11141.118Slukem
11151.118SlukemMANMODE		Manual mode.
11161.118Slukem
11171.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
11181.118Slukem		or "/tahoe" for machine specific manual pages.
11191.118Slukem
11201.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
11211.118Slukem
11221.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
11231.118Slukem		linked-to file must come first, the linked file second,
11241.118Slukem		and there may be multiple pairs.  The files are soft-linked.
11251.118Slukem
11261.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
11271.118Slukemit exists.
11281.118Slukem
11291.118Slukem
11301.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
11311.118Slukem
11321.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
11331.118Slukemand use of separated object and source directories.
11341.118Slukem
11351.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
11361.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
11371.118Slukemit exists.  Otherwise make(1) looks for the existence of a
11381.118Slukemsubdirectory (or a symlink to a directory) of the source directory
11391.118Slukeminto which built targets should be placed.  If an environment variable
11401.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
11411.118Slukemobject directory; failing that, make first looks for a subdirectory
11421.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
11431.118Slukem
11441.118SlukemObject directories are not created automatically by make(1) if they
11451.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
11461.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
11471.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
11481.118Slukemand this is determined by a simple string prefix comparison -- object
11491.118Slukemdirectories are created in a separate object directory tree, and a
11501.118Slukemsymlink to the object directory in that tree is created in the source
11511.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
11521.118Slukemsource tree and that it's not safe to use a separate object tree.
11531.118Slukem
11541.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
11551.118Slukemdirectories and links get created during a "make obj":
11561.118Slukem
11571.118SlukemMAKEOBJDIR	If set, this is the component name of the object
11581.118Slukem		directory.
11591.118Slukem
11601.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
11611.118Slukem		object directories or links named "obj.${MACHINE}";
11621.118Slukem		otherwise, just creates ones named "obj".
11631.118Slukem
11641.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
11651.118Slukem		${BSDSRCDIR}, create object directory in the
11661.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
11671.118Slukem		otherwise, create it in the corresponding subdirectory
11681.118Slukem		of ${BSDOBJDIR}
11691.113Sthorpej
11701.118SlukemBUILDID		If set, the contents of this variable are appended
11711.118Slukem		to the object directory name.  If OBJMACHINE is also
11721.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
11731.113Sthorpej
11741.106Sthorpej
11751.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
11761.106Sthorpej
11771.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
11781.1Scgdmore source files, along with their manual pages.  It has a limited number
11791.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
11801.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
11811.1Scgd
11821.16SjtcIt has eight targets:
11831.1Scgd
11841.1Scgd	all:
11851.102Sthorpej		build the program and its manual page.  This also
11861.102Sthorpej		creates a GDB initialization file (.gdbinit) in
11871.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
11881.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
11891.1Scgd	clean:
11901.1Scgd		remove the program, any object files and the files a.out,
11911.24Smikel		Errs, errs, mklog, and ${PROG}.core.
11921.1Scgd	cleandir:
11931.1Scgd		remove all of the files removed by the target clean, as
11941.1Scgd		well as .depend, tags, and any manual pages.
11951.42Slukem		`distclean' is a synonym for `cleandir'.
11961.1Scgd	depend:
11971.1Scgd		make the dependencies for the source files, and store
11981.1Scgd		them in the file .depend.
11991.16Sjtc	includes:
12001.16Sjtc		install any header files.
12011.1Scgd	install:
12021.1Scgd		install the program and its manual pages; if the Makefile
12031.1Scgd		does not itself define the target install, the targets
12041.1Scgd		beforeinstall and afterinstall may also be used to cause
12051.1Scgd		actions immediately before and after the install target
12061.1Scgd		is executed.
12071.1Scgd	lint:
12081.1Scgd		run lint on the source files
12091.1Scgd	tags:
12101.1Scgd		create a tags file for the source files.
12111.1Scgd
12121.1ScgdIt sets/uses the following variables:
12131.1Scgd
12141.1ScgdBINGRP		Binary group.
12151.1Scgd
12161.1ScgdBINOWN		Binary owner.
12171.1Scgd
12181.1ScgdBINMODE		Binary mode.
12191.1Scgd
12201.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
12211.1Scgd
12221.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
12231.112Sthorpej
12241.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
12251.125Slukem		C objects for <fn>.
12261.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
12271.125Slukem
12281.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
12291.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
12301.35Slukem
12311.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
12321.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
12331.125Slukem
12341.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
12351.125Slukem
12361.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
12371.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
12381.102Sthorpej
12391.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
12401.102Sthorpej		directives in the .gdbinit file that is created in the
12411.102Sthorpej		objdir.
12421.1Scgd
12431.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
12441.1Scgd		For example, to load with the compatibility and utility
12451.1Scgd		libraries, use:
12461.1Scgd
12471.5Sjtc			LDADD+=-lutil -lcompat
12481.1Scgd
12491.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
12501.1Scgd
12511.134SlukemLINKS		See <bsd.links.mk>
12521.134Slukem
12531.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
12541.177Smrg
12551.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
12561.177Smrg		ObjC objects for <fn>.
12571.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
12581.177Smrg
12591.134SlukemSYMLINKS	See <bsd.links.mk>
12601.1Scgd
12611.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
12621.8Scgd		defined, "MAN=${PROG}.1" is assumed.
12631.1Scgd
12641.214SwizPAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
12651.212Slukem		time, with the value of this variable as args to paxctl(1).
12661.193Sperry
12671.193SperryPAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
12681.193Sperry
12691.1ScgdPROG		The name of the program to build.  If not supplied, nothing
12701.1Scgd		is built.
12711.1Scgd
12721.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
12731.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
12741.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
12751.88Sthorpej		the value of PROG if PROG is also set.
12761.87Sthorpej
12771.21SchristosPROGNAME	The name that the above program will be installed as, if
12781.21Schristos		different from ${PROG}.
12791.21Schristos
12801.37StvSRCS		List of source files to build the program.  If SRCS is not
12811.1Scgd		defined, it's assumed to be ${PROG}.c.
12821.108Sjwise
12831.108SjwiseDPSRCS		List of source files which are needed for generating
12841.108Sjwise		dependencies, but are not needed in ${SRCS}.
12851.1Scgd
12861.1ScgdDPADD		Additional dependencies for the program.  Usually used for
12871.1Scgd		libraries.  For example, to depend on the compatibility and
12881.1Scgd		utility libraries use:
12891.1Scgd
12901.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
12911.1Scgd
12921.1Scgd		The following libraries are predefined for DPADD:
12931.1Scgd
12941.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
12951.196Sjoerg		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
12961.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
12971.180Sgdamore		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
12981.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
12991.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
13001.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
13011.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
13021.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
13031.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
13041.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
13051.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
13061.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
13071.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
13081.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
13091.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
13101.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
13111.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
13121.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
13131.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
13141.227Sjoerg		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
13151.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
13161.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
13171.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
13181.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
13191.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
13201.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
13211.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
13221.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
13231.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
13241.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
13251.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
13261.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
13271.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
13281.208Slukem		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
13291.208Slukem		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
13301.209Slukem		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
13311.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
13321.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
13331.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
13341.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
13351.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
13361.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
13371.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
13381.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
13391.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
13401.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
13411.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
13421.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
13431.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
13441.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
13451.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
13461.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
13471.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
13481.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
13491.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
13501.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
13511.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
13521.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
13531.187Schristos		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
13541.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
13551.186Smrg		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
13561.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
13571.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
13581.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
13591.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
13601.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
13611.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
13621.1Scgd
13631.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
13641.12Schristos		strings, using xstr(1). Note that this will not work with
13651.12Schristos		parallel makes.
13661.1Scgd
13671.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
13681.1Scgd		to be stripped.
13691.1Scgd
13701.1ScgdSUBDIR		A list of subdirectories that should be built as well.
13711.1Scgd		Each of the targets will execute the same target in the
13721.1Scgd		subdirectories.
13731.1Scgd
13741.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
13751.21Schristos		These are installed exactly like programs.
13761.21Schristos
13771.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
13781.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
13791.166Srtr
13801.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
13811.21Schristos		different from ${SCRIPTS}. These can be further specialized
13821.21Schristos		by setting SCRIPTSNAME_<script>.
13831.21Schristos
13841.124SlukemFILES		See description of <bsd.files.mk>.
13851.21Schristos
13861.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
13871.106Sthorpej		<bsd.own.mk> for additional information about this variable.
13881.130Slukem
13891.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
13901.1Scgdif it exists, as well as the include file <bsd.man.mk>.
13911.1Scgd
13921.1ScgdSome simple examples:
13931.1Scgd
13941.1ScgdTo build foo from foo.c with a manual page foo.1, use:
13951.1Scgd
13961.1Scgd	PROG=	foo
13971.1Scgd
13981.1Scgd	.include <bsd.prog.mk>
13991.1Scgd
14001.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
14011.1Scgd
14021.9Scgd	MAN=	foo.2
14031.1Scgd
14041.1ScgdIf foo does not have a manual page at all, add the line:
14051.1Scgd
14061.75Sagc	MKMAN=	no
14071.1Scgd
14081.1ScgdIf foo has multiple source files, add the line:
14091.1Scgd
14101.1Scgd	SRCS=	a.c b.c c.c d.c
14111.1Scgd
14121.1Scgd
14131.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
14141.118Slukem
14151.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
14161.118Slukemconstruct source files built by rpcgen.
14171.72Ssommerfe
14181.118SlukemThe following macros may be defined in makefiles which include
14191.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
14201.118Slukemare to be built:
14211.21Schristos
14221.118SlukemRPC_INCS:	construct .h file from .x file
14231.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
14241.118Slukem		(for marshalling/unmarshalling data types)
14251.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
14261.118Slukem		(server-side stubs)
14271.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
14281.21Schristos
14291.118SlukemRPC_XDIR:	Directory containing .x/.h files
14301.23Schristos
14311.23Schristos
14321.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
14331.21Schristos
14341.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
14351.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
14361.134Slukemincluded before <bsd.shlib.mk>.
14371.21Schristos
14381.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
14391.118Slukem(defaults are in brackets):
14401.21Schristos
14411.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
14421.142Slukem		instead of ${LIBDIR} as the base path for shared library
14431.142Slukem		installation.  [/lib]
14441.21Schristos
14451.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
14461.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
14471.118Slukem		for all others.]
14481.81Swiz
14491.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
14501.118Slukem		otherwise set to ${LIBDIR}
14511.81Swiz
14521.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
14531.39Scgd
14541.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
14551.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
14561.118Slukem		all others.]
14571.39Scgd
14581.13Schristos
14591.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
14601.13Schristos
14611.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
14621.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
14631.233Sapbclean, cleandir, depend, includes, install, lint, and tags.  It uses the
14641.233Sapbfollowing variables:
14651.233Sapb
14661.233SapbNOSUBDIR	If this variable is defined, then the SUBDIR variable
14671.233Sapb		will be ignored and subdirectories will not be processed.
14681.233Sapb
14691.233SapbSUBDIR		For all of the directories listed in ${SUBDIR}, the
14701.233Sapb		specified directory will be visited and the target made.
14711.233Sapb		There is also a default target which allows the command
14721.233Sapb		"make subdir" where subdir is any directory listed in
14731.233Sapb		${SUBDIR}.
14741.233Sapb
14751.233Sapb		As a special case, the use of a token .WAIT as an
14761.233Sapb		entry in SUBDIR acts as a synchronization barrier
14771.233Sapb		when multiple make jobs are run; subdirs before the
14781.233Sapb		.WAIT must complete before any subdirs after .WAIT are
14791.233Sapb		started.  See make(1) for some caveats on use of .WAIT
14801.233Sapb		and other special sources.
14811.47Stv
14821.47Stv
14831.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
14841.47Stv
14851.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
14861.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
14871.133Slukemthe NetBSD source tree.
14881.133Slukem
14891.133SlukemThe following variables control how various files are compiled/built.
14901.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
14911.133Slukem
14921.133SlukemAR		Create, modify, and extract from archives.  [ar]
14931.133Slukem
14941.133SlukemARFLAGS		Options to ${AR}.  [rl]
14951.133Slukem
14961.151SlukemAS		Assembler.  [as]
14971.151Slukem
14981.211SlukemAFLAGS		Options to ${CC} when compiling or linking .s or .S
14991.211Slukem		assembly source files.  []
15001.151Slukem
15011.217SjoergBUILDSEED	GCC uses random numbers when compiling C++ code.
15021.217Sjoerg		If this option is present, seed the random number
15031.217Sjoerg		generator based on the value, source file names and
15041.217Sjoerg		the output file name to make builds more deterministic.
15051.217Sjoerg		Additional information is available in the GCC
15061.217Sjoerg		documentation of -frandom-seed.
15071.217Sjoerg
15081.133SlukemCC		C compiler.  [cc]
15091.133Slukem
15101.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
15111.133Slukem
15121.133SlukemCPP		C Pre-Processor.  [cpp]
15131.133Slukem
15141.133SlukemCPPFLAGS	Options to ${CPP}.  []
15151.133Slukem
15161.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
15171.133Slukem
15181.133SlukemCXX		C++ compiler.  [c++]
15191.133Slukem
15201.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
15211.133Slukem
15221.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
15231.133Slukem
15241.133SlukemFC		Fortran compiler.  [f77]
15251.133Slukem
15261.133SlukemFFLAGS		Options to {$FC}.  [-O]
15271.133Slukem
15281.235SapbHOST_SH		Shell.	This must be an absolute path, because it may be
15291.235Sapb		substituted into "#!" lines in scripts.	 [/bin/sh]
15301.235Sapb
15311.133SlukemINSTALL		install(1) command.  [install]
15321.133Slukem
15331.133SlukemLEX		Lexical analyzer.  [lex]
15341.133Slukem
15351.133SlukemLFLAGS		Options to ${LEX}.  []
15361.133Slukem
15371.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
15381.145Sjwise
15391.133SlukemLD		Linker.  [ld]
15401.133Slukem
15411.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
15421.133Slukem
15431.133SlukemLINT		C program verifier.  [lint]
15441.133Slukem
15451.173SperryLINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
15461.133Slukem
15471.133SlukemLORDER		List dependencies for object files.  [lorder]
15481.133Slukem
15491.133SlukemMAKE		make(1).  [make]
15501.133Slukem
15511.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
15521.133Slukem
15531.133SlukemNM		List symbols from object files.  [nm]
15541.133Slukem
15551.133SlukemPC		Pascal compiler.  [pc]  (Not present)
15561.133Slukem
15571.133SlukemPFLAGS		Options to ${PC}.  []
15581.133Slukem
15591.133SlukemOBJC		Objective C compiler.  [${CC}]
15601.133Slukem
15611.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
15621.133Slukem
15631.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
15641.133Slukem
15651.168SrizOBJDUMP		Display information from object files.  [objdump]
15661.168Sriz
15671.133SlukemRANLIB		Generate index to archive.  [ranlib]
15681.133Slukem
15691.133SlukemSIZE		List section sizes and total size.  [size]
15701.133Slukem
15711.133SlukemSTRIP		Discard symbols from object files.  [strip]
15721.133Slukem
15731.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
15741.133Slukem
15751.133SlukemYACC		LALR(1) parser generator.  [yacc]
15761.133Slukem
15771.133SlukemYFLAGS		Options to ${YACC}.  []
15781.133Slukem
15791.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
15801.133Slukem		from <file>.y to <file>.h and <file>.c, and add
15811.133Slukem		<foo>.h to CLEANFILES.
15821.133Slukem
15831.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
15841.133Slukem
15851.116Slukem
15861.69SsommerfeOther variables of note (incomplete list):
15871.69Ssommerfe
15881.213SlukemNOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
15891.213Slukem		that cause warnings to be fatal, such as:
15901.213Slukem			-Werror -Wa,--fatal-warnings
15911.213Slukem		(The latter being for as(1).)
15921.212Slukem
15931.212SlukemWARNS		Crank up GCC warning options; the distinct levels are:
15941.82Slukem			WARNS=1
15951.82Slukem			WARNS=2
15961.82Slukem			WARNS=3
15971.164Smatt			WARNS=4
15981.69Ssommerfe
15991.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
16001.144Slukem
16011.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
16021.221Smrgcross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
16031.144SlukemIt should be included after the general Makefile contents but before
16041.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
16051.144Slukem
16061.144SlukemIt provides the following targets:
16071.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
16081.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
16091.221Smrg		these rules convert from X11's manual page source
16101.144Slukem		into an mdoc.old source file.
16111.144Slukem	cleanx11man:
16121.144Slukem		Clean up the mdoc.old files generated by the above.
16131.144Slukem
16141.144SlukemIt sets the following variables:
16151.144Slukem
16161.144SlukemBINDIR			Set to ${X11BINDIR}.
16171.144Slukem			To override, define after including <bsd.x11.mk>
16181.144Slukem
16191.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
16201.144Slukem			To override, define after including <bsd.x11.mk>
16211.144Slukem
16221.144SlukemMANDIR			Set to ${X11MANDIR}.
16231.144Slukem			To override, define after including <bsd.x11.mk>
16241.144Slukem
16251.144SlukemCPPFLAGS		Appended with definitions to include from
16261.144Slukem			${DESTDIR}${X11INCDIR}
16271.144Slukem
16281.144SlukemLDFLAGS			Appended with definitions to link from
16291.144Slukem			${DESTDIR}${X11USRLIBDIR}
16301.144Slukem
16311.221SmrgX11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
16321.144Slukem
16331.221SmrgX11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
16341.144Slukem
16351.221SmrgX11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
16361.144Slukem
16371.221SmrgX11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
16381.144Slukem
16391.221SmrgX11FLAGS.SERVER		Equivalent to X11's ServerDefines.
16401.144Slukem
16411.221SmrgX11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
16421.144Slukem
16431.221SmrgX11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
16441.144Slukem
16451.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
16461.144Slukem
16471.221SmrgX11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
16481.221Smrg
16491.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
16501.144Slukem
16511.144SlukemIt uses the following variables:
16521.144Slukem
16531.144SlukemAPPDEFS			List of app-default files to install.
16541.144Slukem
16551.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
16561.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
16571.144Slukem			have a `.cpp' suffix, the generated files do not.
16581.144Slukem
16591.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
16601.144Slukem
16611.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
16621.144Slukem
16631.144Slukem
16641.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1665