bsd.README revision 1.95
11.95Slukem#	$NetBSD: bsd.README,v 1.95 2002/04/10 15:05:45 lukem Exp $
21.24Smikel#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
31.1Scgd
41.1ScgdThis is the README file for the new make "include" files for the BSD
51.1Scgdsource tree.  The files are installed in /usr/share/mk, and are, by
61.11Sjtcconvention, 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.21Schristos
611.45SlukemThe following variables that control how things are made/installed that
621.47Stvare not set by default. These should not be set by Makefiles; they're for
631.47Stvthe user to define in MAKECONF (see bsd.own.mk, below) or on the make(1)
641.47Stvcommand line:
651.21Schristos
661.45SlukemBUILD 		If defined, 'make install' checks that the targets in the
671.45Slukem		source directories are up-to-date and remakes them if they
681.21Schristos                are out of date, instead of blindly trying to install
691.79Swiz                out of date or non-existent targets.
701.21Schristos
711.45SlukemUPDATE 		If defined, 'make install' only installs targets that are
721.45Slukem		more recently modified in the source directories that their
731.45Slukem		installed counterparts.
741.52Ssimonb
751.83SperryUNPRIVED	If defined, don't set the owner/group/mode when installing
761.83Sperry		files or directories, and keep a metadata log of what
771.83Sperry		the owner/group/mode should be.  This allows a
781.83Sperry		non-root "make install".
791.45Slukem
801.86SthorpejMKBFD		If "no", don't build libbfd, libiberty, or any of
811.86Sthorpej		the things that depend on them (binutils/gas/ld,
821.86Sthorpej		gdb, dbsym, mdsetimage).  Only meaningful if
831.86Sthorpej		USE_NEW_TOOLCHAIN is set.
841.86Sthorpej
851.45SlukemMKCATPAGES	If "no", don't build or install the catman pages.
861.45Slukem
871.45SlukemMKDOC		If "no", don't build or install the documentation.
881.86Sthorpej
891.86SthorpejMKGDB		If "no", don't build gdb.  Only meaningful if
901.86Sthorpej		USE_NEW_TOOLCHAIN is set.
911.86Sthorpej
921.86SthorpejMKGCC		If "no", don't build gcc or any of the gcc-related
931.86Sthorpej		libraries (libg2c, libgcc, libobjc, libstdc++).
941.86Sthorpej		Only meaningful if USE_NEW_TOOLCHAIN is set.
951.92Sross
961.92SrossMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
971.92Sross		Has no effect on most platforms.
981.45Slukem
991.47StvMKINFO		If "no", don't build or install Info documentation from
1001.47Stv		Texinfo source files.
1011.45Slukem
1021.45SlukemMKLINT		If "no", don't build or install the lint libraries.
1031.45Slukem
1041.45SlukemMKMAN		If "no", don't build or install the man or catman pages.
1051.46Slukem		Also acts as "MKCATPAGES=no"
1061.45Slukem
1071.74SitojunMKNLS		If "no", don't build or install the NLS files and locale
1081.74Sitojun		definition files.
1091.45Slukem
1101.55SsommerfeMKOBJ		If "no", don't enable the rule which creates objdirs.
1111.55Ssommerfe		"yes" by default.
1121.55Ssommerfe
1131.55SsommerfeMKOBJDIRS	If "no", don't create objdirs during a "make build".
1141.55Ssommerfe		"no" by default.
1151.45Slukem
1161.45SlukemMKPIC		If "no", don't build or install shared libraries.
1171.45Slukem
1181.45SlukemMKPICINSTALL	If "no", don't install the *_pic.a libraries.
1191.45Slukem
1201.45SlukemMKPROFILE	If "no", don't build or install the profiling libraries.
1211.45Slukem
1221.48SlukemMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKINFO=no MKMAN=no
1231.48Slukem		MKNLS=no".  I.e, don't build catman pages, documentation,
1241.48Slukem		Info documentation, man pages, NLS files, ...
1251.1Scgd
1261.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1271.1Scgd
1281.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
1291.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
1301.71SitojunIf you intend to run a cross build, you will need to supply the following
1311.71Sitojunhost tools, and configure the following variables properly:
1321.71Sitojun
1331.71SitojunOBJCOPY		objcopy - copy and translate object files
1341.71Sitojun
1351.71SitojunSTRIP		strip - Discard symbols from object files
1361.71Sitojun
1371.71SitojunCONFIG		config - build kernel compilation directories
1381.71Sitojun
1391.71SitojunRPCGEN		rpcgen - Remote Procedure Call (RPC) protocol compiler
1401.71Sitojun
1411.71SitojunMKLOCALE	mklocale - make LC_CTYPE locale files
1421.80Sjmc
1431.80SjmcMTREE		mtree - build directory tree from a spec file
1441.1Scgd
1451.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1461.1Scgd
1471.1ScgdThe include file <bsd.man.mk> handles installing manual pages and their
1481.1Scgdlinks.
1491.1Scgd
1501.21SchristosIt has a two targets:
1511.1Scgd
1521.1Scgd	maninstall:
1531.21Schristos		Install the manual page sources and their links.
1541.21Schristos	catinstall:
1551.21Schristos		Install the preformatted manual pages and their links.
1561.1Scgd
1571.1ScgdIt sets/uses the following variables:
1581.1Scgd
1591.1ScgdMANDIR		Base path for manual installation.
1601.1Scgd
1611.1ScgdMANGRP		Manual group.
1621.1Scgd
1631.1ScgdMANOWN		Manual owner.
1641.1Scgd
1651.1ScgdMANMODE		Manual mode.
1661.1Scgd
1671.1ScgdMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
1681.1Scgd		or "/tahoe" for machine specific manual pages.
1691.1Scgd
1701.15ScgdMAN		The manual pages to be installed (use a .1 - .9 suffix).
1711.1Scgd
1721.15ScgdMLINKS		List of manual page links (using a .1 - .9 suffix).  The
1731.1Scgd		linked-to file must come first, the linked file second,
1741.1Scgd		and there may be multiple pairs.  The files are soft-linked.
1751.1Scgd
1761.1ScgdThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
1771.1Scgdit exists.
1781.1Scgd
1791.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1801.1Scgd
1811.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
1821.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
1831.17Sthorpeja few global "feature configuration" parameters.
1841.1Scgd
1851.1ScgdIt has no targets.
1861.1Scgd
1871.29ScjsTo get system-specific configuration parameters, bsd.own.mk will try to
1881.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
1891.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
1901.29Scjsis included.  These files may define any of the variables described below.
1911.17Sthorpej
1921.17Sthorpejbsd.own.mk sets the following variables, if they are not already defined
1931.17Sthorpej(defaults are in brackets):
1941.15Scgd
1951.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
1961.95Slukem		based on the presence of build.sh and tools/ .
1971.95Slukem
1981.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
1991.15Scgd		will work correctly. [/usr/src]
2001.15Scgd
2011.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
2021.15Scgd		will work correctly. [/usr/obj]
2031.15Scgd
2041.34SlukemBINGRP		Binary group. [wheel]
2051.15Scgd
2061.34SlukemBINOWN		Binary owner. [root]
2071.15Scgd
2081.15ScgdBINMODE		Binary mode. [555]
2091.15Scgd
2101.15ScgdNONBINMODE	Mode for non-executable files. [444]
2111.15Scgd
2121.15ScgdMANDIR		Base path for manual installation. [/usr/share/man/cat]
2131.15Scgd
2141.34SlukemMANGRP		Manual group. [wheel]
2151.15Scgd
2161.34SlukemMANOWN		Manual owner. [root]
2171.15Scgd
2181.15ScgdMANMODE		Manual mode. [${NONBINMODE}]
2191.15Scgd
2201.21SchristosMANINSTALL	Manual installation type: maninstall, catinstall, or both
2211.76Sfair
2221.76SfairLDSTATIC	Control program linking; if set blank, link everything
2231.76Sfair		dynamically. If set to "-static", link everything statically.
2241.76Sfair		If not set, programs link according to their makefile.
2251.21Schristos
2261.15ScgdLIBDIR		Base path for library installation. [/usr/lib]
2271.15Scgd
2281.85SlukemSHLIBDIR	If ${USE_SHLIBDIR} is "yes", use ${SHLIBDIR} instead of
2291.85Slukem		${LIBDIR} as the base path for shared library installation.
2301.85Slukem		[/usr/lib]
2311.85Slukem
2321.85Slukem_LIBSODIR	Set to ${SHLIBDIR} if ${USE_SHLIBDIR} is "yes",
2331.85Slukem		otherwise set to ${LIBDIR}
2341.85Slukem
2351.85SlukemSHLINKDIR	Base path for shared linker. [/usr/libexec]
2361.85Slukem
2371.15ScgdLINTLIBDIR	Base path for lint(1) library installation. [/usr/libdata/lint]
2381.15Scgd
2391.15ScgdLIBGRP		Library group. [${BINGRP}]
2401.15Scgd
2411.15ScgdLIBOWN		Library owner. [${BINOWN}]
2421.15Scgd
2431.15ScgdLIBMODE		Library mode. [${NONBINMODE}]
2441.15Scgd
2451.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
2461.15Scgd	        installation. [/usr/share/doc]
2471.62Ssimonb
2481.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
2491.62Ssimonb		[/usr/share/doc/html]
2501.15Scgd
2511.34SlukemDOCGRP		Documentation group. [wheel]
2521.15Scgd
2531.34SlukemDOCOWN		Documentation owner. [root]
2541.15Scgd
2551.15ScgdDOCMODE		Documentation mode. [${NONBINMODE}]
2561.15Scgd
2571.84SkleinkNLSDIR		Base path for Native Language Support files installation.
2581.15Scgd		[/usr/share/nls]
2591.1Scgd
2601.84SkleinkNLSGRP		Native Language Support files group. [wheel]
2611.1Scgd
2621.84SkleinkNLSOWN		Native Language Support files owner. [root]
2631.1Scgd
2641.84SkleinkNLSMODE		Native Language Support files mode. [${NONBINMODE}]
2651.1Scgd
2661.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
2671.1Scgd		to be stripped.  This is to be used when building your
2681.1Scgd		own install script so that the entire system can be made
2691.15Scgd		stripped/not-stripped using a single knob. [-s]
2701.1Scgd
2711.2ScgdCOPY		The flag passed to the install program to cause the binary
2721.2Scgd		to be copied rather than moved.  This is to be used when
2731.2Scgd		building our own install script so that the entire system
2741.2Scgd		can either be installed with copies, or with moves using
2751.15Scgd		a single knob. [-c]
2761.15Scgd
2771.17SthorpejAdditionally, the following variables may be set by bsd.own.mk or in a
2781.17Sthorpejmake configuration file to modify the behaviour of the system build
2791.17Sthorpejprocess (default values are in brackets along with comments, if set by
2801.17Sthorpejbsd.own.mk):
2811.15Scgd
2821.64SthorpejMKCRYPTO	If set to "no", no cryptography support will be built
2831.64Sthorpej		into the system.  Defaults to "yes".
2841.64Sthorpej
2851.64SthorpejNOCRYPTO	If set, it is equivalent to setting MKCRYPTO to "no".
2861.64Sthorpej
2871.66SitojunMKCRYPTO_IDEA	If set to "yes", IDEA support will be built into
2881.66Sitojun		libcrypto_idea.a.  Defaults to "no".
2891.64Sthorpej
2901.66SitojunMKCRYPTO_RC5	If set to "yes", RC5 support will be built into
2911.66Sitojun		libcrypto_rc5.a.  Defaults to "no".
2921.64Sthorpej
2931.94SthorpejMKHESIOD	If set to "no", disables building of Hesiod infrastructure
2941.94Sthorpej		(libraries and support programs).
2951.64Sthorpej
2961.94SthorpejMKKERBEROS	If set to "no", disables building of Kerberos (v4 or v5)
2971.94Sthorpej		infrastructure (libraries and support programs).
2981.2Scgd
2991.94SthorpejMKSKEY		If set to "no", disables building of S/key authentication
3001.94Sthorpej		infrastructure (libraries and support programs).
3011.94Sthorpej
3021.94SthorpejMKYP		If set to "no", disables building of YP (NIS)
3031.94Sthorpej		infrastructure (libraries and support programs).
3041.94Sthorpej
3051.94SthorpejUSE_HESIOD	If set to "no", disables building Hesiod support into
3061.94Sthorpej		various system utilities/libraries that support it.
3071.94Sthorpej		If MKHESIOD is set to "no", USE_HESIOD will also be
3081.94Sthorpej		forced to "no".
3091.94Sthorpej
3101.94SthorpejUSE_KERBEROS	If set to "no", disables building Kerberos (v4 or v5)
3111.94Sthorpej		support into various system utilities/libraries that
3121.94Sthorpej		support it.  If MKKERBEROS is set to "no", USE_KERBEROS
3131.94Sthorpej		will also be forced to "no".
3141.94Sthorpej
3151.94SthorpejUSE_SKEY	If set to "no", disables building S/key authentication
3161.94Sthorpej		support into various system utilities/libraries that
3171.94Sthorpej		support it.  If MKSKEY is set to "no", USE_SKEY will
3181.94Sthorpej		also be forced to "no".
3191.94Sthorpej
3201.94SthorpejUSE_YP		If set to "no", disables building YP (NIS) support into
3211.94Sthorpej		various system utilities/libraries that support it.  If
3221.94Sthorpej		MKYP is set to "no", USE_YP will also be forced to "no".
3231.15Scgd
3241.15ScgdMANZ		Compress manual pages at installation time.
3251.15Scgd
3261.15ScgdSYS_INCLUDE	Copy or symlink kernel include files into /usr/include.
3271.15Scgd		Possible values are "symlinks" or "copies" (which is
3281.15Scgd		the same as the variable being unset).
3291.1Scgd
3301.15ScgdNOPROFILE	Do not build profiled versions of system libraries
3311.1Scgd
3321.15ScgdNOPIC		Do not build PIC versions of system libraries, and
3331.15Scgd		do not build shared libraries.  [set if ${MACHINE_ARCH}
3341.65Sjlam		is "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.]
3351.1Scgd
3361.40SperryNOLINT		Do not build lint libraries.
3371.33Sjonathan
3381.50SthorpejOBJECT_FMT	Object file format. [set to "ELF" on architectures that
3391.50Sthorpej		use ELF -- currently if ${MACHINE_ARCH} is "alpha",
3401.50Sthorpej		"mipsel", "mipseb", "powerpc", "sparc", "sparc64",
3411.77Ssimonb		"i386" and some m68k machines, or set to "a.out" on
3421.77Ssimonb		other architectures].
3431.33Sjonathan
3441.78SsimonbMKSOFTFLOAT	If "yes", build with options to enable the compiler to
3451.78Ssimonb		generate output containing library calls for floating
3461.78Ssimonb		point and possibly soft-float library support.  Defaults
3471.78Ssimonb		to "no".
3481.1Scgd
3491.17Sthorpejbsd.own.mk is generally useful when building your own Makefiles so that
3501.1Scgdthey use the same default owners etc. as the rest of the tree.
3511.1Scgd
3521.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
3531.1Scgd
3541.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
3551.1Scgdmore source files, along with their manual pages.  It has a limited number
3561.1Scgdof suffixes, consistent with the current needs of the BSD tree.
3571.1Scgd
3581.16SjtcIt has eight targets:
3591.1Scgd
3601.1Scgd	all:
3611.1Scgd		build the program and its manual page
3621.1Scgd	clean:
3631.1Scgd		remove the program, any object files and the files a.out,
3641.24Smikel		Errs, errs, mklog, and ${PROG}.core.
3651.1Scgd	cleandir:
3661.1Scgd		remove all of the files removed by the target clean, as
3671.1Scgd		well as .depend, tags, and any manual pages.
3681.42Slukem		`distclean' is a synonym for `cleandir'.
3691.1Scgd	depend:
3701.1Scgd		make the dependencies for the source files, and store
3711.1Scgd		them in the file .depend.
3721.16Sjtc	includes:
3731.16Sjtc		install any header files.
3741.1Scgd	install:
3751.1Scgd		install the program and its manual pages; if the Makefile
3761.1Scgd		does not itself define the target install, the targets
3771.1Scgd		beforeinstall and afterinstall may also be used to cause
3781.1Scgd		actions immediately before and after the install target
3791.1Scgd		is executed.
3801.1Scgd	lint:
3811.1Scgd		run lint on the source files
3821.1Scgd	tags:
3831.1Scgd		create a tags file for the source files.
3841.1Scgd
3851.1ScgdIt sets/uses the following variables:
3861.1Scgd
3871.1ScgdBINGRP		Binary group.
3881.1Scgd
3891.1ScgdBINOWN		Binary owner.
3901.1Scgd
3911.1ScgdBINMODE		Binary mode.
3921.1Scgd
3931.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
3941.1Scgd
3951.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
3961.35Slukem
3971.35SlukemCPPFLAGS	Additional flags to the C pre-processor
3981.1Scgd
3991.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
4001.1Scgd		For example, to load with the compatibility and utility
4011.1Scgd		libraries, use:
4021.1Scgd
4031.5Sjtc			LDADD+=-lutil -lcompat
4041.1Scgd
4051.1ScgdLDFLAGS		Additional loader flags.
4061.1Scgd
4071.1ScgdLINKS		The list of binary links; should be full pathnames, the
4081.1Scgd		linked-to file coming first, followed by the linked
4091.1Scgd		file.  The files are hard-linked.  For example, to link
4101.1Scgd		/bin/test and /bin/[, use:
4111.1Scgd
4121.1Scgd			LINKS=	${DESTDIR}/bin/test ${DESTDIR}/bin/[
4131.19Sperry
4141.19SperrySYMLINKS	The list of symbolic links; should be full pathnames.
4151.20Sperry                Syntax is identical to LINKS. Note that DESTDIR is not
4161.20Sperry		automatically included in the link.
4171.1Scgd
4181.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
4191.8Scgd		defined, "MAN=${PROG}.1" is assumed.
4201.1Scgd
4211.1ScgdPROG		The name of the program to build.  If not supplied, nothing
4221.1Scgd		is built.
4231.1Scgd
4241.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
4251.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
4261.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
4271.88Sthorpej		the value of PROG if PROG is also set.
4281.87Sthorpej
4291.21SchristosPROGNAME	The name that the above program will be installed as, if
4301.21Schristos		different from ${PROG}.
4311.21Schristos
4321.37StvSRCS		List of source files to build the program.  If SRCS is not
4331.1Scgd		defined, it's assumed to be ${PROG}.c.
4341.1Scgd
4351.1ScgdDPADD		Additional dependencies for the program.  Usually used for
4361.1Scgd		libraries.  For example, to depend on the compatibility and
4371.1Scgd		utility libraries use:
4381.1Scgd
4391.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
4401.1Scgd
4411.1Scgd		The following libraries are predefined for DPADD:
4421.1Scgd
4431.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
4441.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
4451.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
4461.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
4471.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
4481.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
4491.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
4501.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
4511.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
4521.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
4531.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
4541.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
4551.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
4561.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
4571.21Schristos		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
4581.21Schristos		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
4591.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
4601.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
4611.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
4621.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
4631.21Schristos		LIBMP?=		${DESTDIR}/usr/lib/libmp.a
4641.25Schristos		LIBNTP?=	${DESTDIR}/usr/lib/libntp.a
4651.21Schristos		LIBPC?=		${DESTDIR}/usr/lib/libpc.a
4661.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
4671.21Schristos		LIBPLOT?=	${DESTDIR}/usr/lib/libplot.a
4681.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
4691.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
4701.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
4711.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
4721.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
4731.21Schristos		LIBTELNET?=	${DESTDIR}/usr/lib/libtelnet.a
4741.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
4751.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
4761.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
4771.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
4781.1Scgd
4791.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
4801.12Schristos		strings, using xstr(1). Note that this will not work with
4811.12Schristos		parallel makes.
4821.1Scgd
4831.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
4841.1Scgd		to be stripped.
4851.1Scgd
4861.1ScgdSUBDIR		A list of subdirectories that should be built as well.
4871.1Scgd		Each of the targets will execute the same target in the
4881.1Scgd		subdirectories.
4891.1Scgd
4901.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
4911.21Schristos		These are installed exactly like programs.
4921.21Schristos
4931.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
4941.21Schristos		different from ${SCRIPTS}. These can be further specialized
4951.21Schristos		by setting SCRIPTSNAME_<script>.
4961.21Schristos
4971.21SchristosFILES		A list of files to install. The installation is controlled
4981.21Schristos		by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR
4991.21Schristos		variables that can be further specialized by FILES<VAR>_<file>
5001.21Schristos
5011.85SlukemSHLINKDIR	Target directory for shared linker.
5021.85Slukem
5031.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
5041.1Scgdif it exists, as well as the include file <bsd.man.mk>.
5051.1Scgd
5061.1ScgdSome simple examples:
5071.1Scgd
5081.1ScgdTo build foo from foo.c with a manual page foo.1, use:
5091.1Scgd
5101.1Scgd	PROG=	foo
5111.1Scgd
5121.1Scgd	.include <bsd.prog.mk>
5131.1Scgd
5141.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
5151.1Scgd
5161.9Scgd	MAN=	foo.2
5171.1Scgd
5181.1ScgdIf foo does not have a manual page at all, add the line:
5191.1Scgd
5201.75Sagc	MKMAN=	no
5211.1Scgd
5221.1ScgdIf foo has multiple source files, add the line:
5231.1Scgd
5241.1Scgd	SRCS=	a.c b.c c.c d.c
5251.1Scgd
5261.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5271.1Scgd
5281.1ScgdThe include file <bsd.subdir.mk> contains the default targets for building
5291.16Sjtcsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all, 
5301.16Sjtcclean, cleandir, depend, includes, install, lint, and tags.  For all of
5311.72Ssommerfethe directories listed in the variable SUBDIR, the specified directory 
5321.16Sjtcwill be visited and the target made.  There is also a default target which
5331.16Sjtcallows the command "make subdir" where subdir is any directory listed in
5341.72Ssommerfethe variable SUBDIR.
5351.72Ssommerfe
5361.72SsommerfeAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
5371.72Ssommerfeas a synchronization barrier when multiple make jobs are run; subdirs
5381.72Ssommerfebefore the .WAIT must complete before any subdirs after .WAIT are
5391.75Sagcstarted.  See make(1) for some caveats on use of .WAIT and other
5401.75Sagcspecial sources.
5411.21Schristos
5421.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5431.21Schristos
5441.23SchristosThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
5451.23Schristosand is included from from bsd.lib.mk and bsd.prog.mk.
5461.23Schristos
5471.23Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5481.23Schristos
5491.23SchristosThe include file <bsd.files.mk> handles the FILES variables and is included
5501.23Schristosfrom bsd.lib.mk and bsd.prog.mk.
5511.21Schristos
5521.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5531.21Schristos
5541.29ScjsThe include file <bsd.inc.mk> defines the includes target and uses two
5551.29Scjsvariables:
5561.21Schristos
5571.81SwizINCS		The list of include files
5581.21Schristos
5591.81SwizINCSDIR		The location to install the include files.
5601.81Swiz
5611.81SwizINCSNAME	Target name of the include file, if only one; same as
5621.81Swiz		FILESNAME, but for include files.
5631.81Swiz
5641.81SwizINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
5651.81Swiz		same as FILESNAME_<file>, but for include files.
5661.39Scgd
5671.39Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5681.39Scgd
5691.39ScgdThe include file <bsd.kinc.mk> defines the many targets (includes,
5701.39Scgdsubdirectories, etc.), and is used by kernel makefiles to handle
5711.39Scgdinclude file installation.  It is intended to be included alone, by
5721.39Scgdkernel Makefiles.  Please see bsd.kinc.mk for more details, and keep
5731.39Scgdthe documentation in that file up to date.
5741.13Schristos
5751.13Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5761.13Schristos
5771.47StvThe include file <bsd.info.mk> is used to generate and install GNU Info
5781.47Stvdocumentation from respective Texinfo source files.  It defines three
5791.47Stvimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
5801.47Stvfollowing variables:
5811.47Stv
5821.47StvTEXINFO		List of Texinfo source files.  Info documentation will
5831.47Stv		consist of single files with the extension replaced by
5841.47Stv		.info.
5851.47Stv
5861.47StvINFOFLAGS	Flags to pass to makeinfo.  []
5871.47Stv
5881.47StvINSTALL_INFO	Name of install-info program.  [install-info]
5891.47Stv
5901.47StvMAKEINFO	Name of makeinfo program.  [makeinfo]
5911.47Stv
5921.47Stv=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5931.47Stv
5941.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
5951.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
5961.14Scgdthe NetBSD source tree.  For instance, if "PARALLEL" is defined by
5971.14Scgdthe program/library Makefile, it includes a set of rules for lex and
5981.14Scgdyacc that allow multiple lex and yacc targets to be built in parallel.
5991.69Ssommerfe
6001.69SsommerfeOther variables of note (incomplete list):
6011.69Ssommerfe
6021.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
6031.82Slukem			WARNS=1
6041.82Slukem			WARNS=2
6051.82Slukem			WARNS=3
6061.69Ssommerfe
6071.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
6081.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
6091.75Sagc		WFORMAT belongs in individual makefiles and/or
6101.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
6111.75Sagc		makefiles if a program is not security critical and is
6121.75Sagc		doing bizarre things with format strings which would
6131.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
6141.75Sagc		mk.conf if you're doing format-string auditing. 
6151.69Ssommerfe		FORMAT_AUDIT may go away in time.
6161.1Scgd
6171.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6181.1Scgd
6191.1ScgdThe include file <bsd.lib.mk> has support for building libraries.  It has
6201.16Sjtcthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
6211.44Serhincludes, install, lint, and tags.  Additionally, it has a checkver target
6221.44Serhwhich checks for installed shared object libraries whose version is greater
6231.44Serhthat the version of the source. It has a limited number of suffixes,
6241.16Sjtcconsistent with the current needs of the BSD tree.
6251.1Scgd
6261.1ScgdIt sets/uses the following variables:
6271.10Scgd
6281.10ScgdLIB		The name of the library to build.
6291.1Scgd
6301.1ScgdLIBDIR		Target directory for libraries.
6311.85Slukem
6321.85SlukemSHLIBDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
6331.85Slukem		is "yes".
6341.85Slukem
6351.85SlukemUSE_SHLIBDIR	If "yes", use ${SHLIBDIR} instead of ${LIBDIR}
6361.85Slukem		as the path to install shared libraries to.
6371.1Scgd
6381.1ScgdLINTLIBDIR	Target directory for lint libraries.
6391.1Scgd
6401.1ScgdLIBGRP		Library group.
6411.1Scgd
6421.1ScgdLIBOWN		Library owner.
6431.1Scgd
6441.1ScgdLIBMODE		Library mode.
6451.1Scgd
6461.1ScgdLDADD		Additional loader objects.
6471.1Scgd
6481.15ScgdMAN		The manual pages to be installed (use a .1 - .9 suffix).
6491.47Stv
6501.47StvMKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
6511.47Stv		Also:
6521.47Stv			- don't install the .a libraries
6531.47Stv			- don't install _pic.a libraries on PIC systems
6541.47Stv			- don't build .a libraries on PIC systems
6551.47Stv			- don't install the .so symlink on ELF systems
6561.47Stv		I.e, only install the shared library (and the .so.major
6571.47Stv		symlink on ELF).
6581.54Ssimonb
6591.54SsimonbMKPICLIB	If "no", don't build _pic.a libraries, and build the
6601.54Ssimonb		shared object libraries from the .a libraries.  A
6611.54Ssimonb		symlink is installed in ${DESTDIR}/usr/lib for the
6621.54Ssimonb		_pic.a library pointing to the .a library.
6631.44Serh
6641.44SerhNOCHECKVER_<library>
6651.44SerhNOCHECKVER	If set, disables checking for installed shared object
6661.44Serh		libraries with versions greater than the source.  A
6671.44Serh		particular library name, without the "lib" prefix, may
6681.44Serh		be appended to the variable name to disable the check for
6691.44Serh		only that library.
6701.1Scgd
6711.1ScgdSRCS		List of source files to build the library.  Suffix types
6721.1Scgd		.s, .c, and .f are supported.  Note, .s files are preferred
6731.1Scgd		to .c files of the same name.  (This is not the default for
6741.1Scgd		versions of make.)
6751.1Scgd
6761.1ScgdThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
6771.1Scgdif it exists, as well as the include file <bsd.man.mk>.
6781.1Scgd
6791.1ScgdIt has rules for building profiled objects; profiled libraries are
6801.1Scgdbuilt by default.
6811.1Scgd
6821.4ScgdLibraries are ranlib'd when made.
6831.56Ssommerfe
6841.56Ssommerfe=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6851.56Ssommerfe
6861.56SsommerfeThe include file <bsd.obj.mk> defines targets related to the creation
6871.56Ssommerfeand use of separated object and source directories.
6881.56Ssommerfe
6891.63SsjgIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
6901.63Ssjg${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
6911.75Sagcit exists.  Otherwise make(1) looks for the existence of a
6921.63Ssjgsubdirectory (or a symlink to a directory) of the source directory
6931.63Ssjginto which built targets should be placed.  If an environment variable
6941.63Ssjgnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
6951.63Ssjgobject directory; failing that, make first looks for a subdirectory
6961.63Ssjgnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
6971.56Ssommerfe
6981.56SsommerfeObject directories are not created automatically by make(1) if they
6991.56Ssommerfedon't exist; you need to run a separate "make obj".  (This will happen
7001.56Ssommerfeduring a top-level build if "MKOBJDIRS" is set to a value other than
7011.58Ssommerfe"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
7021.58Ssommerfeand this is determined by a simple string prefix comparison -- object
7031.58Ssommerfedirectories are created in a separate object directory tree, and a
7041.58Ssommerfesymlink to the object directory in that tree is created in the source
7051.58Ssommerfedirectory; otherwise, "make obj" assumes that you're not in the main
7061.58Ssommerfesource tree and that it's not safe to use a separate object tree.
7071.56Ssommerfe
7081.56SsommerfeSeveral variables used by <bsd.obj.mk> control exactly what
7091.56Ssommerfedirectories and links get created during a "make obj":
7101.56Ssommerfe
7111.56SsommerfeMAKEOBJDIR	If set, this is the component name of the object
7121.56Ssommerfe		directory.
7131.56Ssommerfe
7141.56SsommerfeOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
7151.56Ssommerfe		object directories or links named "obj.${MACHINE}";
7161.56Ssommerfe		otherwise, just creates ones named "obj".
7171.56Ssommerfe
7181.56SsommerfeUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
7191.56Ssommerfe		${BSDSRCDIR}, create object directory in the
7201.56Ssommerfe		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
7211.56Ssommerfe		otherwise, create it in the corresponding subdirectory
7221.56Ssommerfe		of ${BSDOBJDIR}
7231.93Sthorpej
7241.93SthorpejBUILDID		If set, the contents of this variable are appended
7251.93Sthorpej		to the object directory name.  If OBJMACHINE is also
7261.93Sthorpej		set, ".${BUILDID}" is added after ".${MACHINE}".
7271.63Ssjg
7281.63Ssjg=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7291.63Ssjg
7301.63SsjgThe include file <bsd.kernobj.mk> defines variables related to the
7311.63Ssjglocation of kernel sources and object directories.
7321.63Ssjg
7331.63SsjgKERNSRCDIR	Is the location of the top of the kernel src.
7341.95Slukem		It defaults to ${_SRC_TOP_}/sys
7351.63Ssjg
7361.63SsjgKERNARCHDIR	Is the location of the machine dependent kernel
7371.63Ssjg		sources.  It defaults to arch/${MACHINE}
7381.63Ssjg		
7391.63SsjgKERNCONFDIR	Is where the configuration files for kernels are
7401.63Ssjg		found; default is ${KERNSRCDIR}/${KERNARCHDIR}/conf.
7411.63Ssjg
7421.63SsjgKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
7431.63Ssjg		instance will be compiled in ${KERNOBJDIR}/GENERIC.
7441.63Ssjg		The default value is
7451.63Ssjg		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
7461.63Ssjg		if it exists or the target 'obj' is being made.
7471.63Ssjg		Otherwise the default is
7481.63Ssjg		${KERNSRCDIR}/${KERNARCHDIR}/compile.
7491.63Ssjg
7501.63SsjgIt is important that Makefiles (such as those under src/distrib) that
7511.63Ssjgwish to find compiled kernels use bsd.kernobj.mk and ${KERNOBJDIR}
7521.63Ssjgrather than make assumptions about the location of the compiled kernel.
7531.30Sagc
7541.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
755