bsd.README revision 1.178
11.178Slukem#	$NetBSD: bsd.README,v 1.178 2006/05/12 04:29:08 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.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.172ShubertfMKxxx		Can be set to "no" to disable functionality, or
701.172Shubertf		"yes" to enable it.
711.172Shubertf		Usually defaults to "yes", although some variables
721.172Shubertf		default to "no".
731.172Shubertf		Due to make(1) implementation issues, if a temporary
741.172Shubertf		command-line override of a mk.conf or <bsd.own.mk>
751.172Shubertf		setting is required whilst still honouring a particular
761.172Shubertf		Makefile's setting of MKxxx, use
771.172Shubertf			env MKxxx=value make
781.172Shubertf		instead of
791.172Shubertf			make MKxxx=value
801.172Shubertf
811.172ShubertfNOxxx		If defined, disables a feature.
821.172Shubertf		Not intended for users.
831.172Shubertf		This is to allow Makefiles to disable functionality
841.172Shubertf		that they don't support (such as missing man pages).
851.172Shubertf		NOxxx variables must be defined before <bsd.own.mk>
861.172Shubertf		is included.
871.172Shubertf
881.172ShubertfThe following variables that control how things are made/installed that
891.172Shubertfare not set by default. These should not be set by Makefiles; they're for
901.172Shubertfthe user to define in MAKECONF (see <bsd.own.mk>, below) or on the make(1)
911.172Shubertfcommand line:
921.172Shubertf
931.172ShubertfBUILD 		If defined, 'make install' checks that the targets in the
941.172Shubertf		source directories are up-to-date and remakes them if they
951.172Shubertf                are out of date, instead of blindly trying to install
961.172Shubertf                out of date or non-existent targets.
971.172Shubertf
981.172ShubertfMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
991.172Shubertf		Default: 2
1001.172Shubertf		Supported values:
1011.172Shubertf		    0	Minimal output ("quiet")
1021.172Shubertf		    1	Describe what is occurring
1031.172Shubertf		    2	Describe what is occurring and echo the actual command
1041.172Shubertf
1051.172Shubertf
1061.172ShubertfMKBFD		If "no", don't build libbfd, libiberty, or any of the things
1071.172Shubertf		that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage).
1081.172Shubertf		Default: yes
1091.172Shubertf
1101.172ShubertfMKCATPAGES	If "no", don't build or install the catman pages.
1111.172Shubertf		Default: yes
1121.172Shubertf
1131.172ShubertfMKCRYPTO	If "no", no cryptography support will be built into the system,
1141.174Schristos		and also acts as "MKKERBEROS=no".
1151.172Shubertf		Default: yes
1161.172Shubertf
1171.172ShubertfMKCRYPTO_IDEA	If not "no", IDEA support will be built into libcrypto_idea.a.
1181.172Shubertf		Default: no
1191.172Shubertf
1201.172ShubertfMKCRYPTO_MDC2	If not "no", MDC2 support will be built into libcrypto_mdc2.a
1211.172Shubertf		Default: no
1221.172Shubertf
1231.172ShubertfMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
1241.172Shubertf		Default: no
1251.172Shubertf
1261.172ShubertfMKCVS		If "no", don't build or install cvs(1).
1271.172Shubertf		Default: yes
1281.172Shubertf
1291.176SchristosMKDEBUG		Build debugging libraries.
1301.176Schristos		Default: no
1311.176Schristos
1321.172ShubertfMKDOC		If "no", don't build or install the documentation.
1331.172Shubertf		Default: yes
1341.172Shubertf
1351.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1361.172Shubertf		don't install certain libraries in /lib, and don't
1371.172Shubertf		install the shared linker into /libexec.
1381.172Shubertf		Default: yes
1391.172Shubertf
1401.172ShubertfMKGCC		If "no", don't build gcc(1) or any of the gcc-related
1411.172Shubertf		libraries (libg2c, libgcc, libobjc, libstdc++).
1421.172Shubertf		Default: yes
1431.172Shubertf
1441.172ShubertfMKGCCCMDS	If "no", don't build gcc(1).
1451.172Shubertf		Default: yes
1461.172Shubertf
1471.172ShubertfMKGDB		If "no", don't build gdb(1).
1481.172Shubertf		Default: yes
1491.172Shubertf
1501.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
1511.172Shubertf		(libraries and support programs).
1521.172Shubertf		Default: yes
1531.172Shubertf
1541.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
1551.172Shubertf		host, the name, release, and architecture of the host
1561.172Shubertf		operating system will be suffixed to the name of the object
1571.172Shubertf		directory created by "make obj".
1581.172Shubertf		Default: no
1591.172Shubertf
1601.172ShubertfMKHTML		If "no", don't build or install the html man pages.
1611.172Shubertf		Default: no
1621.172Shubertf
1631.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
1641.172Shubertf		Has no effect on most platforms.
1651.172Shubertf		Default: yes
1661.172Shubertf
1671.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
1681.172Shubertf		(libraries and support programs).
1691.172Shubertf		Default: yes
1701.172Shubertf
1711.172ShubertfMKINFO		If "no", don't build or install Info documentation from
1721.172Shubertf		Texinfo source files.
1731.172Shubertf		Default: yes
1741.172Shubertf
1751.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
1761.172Shubertf		Default: yes
1771.172Shubertf
1781.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
1791.172Shubertf		infrastructure (libraries and support programs).
1801.172Shubertf		Default: yes
1811.172Shubertf
1821.172ShubertfMKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
1831.172Shubertf		Also:
1841.172Shubertf			- don't install the .a libraries
1851.172Shubertf			- don't install _pic.a libraries on PIC systems
1861.172Shubertf			- don't build .a libraries on PIC systems
1871.172Shubertf			- don't install the .so symlink on ELF systems
1881.172Shubertf		I.e, only install the shared library (and the .so.major
1891.172Shubertf		symlink on ELF).
1901.172Shubertf		Default: yes
1911.172Shubertf
1921.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
1931.172Shubertf		Default: yes
1941.172Shubertf
1951.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
1961.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
1971.172Shubertf		Default: yes
1981.172Shubertf
1991.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2001.172Shubertf		Default: no
2011.172Shubertf
2021.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2031.172Shubertf		definition files.
2041.172Shubertf		Default: yes
2051.172Shubertf
2061.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2071.172Shubertf		and also acts as "MKOBJDIRS=no".
2081.172Shubertf		Default: yes
2091.172Shubertf
2101.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
2111.172Shubertf		Default: no
2121.172Shubertf
2131.172ShubertfMKPAM		If "no", disables building of PAM authentication
2141.172Shubertf		infrastructure (libraries and support programs).
2151.172Shubertf		Default: no
2161.172Shubertf
2171.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
2181.172Shubertf		Default: yes
2191.172Shubertf
2201.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
2211.172Shubertf		also acts as "MKPICLIB=no"
2221.172Shubertf		Default: yes (for MACHINE_ARCHs that support it) 
2231.172Shubertf
2241.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2251.172Shubertf		Default: yes
2261.172Shubertf
2271.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2281.172Shubertf		shared object libraries from the .a libraries.
2291.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
2301.172Shubertf		_pic.a library pointing to the .a library.
2311.172Shubertf		Default: yes
2321.172Shubertf
2331.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
2341.172Shubertf		Default: yes
2351.172Shubertf
2361.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
2371.172Shubertf		Default: yes
2381.172Shubertf
2391.172ShubertfMKSENDMAIL	If "no", don't build or install sendmail(8).
2401.172Shubertf		Default: yes
2411.172Shubertf
2421.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
2431.172Shubertf		MKMAN=no MKNLS=no".
2441.172Shubertf		I.e, don't build catman pages, documentation, Info
2451.172Shubertf		documentation, man pages, NLS files, ...
2461.172Shubertf		Default: yes
2471.172Shubertf
2481.172ShubertfMKSKEY		If "no", disables building of S/key authentication
2491.172Shubertf		infrastructure (libraries and support programs).
2501.172Shubertf		Default: yes
2511.172Shubertf
2521.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
2531.172Shubertf		generate output containing library calls for floating
2541.172Shubertf		point and possibly soft-float library support.
2551.172Shubertf		Default: no
2561.172Shubertf
2571.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
2581.172Shubertf		libraries.
2591.172Shubertf		Default: yes
2601.172Shubertf
2611.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
2621.172Shubertf		files or directories, and keep a metadata log of what
2631.172Shubertf		the owner/group/mode should be.  This allows a
2641.172Shubertf		non-root "make install".
2651.172Shubertf		Default: no
2661.172Shubertf
2671.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
2681.172Shubertf		more recently modified in the source directories that their
2691.172Shubertf		installed counterparts.
2701.172Shubertf		Default: no
2711.172Shubertf
2721.172ShubertfMKUUCP		If "no", don't build or install uucp(1).
2731.172Shubertf		Default: yes
2741.172Shubertf
2751.172ShubertfMKX11		If not "no", 'make build' also descends into src/x11
2761.172Shubertf		to cross build X11R6 and automatically enables creation
2771.172Shubertf		of X sets.
2781.172Shubertf		Default: no
2791.172Shubertf
2801.172ShubertfMKYP		If "no", disables building of YP (NIS)
2811.172Shubertf		infrastructure (libraries and support programs).
2821.172Shubertf		Default: yes
2831.172Shubertf
2841.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
2851.172Shubertf		various system utilities/libraries that support it.
2861.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
2871.172Shubertf		forced to "no".
2881.172Shubertf
2891.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
2901.172Shubertf		various system utilities/libraries that support it.
2911.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
2921.172Shubertf		forced to "no".
2931.172Shubertf
2941.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
2951.172Shubertf		support into various system utilities/libraries that
2961.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
2971.172Shubertf		will also be forced to "no".
2981.172Shubertf
2991.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
3001.172Shubertf		into various system utilities/libraries that support it.
3011.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
3021.172Shubertf
3031.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
3041.172Shubertf		support into various system utilities/libraries that
3051.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
3061.172Shubertf		also be forced to "no".
3071.172Shubertf
3081.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
3091.172Shubertf		various system utilities/libraries that support it.
3101.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
3111.172Shubertf
3121.172ShubertfCOPTS.lib<lib>
3131.177SmrgOBJCOPTS.lib<lib>
3141.172ShubertfLDADD.lib<lib>
3151.172ShubertfCPPFLAGS.lib<lib>
3161.172ShubertfCXXFLAGS.lib<lib>
3171.172ShubertfCOPTS.<prog>
3181.177SmrgOBJCCOPTS.<prog>
3191.172ShubertfLDADD.<prog>
3201.172ShubertfCPPFLAGS.<prog>
3211.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
3221.172Shubertf		variables in a way that applies only to a particular library
3231.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
3241.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
3251.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
3261.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
3271.172Shubertf		the crypto library.
3281.118Slukem
3291.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
3301.1Scgd
3311.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
3321.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
3331.1Scgd
3341.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
3351.1Scgd
3361.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
3371.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
3381.17Sthorpeja few global "feature configuration" parameters.
3391.1Scgd
3401.1ScgdIt has no targets.
3411.1Scgd
3421.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
3431.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
3441.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
3451.29Scjsis included.  These files may define any of the variables described below.
3461.17Sthorpej
3471.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
3481.17Sthorpej(defaults are in brackets):
3491.15Scgd
3501.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
3511.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
3521.98Slukem		otherwise BSDSRCDIR will be used as the default.
3531.98Slukem		Various makefiles within the NetBSD source tree will
3541.98Slukem		use this to reference the top level of the source tree.
3551.98Slukem
3561.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
3571.98Slukem		based on the presence of tools/ and build.sh.  This variable
3581.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
3591.98Slukem		determined once and then propagated to all sub-makes.
3601.95Slukem
3611.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
3621.116Slukem		will work correctly.  [/usr/src]
3631.15Scgd
3641.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
3651.116Slukem		will work correctly.  [/usr/obj]
3661.15Scgd
3671.116SlukemBINGRP		Binary group.  [wheel]
3681.15Scgd
3691.116SlukemBINOWN		Binary owner.  [root]
3701.15Scgd
3711.116SlukemBINMODE		Binary mode.  [555]
3721.15Scgd
3731.116SlukemNONBINMODE	Mode for non-executable files.  [444]
3741.15Scgd
3751.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
3761.15Scgd
3771.116SlukemMANGRP		Manual group.  [wheel]
3781.15Scgd
3791.116SlukemMANOWN		Manual owner.  [root]
3801.15Scgd
3811.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
3821.15Scgd
3831.21SchristosMANINSTALL	Manual installation type: maninstall, catinstall, or both
3841.155Sjmc		[maninstall catinstall]
3851.76Sfair
3861.76SfairLDSTATIC	Control program linking; if set blank, link everything
3871.129Slukem		dynamically.  If set to "-static", link everything statically.
3881.76Sfair		If not set, programs link according to their makefile.
3891.21Schristos
3901.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
3911.15Scgd
3921.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
3931.15Scgd
3941.116SlukemLIBGRP		Library group.  [${BINGRP}]
3951.15Scgd
3961.116SlukemLIBOWN		Library owner.  [${BINOWN}]
3971.15Scgd
3981.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
3991.15Scgd
4001.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
4011.116Slukem	        installation.  [/usr/share/doc]
4021.62Ssimonb
4031.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
4041.62Ssimonb		[/usr/share/doc/html]
4051.15Scgd
4061.116SlukemDOCGRP		Documentation group.  [wheel]
4071.15Scgd
4081.116SlukemDOCOWN		Documentation owner.  [root]
4091.15Scgd
4101.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
4111.15Scgd
4121.84SkleinkNLSDIR		Base path for Native Language Support files installation.
4131.15Scgd		[/usr/share/nls]
4141.1Scgd
4151.116SlukemNLSGRP		Native Language Support files group.  [wheel]
4161.1Scgd
4171.116SlukemNLSOWN		Native Language Support files owner.  [root]
4181.1Scgd
4191.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
4201.1Scgd
4211.144SlukemX11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
4221.144Slukem
4231.144SlukemX11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
4241.144Slukem
4251.144SlukemX11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
4261.144Slukem
4271.144SlukemX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
4281.144Slukem
4291.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
4301.144Slukem
4311.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
4321.144Slukem
4331.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
4341.144Slukem
4351.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
4361.144Slukem
4371.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
4381.144Slukem
4391.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
4401.144Slukem
4411.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
4421.1Scgd		to be stripped.  This is to be used when building your
4431.1Scgd		own install script so that the entire system can be made
4441.146Slukem		stripped/not-stripped using a single knob.  []
4451.1Scgd
4461.2ScgdCOPY		The flag passed to the install program to cause the binary
4471.2Scgd		to be copied rather than moved.  This is to be used when
4481.2Scgd		building our own install script so that the entire system
4491.2Scgd		can either be installed with copies, or with moves using
4501.116Slukem		a single knob.  [-c]
4511.15Scgd
4521.150SlukemMAKEDIRTARGET dir target [params]
4531.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
4541.150Slukem		displaying a "pretty" message whilst doing so.
4551.150Slukem
4561.152SclRELEASEMACHINEDIR
4571.152Scl		Subdirectory used below RELEASEDIR when building
4581.152Scl		a release.  [${MACHINE}]
4591.152Scl
4601.152SclRELEASEMACHINE	Subdirectory or path component used for the following
4611.152Scl		paths:
4621.152Scl			distrib/${RELEASEMACHINE}
4631.152Scl			distrib/notes/${RELEASEMACHINE}
4641.152Scl			etc/etc.${RELEASEMACHINE}
4651.152Scl		Used when building a release.  [${MACHINE}]
4661.150Slukem
4671.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
4681.17Sthorpejmake configuration file to modify the behaviour of the system build
4691.17Sthorpejprocess (default values are in brackets along with comments, if set by
4701.134Slukem<bsd.own.mk>):
4711.33Sjonathan
4721.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
4731.172Shubertf		be used as part of a build in progress.
4741.172Shubertf		Supported values:
4751.172Shubertf
4761.172Shubertf		yes	Use the tools from TOOLDIR.
4771.172Shubertf			Must be set to this if cross-compiling.
4781.172Shubertf
4791.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
4801.172Shubertf			build native compilation tool components that are
4811.172Shubertf			version-specific for that tool.
4821.172Shubertf
4831.172Shubertf		never	Do not use the tools from TOOLDIR, even when
4841.172Shubertf			building native tool components.  This is similar to
4851.172Shubertf			the traditional NetBSD build method, but does not
4861.172Shubertf			verify that the compilation tools in use are
4871.172Shubertf			up-to-date enough in order to build the tree
4881.172Shubertf			successfully.  This may cause build or runtime
4891.172Shubertf			problems when building the whole NetBSD source tree.
4901.172Shubertf
4911.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
4921.172Shubertf		source tree (detected automatically); "no" otherwise
4931.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
4941.172Shubertf		make(1) include files).
4951.142Slukem
4961.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
4971.156Stron		use ELF -- currently all architectures but ns32k, set to
4981.156Stron		"a.out" on ns32k].
4991.33Sjonathan
5001.103SthorpejTOOLCHAIN_MISSING
5011.142Slukem		If not "no", this indicates that the platform being built
5021.103Sthorpej		does not have a working in-tree toolchain.  If the
5031.142Slukem		${MACHINE_ARCH} in question falls into this category,
5041.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
5051.103Sthorpej		Otherwise, the variable is unconditionally assigned the
5061.103Sthorpej		value "no".
5071.142Slukem		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
5081.142Slukem		unconditionally assigned the value "no".
5091.103Sthorpej
5101.103SthorpejEXTERNAL_TOOLCHAIN
5111.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
5121.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
5131.103Sthorpej		access to this variable.  The variable should be defined
5141.103Sthorpej		either in the user's environment or in the user's mk.conf
5151.103Sthorpej		file.  If defined, this variable indicates the root of
5161.103Sthorpej		an external toolchain which will be used to build the
5171.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
5181.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
5191.103Sthorpej		cross-compile framework.
5201.103Sthorpej
5211.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
5221.142Slukem		assigned the value "no", since the external version of the
5231.142Slukem		compiler may not be able to build the library components of
5241.142Slukem		the in-tree compiler.
5251.103Sthorpej
5261.103Sthorpej		NOTE: This variable is not yet used in as many places as
5271.103Sthorpej		it should be.  Expect the exact semantics of this variable
5281.103Sthorpej		to change in the short term as parts of the cross-compile
5291.103Sthorpej		framework continue to be cleaned up.
5301.1Scgd
5311.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
5321.1Scgdthey use the same default owners etc. as the rest of the tree.
5331.131Slukem
5341.131Slukem
5351.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
5361.131Slukem
5371.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
5381.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
5391.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
5401.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
5411.133Slukemdependencies for the .d files.  In order for this to function correctly,
5421.132Slukemit should be .included after all other .mk files and directives that may
5431.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
5441.132Slukem
5451.132SlukemSRCS		List of source files to build the program.
5461.132Slukem
5471.132SlukemDPSRCS		List of source files which are needed for generating
5481.132Slukem		dependencies, but are not needed in ${SRCS}.
5491.1Scgd
5501.1Scgd
5511.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
5521.106Sthorpej
5531.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
5541.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
5551.124Slukem
5561.124SlukemFILES		The list of files to install.
5571.124Slukem
5581.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
5591.153Slukem		are installed by the `configinstall' target,
5601.153Slukem		not the `install' target.
5611.153Slukem		The FILES* variables documented below also apply.
5621.153Slukem
5631.124SlukemFILESOWN	File owner.  [${BINOWN}]
5641.124Slukem
5651.124SlukemFILESGRP	File group.  [${BINGRP}]
5661.124Slukem
5671.124SlukemFILESMODE	File mode.  [${BINMODE}]
5681.124Slukem
5691.124SlukemFILESDIR	The location to install the files.
5701.124Slukem
5711.124SlukemFILESNAME	Optional name to install each file as.
5721.124Slukem
5731.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
5741.153Slukem
5751.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
5761.153Slukem
5771.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
5781.153Slukem
5791.153SlukemFILESDIR_<fn>	The location to install the specific file <fn>>
5801.153Slukem
5811.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
5821.124Slukem
5831.135Slukem
5841.139SlukemBUILDSYMLINKS	List of two word items:
5851.135Slukem			lnsrc lntgt
5861.135Slukem		For each lnsrc item, create a symlink named lntgt.
5871.135Slukem		The lntgt symlinks are removed by the cleandir target.
5881.106Sthorpej
5891.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
5901.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
5911.148Sjmc		The source files have a `.uue' suffix, the generated files do 
5921.148Sjmc		not.
5931.149Sjmc
5941.149SjmcUUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
5951.148Sjmc		
5961.148Sjmc		*NOTE: These files are simply decoded, with no install or other
5971.148Sjmc		       rule applying implicitly except being added to the clean
5981.148Sjmc		       target.
5991.106Sthorpej
6001.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
6011.113Sthorpej
6021.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
6031.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
6041.134Slukembefore <bsd.gcc.mk>.
6051.113Sthorpej
6061.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
6071.113Sthorpejof which need to know where to find certain GCC support libraries.
6081.113Sthorpej
6091.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
6101.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
6111.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
6121.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
6131.113Sthorpej
6141.134Slukem<bsd.gcc.mk> sets the following variables:
6151.113Sthorpej
6161.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
6171.118Slukem
6181.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
6191.118Slukem
6201.118Slukem_GCC_CRTEND	The full path name to crtend.o.
6211.118Slukem
6221.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
6231.118Slukem
6241.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
6251.118Slukem
6261.118Slukem
6271.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
6281.118Slukem
6291.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
6301.118Slukemvariables:
6311.118Slukem
6321.124SlukemINCS		The list of include files.
6331.118Slukem
6341.118SlukemINCSDIR		The location to install the include files.
6351.118Slukem
6361.118SlukemINCSNAME	Target name of the include file, if only one; same as
6371.118Slukem		FILESNAME, but for include files.
6381.118Slukem
6391.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
6401.134Slukem		are installed in the 'includes' target and not the
6411.134Slukem		(much later) 'install' target.
6421.134Slukem
6431.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
6441.118Slukem		same as FILESNAME_<file>, but for include files.
6451.118Slukem
6461.118Slukem
6471.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
6481.118Slukem
6491.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
6501.118Slukemdocumentation from respective Texinfo source files.  It defines three
6511.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
6521.118Slukemfollowing variables:
6531.118Slukem
6541.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
6551.118Slukem		consist of single files with the extension replaced by
6561.118Slukem		.info.
6571.118Slukem
6581.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
6591.118Slukem
6601.118Slukem
6611.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
6621.118Slukem
6631.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
6641.118Slukemlocation of kernel sources and object directories.
6651.118Slukem
6661.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
6671.124Slukem		[${_SRC_TOP_}/sys]
6681.118Slukem
6691.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
6701.124Slukem		[arch/${MACHINE}]
6711.120Slukem
6721.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
6731.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
6741.118Slukem
6751.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
6761.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
6771.118Slukem		The default value is
6781.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
6791.118Slukem		if it exists or the target 'obj' is being made.
6801.118Slukem		Otherwise the default is
6811.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
6821.118Slukem
6831.118SlukemIt is important that Makefiles (such as those under src/distrib) that
6841.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
6851.118Slukemrather than make assumptions about the location of the compiled kernel.
6861.118Slukem
6871.118Slukem
6881.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
6891.118Slukem
6901.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
6911.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
6921.118Slukeminclude file installation.  It is intended to be included alone, by
6931.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
6941.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
6951.134Slukemin that file up to date.
6961.118Slukem
6971.118Slukem
6981.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
6991.118Slukem
7001.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
7011.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
7021.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
7031.118Slukemwhich checks for installed shared object libraries whose version is greater
7041.118Slukemthat the version of the source. It has a limited number of suffixes,
7051.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
7061.118Slukem<bsd.shlib.mk> to get shared library parameters.
7071.118Slukem
7081.118SlukemIt sets/uses the following variables:
7091.118Slukem
7101.118SlukemLIB		The name of the library to build.
7111.118Slukem
7121.118SlukemLIBDIR		Target directory for libraries.
7131.118Slukem
7141.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
7151.142Slukem		is not "no".
7161.118Slukem
7171.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
7181.118Slukem		as the path to install shared libraries to.
7191.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
7201.130Slukem		Default: no
7211.118Slukem
7221.154SlukemMKPRIVATELIB	If not "no", act as "MKPROFILE=no MKPIC=no MKLINT=no",
7231.154Slukem		and don't install the (.a) library.
7241.154Slukem		This is useful for "build only" helper libraries.
7251.154Slukem		Default: no
7261.154Slukem
7271.118SlukemLINTLIBDIR	Target directory for lint libraries.
7281.118Slukem
7291.118SlukemLIBGRP		Library group.
7301.118Slukem
7311.118SlukemLIBOWN		Library owner.
7321.118Slukem
7331.118SlukemLIBMODE		Library mode.
7341.118Slukem
7351.118SlukemLDADD		Additional loader objects.
7361.118Slukem
7371.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
7381.118Slukem
7391.118SlukemNOCHECKVER_<library>
7401.118SlukemNOCHECKVER	If set, disables checking for installed shared object
7411.118Slukem		libraries with versions greater than the source.  A
7421.118Slukem		particular library name, without the "lib" prefix, may
7431.118Slukem		be appended to the variable name to disable the check for
7441.118Slukem		only that library.
7451.118Slukem
7461.118SlukemSRCS		List of source files to build the library.  Suffix types
7471.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
7481.118Slukem		to .c files of the same name.  (This is not the default for
7491.118Slukem		versions of make.)
7501.118Slukem
7511.157SlukemLIBDPLIBS	A list of the tuples:
7521.157Slukem			libname  path-to-srcdir-of-libname
7531.157Slukem
7541.157Slukem		For each tuple;
7551.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
7561.157Slukem			`libname', and if it is not set it is determined
7571.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
7581.157Slukem			latter is to allow for build time optimization).
7591.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
7601.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
7611.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
7621.157Slukem
7631.157Slukem		This variable may be used for individual libraries, as
7641.157Slukem		well as in parent directories to cache common libraries 
7651.157Slukem		as a build-time optimization.
7661.157Slukem
7671.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
7681.118Slukemif it exists, as well as the include file <bsd.man.mk>.
7691.118Slukem
7701.118SlukemIt has rules for building profiled objects; profiled libraries are
7711.118Slukembuilt by default.
7721.118Slukem
7731.118SlukemLibraries are ranlib'd when made.
7741.118Slukem
7751.118Slukem
7761.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
7771.118Slukem
7781.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
7791.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
7801.134Slukem
7811.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
7821.134Slukem			source-file target-file
7831.134Slukem		${DESTDIR} is prepended to both paths before linking.
7841.134Slukem		For example, to link /bin/test and /bin/[, use:
7851.134Slukem			LINKS=/bin/test /bin/[
7861.134Slukem
7871.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
7881.153Slukem		are installed by the `configinstall' target,
7891.153Slukem		not the `install' target.
7901.153Slukem
7911.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
7921.134Slukem			source-file target-file
7931.134Slukem		${DESTDIR} is only prepended to target-file before linking.
7941.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
7951.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
7961.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
7971.118Slukem
7981.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
7991.153Slukem		are installed by the `configinstall' target,
8001.153Slukem		not the `install' target.
8011.153Slukem
8021.118Slukem
8031.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
8041.118Slukem
8051.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
8061.118Slukemlinks.
8071.118Slukem
8081.118SlukemIt has a two targets:
8091.118Slukem
8101.118Slukem	maninstall:
8111.118Slukem		Install the manual page sources and their links.
8121.118Slukem	catinstall:
8131.118Slukem		Install the preformatted manual pages and their links.
8141.118Slukem
8151.118SlukemIt sets/uses the following variables:
8161.118Slukem
8171.118SlukemMANDIR		Base path for manual installation.
8181.118Slukem
8191.118SlukemMANGRP		Manual group.
8201.118Slukem
8211.118SlukemMANOWN		Manual owner.
8221.118Slukem
8231.118SlukemMANMODE		Manual mode.
8241.118Slukem
8251.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
8261.118Slukem		or "/tahoe" for machine specific manual pages.
8271.118Slukem
8281.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
8291.118Slukem
8301.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
8311.118Slukem		linked-to file must come first, the linked file second,
8321.118Slukem		and there may be multiple pairs.  The files are soft-linked.
8331.118Slukem
8341.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
8351.118Slukemit exists.
8361.118Slukem
8371.118Slukem
8381.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
8391.118Slukem
8401.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
8411.118Slukemand use of separated object and source directories.
8421.118Slukem
8431.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
8441.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
8451.118Slukemit exists.  Otherwise make(1) looks for the existence of a
8461.118Slukemsubdirectory (or a symlink to a directory) of the source directory
8471.118Slukeminto which built targets should be placed.  If an environment variable
8481.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
8491.118Slukemobject directory; failing that, make first looks for a subdirectory
8501.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
8511.118Slukem
8521.118SlukemObject directories are not created automatically by make(1) if they
8531.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
8541.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
8551.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
8561.118Slukemand this is determined by a simple string prefix comparison -- object
8571.118Slukemdirectories are created in a separate object directory tree, and a
8581.118Slukemsymlink to the object directory in that tree is created in the source
8591.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
8601.118Slukemsource tree and that it's not safe to use a separate object tree.
8611.118Slukem
8621.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
8631.118Slukemdirectories and links get created during a "make obj":
8641.118Slukem
8651.118SlukemMAKEOBJDIR	If set, this is the component name of the object
8661.118Slukem		directory.
8671.118Slukem
8681.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
8691.118Slukem		object directories or links named "obj.${MACHINE}";
8701.118Slukem		otherwise, just creates ones named "obj".
8711.118Slukem
8721.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
8731.118Slukem		${BSDSRCDIR}, create object directory in the
8741.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
8751.118Slukem		otherwise, create it in the corresponding subdirectory
8761.118Slukem		of ${BSDOBJDIR}
8771.113Sthorpej
8781.118SlukemBUILDID		If set, the contents of this variable are appended
8791.118Slukem		to the object directory name.  If OBJMACHINE is also
8801.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
8811.113Sthorpej
8821.106Sthorpej
8831.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
8841.106Sthorpej
8851.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
8861.1Scgdmore source files, along with their manual pages.  It has a limited number
8871.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
8881.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
8891.1Scgd
8901.16SjtcIt has eight targets:
8911.1Scgd
8921.1Scgd	all:
8931.102Sthorpej		build the program and its manual page.  This also
8941.102Sthorpej		creates a GDB initialization file (.gdbinit) in
8951.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
8961.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
8971.1Scgd	clean:
8981.1Scgd		remove the program, any object files and the files a.out,
8991.24Smikel		Errs, errs, mklog, and ${PROG}.core.
9001.1Scgd	cleandir:
9011.1Scgd		remove all of the files removed by the target clean, as
9021.1Scgd		well as .depend, tags, and any manual pages.
9031.42Slukem		`distclean' is a synonym for `cleandir'.
9041.1Scgd	depend:
9051.1Scgd		make the dependencies for the source files, and store
9061.1Scgd		them in the file .depend.
9071.16Sjtc	includes:
9081.16Sjtc		install any header files.
9091.1Scgd	install:
9101.1Scgd		install the program and its manual pages; if the Makefile
9111.1Scgd		does not itself define the target install, the targets
9121.1Scgd		beforeinstall and afterinstall may also be used to cause
9131.1Scgd		actions immediately before and after the install target
9141.1Scgd		is executed.
9151.1Scgd	lint:
9161.1Scgd		run lint on the source files
9171.1Scgd	tags:
9181.1Scgd		create a tags file for the source files.
9191.1Scgd
9201.1ScgdIt sets/uses the following variables:
9211.1Scgd
9221.1ScgdBINGRP		Binary group.
9231.1Scgd
9241.1ScgdBINOWN		Binary owner.
9251.1Scgd
9261.1ScgdBINMODE		Binary mode.
9271.1Scgd
9281.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
9291.1Scgd
9301.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
9311.112Sthorpej
9321.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
9331.125Slukem		C objects for <fn>.
9341.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9351.125Slukem
9361.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
9371.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
9381.35Slukem
9391.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
9401.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9411.125Slukem
9421.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
9431.125Slukem
9441.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
9451.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9461.102Sthorpej
9471.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
9481.102Sthorpej		directives in the .gdbinit file that is created in the
9491.102Sthorpej		objdir.
9501.1Scgd
9511.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
9521.1Scgd		For example, to load with the compatibility and utility
9531.1Scgd		libraries, use:
9541.1Scgd
9551.5Sjtc			LDADD+=-lutil -lcompat
9561.1Scgd
9571.178SlukemLDFLAGS		Additional linker flags (passed to ${CC} during link).
9581.1Scgd
9591.134SlukemLINKS		See <bsd.links.mk>
9601.134Slukem
9611.177SmrgOBJCOPTS	Additional flags to the compiler when creating ObjC objects.
9621.177Smrg
9631.177SmrgOBJCOPTS.<fn>	Additional flags to the compiler when creating the
9641.177Smrg		ObjC objects for <fn>.
9651.177Smrg		For <fn>.[ly], "<fn>.c" must be used.
9661.177Smrg
9671.134SlukemSYMLINKS	See <bsd.links.mk>
9681.1Scgd
9691.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
9701.8Scgd		defined, "MAN=${PROG}.1" is assumed.
9711.1Scgd
9721.1ScgdPROG		The name of the program to build.  If not supplied, nothing
9731.1Scgd		is built.
9741.1Scgd
9751.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
9761.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
9771.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
9781.88Sthorpej		the value of PROG if PROG is also set.
9791.87Sthorpej
9801.21SchristosPROGNAME	The name that the above program will be installed as, if
9811.21Schristos		different from ${PROG}.
9821.21Schristos
9831.37StvSRCS		List of source files to build the program.  If SRCS is not
9841.1Scgd		defined, it's assumed to be ${PROG}.c.
9851.108Sjwise
9861.108SjwiseDPSRCS		List of source files which are needed for generating
9871.108Sjwise		dependencies, but are not needed in ${SRCS}.
9881.1Scgd
9891.1ScgdDPADD		Additional dependencies for the program.  Usually used for
9901.1Scgd		libraries.  For example, to depend on the compatibility and
9911.1Scgd		utility libraries use:
9921.1Scgd
9931.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
9941.1Scgd
9951.1Scgd		The following libraries are predefined for DPADD:
9961.1Scgd
9971.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
9981.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
9991.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
10001.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
10011.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
10021.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
10031.99Sitojun		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
10041.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
10051.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
10061.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
10071.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
10081.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
10091.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
10101.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
10111.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
10121.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
10131.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
10141.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
10151.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
10161.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
10171.159Slukem		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
10181.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
10191.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
10201.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
10211.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
10221.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
10231.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
10241.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
10251.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
10261.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
10271.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
10281.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
10291.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
10301.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
10311.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
10321.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
10331.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
10341.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
10351.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
10361.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
10371.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
10381.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
10391.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
10401.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
10411.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
10421.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
10431.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
10441.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
10451.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
10461.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
10471.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
10481.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
10491.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
10501.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
10511.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
10521.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
10531.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
10541.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
10551.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
10561.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
10571.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
10581.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
10591.1Scgd
10601.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
10611.12Schristos		strings, using xstr(1). Note that this will not work with
10621.12Schristos		parallel makes.
10631.1Scgd
10641.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
10651.1Scgd		to be stripped.
10661.1Scgd
10671.1ScgdSUBDIR		A list of subdirectories that should be built as well.
10681.1Scgd		Each of the targets will execute the same target in the
10691.1Scgd		subdirectories.
10701.1Scgd
10711.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
10721.21Schristos		These are installed exactly like programs.
10731.21Schristos
10741.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
10751.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
10761.166Srtr
10771.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
10781.21Schristos		different from ${SCRIPTS}. These can be further specialized
10791.21Schristos		by setting SCRIPTSNAME_<script>.
10801.21Schristos
10811.124SlukemFILES		See description of <bsd.files.mk>.
10821.21Schristos
10831.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
10841.106Sthorpej		<bsd.own.mk> for additional information about this variable.
10851.130Slukem
10861.130SlukemUSE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
10871.130Slukem		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
10881.130Slukem		Default: yes
10891.85Slukem
10901.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
10911.1Scgdif it exists, as well as the include file <bsd.man.mk>.
10921.1Scgd
10931.1ScgdSome simple examples:
10941.1Scgd
10951.1ScgdTo build foo from foo.c with a manual page foo.1, use:
10961.1Scgd
10971.1Scgd	PROG=	foo
10981.1Scgd
10991.1Scgd	.include <bsd.prog.mk>
11001.1Scgd
11011.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
11021.1Scgd
11031.9Scgd	MAN=	foo.2
11041.1Scgd
11051.1ScgdIf foo does not have a manual page at all, add the line:
11061.1Scgd
11071.75Sagc	MKMAN=	no
11081.1Scgd
11091.1ScgdIf foo has multiple source files, add the line:
11101.1Scgd
11111.1Scgd	SRCS=	a.c b.c c.c d.c
11121.1Scgd
11131.1Scgd
11141.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
11151.118Slukem
11161.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
11171.118Slukemconstruct source files built by rpcgen.
11181.72Ssommerfe
11191.118SlukemThe following macros may be defined in makefiles which include
11201.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
11211.118Slukemare to be built:
11221.21Schristos
11231.118SlukemRPC_INCS:	construct .h file from .x file
11241.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
11251.118Slukem		(for marshalling/unmarshalling data types)
11261.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
11271.118Slukem		(server-side stubs)
11281.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
11291.21Schristos
11301.118SlukemRPC_XDIR:	Directory containing .x/.h files
11311.23Schristos
11321.23Schristos
11331.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
11341.21Schristos
11351.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
11361.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
11371.134Slukemincluded before <bsd.shlib.mk>.
11381.21Schristos
11391.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
11401.118Slukem(defaults are in brackets):
11411.21Schristos
11421.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
11431.142Slukem		instead of ${LIBDIR} as the base path for shared library
11441.142Slukem		installation.  [/lib]
11451.21Schristos
11461.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
11471.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
11481.118Slukem		for all others.]
11491.81Swiz
11501.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
11511.118Slukem		otherwise set to ${LIBDIR}
11521.81Swiz
11531.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
11541.39Scgd
11551.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
11561.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
11571.118Slukem		all others.]
11581.39Scgd
11591.13Schristos
11601.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
11611.13Schristos
11621.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
11631.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
11641.118Slukemclean, cleandir, depend, includes, install, lint, and tags.  For all of
11651.142Slukemthe directories listed in ${SUBDIR}, the specified directory will be
11661.142Slukemvisited and the target made.  There is also a default target which allows
11671.142Slukemthe command "make subdir" where subdir is any directory listed in ${SUBDIR}.
11681.47Stv
11691.118SlukemAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
11701.118Slukemas a synchronization barrier when multiple make jobs are run; subdirs
11711.118Slukembefore the .WAIT must complete before any subdirs after .WAIT are
11721.118Slukemstarted.  See make(1) for some caveats on use of .WAIT and other
11731.118Slukemspecial sources.
11741.47Stv
11751.47Stv
11761.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
11771.47Stv
11781.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
11791.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
11801.133Slukemthe NetBSD source tree.
11811.133Slukem
11821.133SlukemThe following variables control how various files are compiled/built.
11831.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
11841.133Slukem
11851.133SlukemAR		Create, modify, and extract from archives.  [ar]
11861.133Slukem
11871.133SlukemARFLAGS		Options to ${AR}.  [rl]
11881.133Slukem
11891.151SlukemAS		Assembler.  [as]
11901.151Slukem
11911.151SlukemAFLAGS		Options to ${AS}.  []
11921.151Slukem
11931.133SlukemCC		C compiler.  [cc]
11941.133Slukem
11951.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
11961.133Slukem
11971.133SlukemCPP		C Pre-Processor.  [cpp]
11981.133Slukem
11991.133SlukemCPPFLAGS	Options to ${CPP}.  []
12001.133Slukem
12011.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
12021.133Slukem
12031.133SlukemCXX		C++ compiler.  [c++]
12041.133Slukem
12051.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
12061.133Slukem
12071.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
12081.133Slukem
12091.133SlukemFC		Fortran compiler.  [f77]
12101.133Slukem
12111.133SlukemFFLAGS		Options to {$FC}.  [-O]
12121.133Slukem
12131.133SlukemINSTALL		install(1) command.  [install]
12141.133Slukem
12151.133SlukemLEX		Lexical analyzer.  [lex]
12161.133Slukem
12171.133SlukemLFLAGS		Options to ${LEX}.  []
12181.133Slukem
12191.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
12201.145Sjwise
12211.133SlukemLD		Linker.  [ld]
12221.133Slukem
12231.178SlukemLDFLAGS		Options to ${CC} during the link process.  []
12241.133Slukem
12251.133SlukemLINT		C program verifier.  [lint]
12261.133Slukem
12271.173SperryLINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
12281.133Slukem
12291.133SlukemLORDER		List dependencies for object files.  [lorder]
12301.133Slukem
12311.133SlukemMAKE		make(1).  [make]
12321.133Slukem
12331.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
12341.133Slukem
12351.133SlukemNM		List symbols from object files.  [nm]
12361.133Slukem
12371.133SlukemPC		Pascal compiler.  [pc]  (Not present)
12381.133Slukem
12391.133SlukemPFLAGS		Options to ${PC}.  []
12401.133Slukem
12411.133SlukemOBJC		Objective C compiler.  [${CC}]
12421.133Slukem
12431.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
12441.133Slukem
12451.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
12461.133Slukem
12471.168SrizOBJDUMP		Display information from object files.  [objdump]
12481.168Sriz
12491.133SlukemRANLIB		Generate index to archive.  [ranlib]
12501.133Slukem
12511.133SlukemSHELL		Shell.  [sh]
12521.133Slukem
12531.133SlukemSIZE		List section sizes and total size.  [size]
12541.133Slukem
12551.133SlukemSTRIP		Discard symbols from object files.  [strip]
12561.133Slukem
12571.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
12581.133Slukem
12591.133SlukemYACC		LALR(1) parser generator.  [yacc]
12601.133Slukem
12611.133SlukemYFLAGS		Options to ${YACC}.  []
12621.133Slukem
12631.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
12641.133Slukem		from <file>.y to <file>.h and <file>.c, and add
12651.133Slukem		<foo>.h to CLEANFILES.
12661.133Slukem
12671.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
12681.133Slukem
12691.116Slukem
12701.116SlukemThe following variables are defined to commands to perform the
12711.116Slukemappropriate operation, with the default in [brackets].
12721.142Slukem(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
12731.116Slukem
12741.116SlukemTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
12751.116Slukem
12761.116SlukemTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
12771.116Slukem
12781.116SlukemTOOL_CAT		Concatenate and print files.  [cat]
12791.116Slukem
12801.116SlukemTOOL_CKSUM		Display file checksums.  [cksum]
12811.116Slukem
12821.116SlukemTOOL_COMPILE_ET		Error table compiler.  [compile_et]
12831.116Slukem
12841.116SlukemTOOL_CONFIG		Build kernel compilation directories.  [config]
12851.116Slukem
12861.116SlukemTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
12871.116Slukem
12881.116SlukemTOOL_CTAGS		Create a tags file.  [ctags]
12891.116Slukem
12901.116SlukemTOOL_DB			Manipulate db(3) databases.  [db]
12911.116Slukem
12921.116SlukemTOOL_EQN		Format equations for groff.  [eqn]
12931.116Slukem
12941.116SlukemTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
12951.116Slukem
12961.169SthorpejTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
12971.169Sthorpej
12981.116SlukemTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
12991.116Slukem
13001.116SlukemTOOL_GROFF		Front end for groff document formatting system.  [groff]
13011.116Slukem
13021.116SlukemTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
13031.116Slukem
13041.116SlukemTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
13051.116Slukem
13061.116SlukemTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
13071.116Slukem
13081.116SlukemTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
13091.116Slukem
13101.116SlukemTOOL_M4			M4 macro language processor.  [m4]
13111.116Slukem
13121.116SlukemTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
13131.116Slukem
13141.116SlukemTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
13151.116Slukem
13161.116SlukemTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
13171.116Slukem
13181.116SlukemTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
13191.116Slukem
13201.116SlukemTOOL_MENUC		Menu compiler.  [menuc]
13211.116Slukem
13221.116SlukemTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
13231.116Slukem
13241.116SlukemTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
13251.116Slukem
13261.116SlukemTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
13271.116Slukem
13281.116SlukemTOOL_MKMAGIC		Create database for file(1).  [file]
13291.116Slukem
13301.116SlukemTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
13311.116Slukem
13321.116SlukemTOOL_MSGC		Simple message list compiler.  [msgc]
13331.116Slukem
13341.116SlukemTOOL_MTREE		Map a directory hierarchy.  [mtree]
13351.116Slukem
13361.116SlukemTOOL_PAX		Manipulate file archives and copy directories.  [pax]
13371.116Slukem
13381.116SlukemTOOL_PIC		Compile pictures for groff.  [pic]
13391.116Slukem
13401.116SlukemTOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
13411.116Slukem
13421.116SlukemTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
13431.116Slukem
13441.116SlukemTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
13451.116Slukem
13461.116SlukemTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
13471.116Slukem
13481.116SlukemTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
13491.116Slukem
13501.116SlukemTOOL_ROFF_HTML		Generate HTML groff output.
13511.119Slukem			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
13521.116Slukem
13531.116SlukemTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
13541.116Slukem
13551.116SlukemTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
13561.116Slukem
13571.116SlukemTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
13581.116Slukem
13591.116SlukemTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
13601.123Slukem
13611.123SlukemTOOL_STAT		Display file status.  [stat]
13621.116Slukem
13631.116SlukemTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
13641.116Slukem
13651.116SlukemTOOL_TBL		Format tables for groff.  [tbl]
13661.116Slukem
13671.116SlukemTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
13681.116Slukem
13691.116SlukemTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
13701.116Slukem
13711.116SlukemTOOL_ZIC		Time zone compiler.  [zic]
13721.116Slukem
13731.69Ssommerfe
13741.69SsommerfeOther variables of note (incomplete list):
13751.69Ssommerfe
13761.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
13771.82Slukem			WARNS=1
13781.82Slukem			WARNS=2
13791.82Slukem			WARNS=3
13801.164Smatt			WARNS=4
13811.69Ssommerfe
13821.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
13831.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
13841.75Sagc		WFORMAT belongs in individual makefiles and/or
13851.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
13861.75Sagc		makefiles if a program is not security critical and is
13871.75Sagc		doing bizarre things with format strings which would
13881.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
13891.120Slukem		mk.conf if you're doing format-string auditing.
13901.69Ssommerfe		FORMAT_AUDIT may go away in time.
13911.30Sagc
13921.144Slukem
13931.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
13941.144Slukem
13951.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
13961.144Slukemcross-building X11R6 from ${X11SRCDIR.xc}.
13971.144SlukemIt should be included after the general Makefile contents but before
13981.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
13991.144Slukem
14001.144SlukemIt provides the following targets:
14011.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
14021.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
14031.144Slukem		these rules convert from X11R6's manual page source
14041.144Slukem		into an mdoc.old source file.
14051.144Slukem	cleanx11man:
14061.144Slukem		Clean up the mdoc.old files generated by the above.
14071.144Slukem
14081.144SlukemIt sets the following variables:
14091.144Slukem
14101.144SlukemBINDIR			Set to ${X11BINDIR}.
14111.144Slukem			To override, define after including <bsd.x11.mk>
14121.144Slukem
14131.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
14141.144Slukem			To override, define after including <bsd.x11.mk>
14151.144Slukem
14161.144SlukemMANDIR			Set to ${X11MANDIR}.
14171.144Slukem			To override, define after including <bsd.x11.mk>
14181.144Slukem
14191.144SlukemCPPFLAGS		Appended with definitions to include from
14201.144Slukem			${DESTDIR}${X11INCDIR}
14211.144Slukem
14221.144SlukemLDFLAGS			Appended with definitions to link from
14231.144Slukem			${DESTDIR}${X11USRLIBDIR}
14241.144Slukem
14251.144SlukemX11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
14261.144Slukem
14271.144SlukemX11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
14281.144Slukem
14291.144SlukemX11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
14301.144Slukem
14311.144SlukemX11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
14321.144Slukem
14331.144SlukemX11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
14341.144Slukem
14351.144SlukemX11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
14361.144Slukem
14371.144SlukemX11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
14381.144Slukem
14391.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
14401.144Slukem
14411.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
14421.144Slukem
14431.144SlukemIt uses the following variables:
14441.144Slukem
14451.144SlukemAPPDEFS			List of app-default files to install.
14461.144Slukem
14471.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
14481.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
14491.144Slukem			have a `.cpp' suffix, the generated files do not.
14501.144Slukem
14511.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
14521.144Slukem
14531.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
14541.144Slukem
14551.144Slukem
14561.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1457