bsd.README revision 1.175
11.175Schristos#	$NetBSD: bsd.README,v 1.175 2006/03/20 21:25:31 christos 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.172ShubertfMKDOC		If "no", don't build or install the documentation.
1301.172Shubertf		Default: yes
1311.172Shubertf
1321.172ShubertfMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1331.172Shubertf		don't install certain libraries in /lib, and don't
1341.172Shubertf		install the shared linker into /libexec.
1351.172Shubertf		Default: yes
1361.172Shubertf
1371.172ShubertfMKGCC		If "no", don't build gcc(1) or any of the gcc-related
1381.172Shubertf		libraries (libg2c, libgcc, libobjc, libstdc++).
1391.172Shubertf		Default: yes
1401.172Shubertf
1411.172ShubertfMKGCCCMDS	If "no", don't build gcc(1).
1421.172Shubertf		Default: yes
1431.172Shubertf
1441.172ShubertfMKGDB		If "no", don't build gdb(1).
1451.172Shubertf		Default: yes
1461.172Shubertf
1471.172ShubertfMKHESIOD	If "no", disables building of Hesiod infrastructure
1481.172Shubertf		(libraries and support programs).
1491.172Shubertf		Default: yes
1501.172Shubertf
1511.172ShubertfMKHOSTOBJ	If not "no", for programs intended to be run on the compile
1521.172Shubertf		host, the name, release, and architecture of the host
1531.172Shubertf		operating system will be suffixed to the name of the object
1541.172Shubertf		directory created by "make obj".
1551.172Shubertf		Default: no
1561.172Shubertf
1571.172ShubertfMKHTML		If "no", don't build or install the html man pages.
1581.172Shubertf		Default: no
1591.172Shubertf
1601.172ShubertfMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
1611.172Shubertf		Has no effect on most platforms.
1621.172Shubertf		Default: yes
1631.172Shubertf
1641.172ShubertfMKINET6		If "no", disables building of INET6 (IPv6) infrastructure
1651.172Shubertf		(libraries and support programs).
1661.172Shubertf		Default: yes
1671.172Shubertf
1681.172ShubertfMKINFO		If "no", don't build or install Info documentation from
1691.172Shubertf		Texinfo source files.
1701.172Shubertf		Default: yes
1711.172Shubertf
1721.172ShubertfMKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
1731.172Shubertf		Default: yes
1741.172Shubertf
1751.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
1761.172Shubertf		infrastructure (libraries and support programs).
1771.172Shubertf		Default: yes
1781.172Shubertf
1791.172ShubertfMKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
1801.172Shubertf		Also:
1811.172Shubertf			- don't install the .a libraries
1821.172Shubertf			- don't install _pic.a libraries on PIC systems
1831.172Shubertf			- don't build .a libraries on PIC systems
1841.172Shubertf			- don't install the .so symlink on ELF systems
1851.172Shubertf		I.e, only install the shared library (and the .so.major
1861.172Shubertf		symlink on ELF).
1871.172Shubertf		Default: yes
1881.172Shubertf
1891.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
1901.172Shubertf		Default: yes
1911.172Shubertf
1921.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
1931.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
1941.172Shubertf		Default: yes
1951.172Shubertf
1961.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
1971.172Shubertf		Default: no
1981.172Shubertf
1991.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2001.172Shubertf		definition files.
2011.172Shubertf		Default: yes
2021.172Shubertf
2031.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2041.172Shubertf		and also acts as "MKOBJDIRS=no".
2051.172Shubertf		Default: yes
2061.172Shubertf
2071.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
2081.172Shubertf		Default: no
2091.172Shubertf
2101.172ShubertfMKPAM		If "no", disables building of PAM authentication
2111.172Shubertf		infrastructure (libraries and support programs).
2121.172Shubertf		Default: no
2131.172Shubertf
2141.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
2151.172Shubertf		Default: yes
2161.172Shubertf
2171.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
2181.172Shubertf		also acts as "MKPICLIB=no"
2191.172Shubertf		Default: yes (for MACHINE_ARCHs that support it) 
2201.172Shubertf
2211.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2221.172Shubertf		Default: yes
2231.172Shubertf
2241.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2251.172Shubertf		shared object libraries from the .a libraries.
2261.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
2271.172Shubertf		_pic.a library pointing to the .a library.
2281.172Shubertf		Default: yes
2291.172Shubertf
2301.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
2311.172Shubertf		Default: yes
2321.172Shubertf
2331.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
2341.172Shubertf		Default: yes
2351.172Shubertf
2361.172ShubertfMKSENDMAIL	If "no", don't build or install sendmail(8).
2371.172Shubertf		Default: yes
2381.172Shubertf
2391.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
2401.172Shubertf		MKMAN=no MKNLS=no".
2411.172Shubertf		I.e, don't build catman pages, documentation, Info
2421.172Shubertf		documentation, man pages, NLS files, ...
2431.172Shubertf		Default: yes
2441.172Shubertf
2451.172ShubertfMKSKEY		If "no", disables building of S/key authentication
2461.172Shubertf		infrastructure (libraries and support programs).
2471.172Shubertf		Default: yes
2481.172Shubertf
2491.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
2501.172Shubertf		generate output containing library calls for floating
2511.172Shubertf		point and possibly soft-float library support.
2521.172Shubertf		Default: no
2531.172Shubertf
2541.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
2551.172Shubertf		libraries.
2561.172Shubertf		Default: yes
2571.172Shubertf
2581.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
2591.172Shubertf		files or directories, and keep a metadata log of what
2601.172Shubertf		the owner/group/mode should be.  This allows a
2611.172Shubertf		non-root "make install".
2621.172Shubertf		Default: no
2631.172Shubertf
2641.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
2651.172Shubertf		more recently modified in the source directories that their
2661.172Shubertf		installed counterparts.
2671.172Shubertf		Default: no
2681.172Shubertf
2691.172ShubertfMKUUCP		If "no", don't build or install uucp(1).
2701.172Shubertf		Default: yes
2711.172Shubertf
2721.172ShubertfMKX11		If not "no", 'make build' also descends into src/x11
2731.172Shubertf		to cross build X11R6 and automatically enables creation
2741.172Shubertf		of X sets.
2751.172Shubertf		Default: no
2761.172Shubertf
2771.172ShubertfMKYP		If "no", disables building of YP (NIS)
2781.172Shubertf		infrastructure (libraries and support programs).
2791.172Shubertf		Default: yes
2801.172Shubertf
2811.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
2821.172Shubertf		various system utilities/libraries that support it.
2831.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
2841.172Shubertf		forced to "no".
2851.172Shubertf
2861.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
2871.172Shubertf		various system utilities/libraries that support it.
2881.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
2891.172Shubertf		forced to "no".
2901.172Shubertf
2911.175SchristosUSE_KERBEROS	If "no", disables building Kerberos v5
2921.172Shubertf		support into various system utilities/libraries that
2931.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
2941.172Shubertf		will also be forced to "no".
2951.172Shubertf
2961.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
2971.172Shubertf		into various system utilities/libraries that support it.
2981.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
2991.172Shubertf
3001.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
3011.172Shubertf		support into various system utilities/libraries that
3021.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
3031.172Shubertf		also be forced to "no".
3041.172Shubertf
3051.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
3061.172Shubertf		various system utilities/libraries that support it.
3071.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
3081.172Shubertf
3091.172ShubertfCOPTS.lib<lib>
3101.172ShubertfLDADD.lib<lib>
3111.172ShubertfCPPFLAGS.lib<lib>
3121.172ShubertfCXXFLAGS.lib<lib>
3131.172ShubertfCOPTS.<prog>
3141.172ShubertfLDADD.<prog>
3151.172ShubertfCPPFLAGS.<prog>
3161.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
3171.172Shubertf		variables in a way that applies only to a particular library
3181.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
3191.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
3201.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
3211.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
3221.172Shubertf		the crypto library.
3231.118Slukem
3241.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
3251.1Scgd
3261.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
3271.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
3281.1Scgd
3291.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
3301.1Scgd
3311.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
3321.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
3331.17Sthorpeja few global "feature configuration" parameters.
3341.1Scgd
3351.1ScgdIt has no targets.
3361.1Scgd
3371.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
3381.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
3391.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
3401.29Scjsis included.  These files may define any of the variables described below.
3411.17Sthorpej
3421.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
3431.17Sthorpej(defaults are in brackets):
3441.15Scgd
3451.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
3461.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
3471.98Slukem		otherwise BSDSRCDIR will be used as the default.
3481.98Slukem		Various makefiles within the NetBSD source tree will
3491.98Slukem		use this to reference the top level of the source tree.
3501.98Slukem
3511.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
3521.98Slukem		based on the presence of tools/ and build.sh.  This variable
3531.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
3541.98Slukem		determined once and then propagated to all sub-makes.
3551.95Slukem
3561.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
3571.116Slukem		will work correctly.  [/usr/src]
3581.15Scgd
3591.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
3601.116Slukem		will work correctly.  [/usr/obj]
3611.15Scgd
3621.116SlukemBINGRP		Binary group.  [wheel]
3631.15Scgd
3641.116SlukemBINOWN		Binary owner.  [root]
3651.15Scgd
3661.116SlukemBINMODE		Binary mode.  [555]
3671.15Scgd
3681.116SlukemNONBINMODE	Mode for non-executable files.  [444]
3691.15Scgd
3701.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
3711.15Scgd
3721.116SlukemMANGRP		Manual group.  [wheel]
3731.15Scgd
3741.116SlukemMANOWN		Manual owner.  [root]
3751.15Scgd
3761.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
3771.15Scgd
3781.21SchristosMANINSTALL	Manual installation type: maninstall, catinstall, or both
3791.155Sjmc		[maninstall catinstall]
3801.76Sfair
3811.76SfairLDSTATIC	Control program linking; if set blank, link everything
3821.129Slukem		dynamically.  If set to "-static", link everything statically.
3831.76Sfair		If not set, programs link according to their makefile.
3841.21Schristos
3851.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
3861.15Scgd
3871.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
3881.15Scgd
3891.116SlukemLIBGRP		Library group.  [${BINGRP}]
3901.15Scgd
3911.116SlukemLIBOWN		Library owner.  [${BINOWN}]
3921.15Scgd
3931.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
3941.15Scgd
3951.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
3961.116Slukem	        installation.  [/usr/share/doc]
3971.62Ssimonb
3981.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
3991.62Ssimonb		[/usr/share/doc/html]
4001.15Scgd
4011.116SlukemDOCGRP		Documentation group.  [wheel]
4021.15Scgd
4031.116SlukemDOCOWN		Documentation owner.  [root]
4041.15Scgd
4051.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
4061.15Scgd
4071.84SkleinkNLSDIR		Base path for Native Language Support files installation.
4081.15Scgd		[/usr/share/nls]
4091.1Scgd
4101.116SlukemNLSGRP		Native Language Support files group.  [wheel]
4111.1Scgd
4121.116SlukemNLSOWN		Native Language Support files owner.  [root]
4131.1Scgd
4141.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
4151.1Scgd
4161.144SlukemX11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
4171.144Slukem
4181.144SlukemX11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
4191.144Slukem
4201.144SlukemX11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
4211.144Slukem
4221.144SlukemX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
4231.144Slukem
4241.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
4251.144Slukem
4261.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
4271.144Slukem
4281.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
4291.144Slukem
4301.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
4311.144Slukem
4321.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
4331.144Slukem
4341.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
4351.144Slukem
4361.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
4371.1Scgd		to be stripped.  This is to be used when building your
4381.1Scgd		own install script so that the entire system can be made
4391.146Slukem		stripped/not-stripped using a single knob.  []
4401.1Scgd
4411.2ScgdCOPY		The flag passed to the install program to cause the binary
4421.2Scgd		to be copied rather than moved.  This is to be used when
4431.2Scgd		building our own install script so that the entire system
4441.2Scgd		can either be installed with copies, or with moves using
4451.116Slukem		a single knob.  [-c]
4461.15Scgd
4471.150SlukemMAKEDIRTARGET dir target [params]
4481.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
4491.150Slukem		displaying a "pretty" message whilst doing so.
4501.150Slukem
4511.152SclRELEASEMACHINEDIR
4521.152Scl		Subdirectory used below RELEASEDIR when building
4531.152Scl		a release.  [${MACHINE}]
4541.152Scl
4551.152SclRELEASEMACHINE	Subdirectory or path component used for the following
4561.152Scl		paths:
4571.152Scl			distrib/${RELEASEMACHINE}
4581.152Scl			distrib/notes/${RELEASEMACHINE}
4591.152Scl			etc/etc.${RELEASEMACHINE}
4601.152Scl		Used when building a release.  [${MACHINE}]
4611.150Slukem
4621.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
4631.17Sthorpejmake configuration file to modify the behaviour of the system build
4641.17Sthorpejprocess (default values are in brackets along with comments, if set by
4651.134Slukem<bsd.own.mk>):
4661.33Sjonathan
4671.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
4681.172Shubertf		be used as part of a build in progress.
4691.172Shubertf		Supported values:
4701.172Shubertf
4711.172Shubertf		yes	Use the tools from TOOLDIR.
4721.172Shubertf			Must be set to this if cross-compiling.
4731.172Shubertf
4741.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
4751.172Shubertf			build native compilation tool components that are
4761.172Shubertf			version-specific for that tool.
4771.172Shubertf
4781.172Shubertf		never	Do not use the tools from TOOLDIR, even when
4791.172Shubertf			building native tool components.  This is similar to
4801.172Shubertf			the traditional NetBSD build method, but does not
4811.172Shubertf			verify that the compilation tools in use are
4821.172Shubertf			up-to-date enough in order to build the tree
4831.172Shubertf			successfully.  This may cause build or runtime
4841.172Shubertf			problems when building the whole NetBSD source tree.
4851.172Shubertf
4861.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
4871.172Shubertf		source tree (detected automatically); "no" otherwise
4881.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
4891.172Shubertf		make(1) include files).
4901.142Slukem
4911.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
4921.156Stron		use ELF -- currently all architectures but ns32k, set to
4931.156Stron		"a.out" on ns32k].
4941.33Sjonathan
4951.103SthorpejTOOLCHAIN_MISSING
4961.142Slukem		If not "no", this indicates that the platform being built
4971.103Sthorpej		does not have a working in-tree toolchain.  If the
4981.142Slukem		${MACHINE_ARCH} in question falls into this category,
4991.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
5001.103Sthorpej		Otherwise, the variable is unconditionally assigned the
5011.103Sthorpej		value "no".
5021.142Slukem		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
5031.142Slukem		unconditionally assigned the value "no".
5041.103Sthorpej
5051.103SthorpejEXTERNAL_TOOLCHAIN
5061.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
5071.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
5081.103Sthorpej		access to this variable.  The variable should be defined
5091.103Sthorpej		either in the user's environment or in the user's mk.conf
5101.103Sthorpej		file.  If defined, this variable indicates the root of
5111.103Sthorpej		an external toolchain which will be used to build the
5121.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
5131.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
5141.103Sthorpej		cross-compile framework.
5151.103Sthorpej
5161.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
5171.142Slukem		assigned the value "no", since the external version of the
5181.142Slukem		compiler may not be able to build the library components of
5191.142Slukem		the in-tree compiler.
5201.103Sthorpej
5211.103Sthorpej		NOTE: This variable is not yet used in as many places as
5221.103Sthorpej		it should be.  Expect the exact semantics of this variable
5231.103Sthorpej		to change in the short term as parts of the cross-compile
5241.103Sthorpej		framework continue to be cleaned up.
5251.1Scgd
5261.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
5271.1Scgdthey use the same default owners etc. as the rest of the tree.
5281.131Slukem
5291.131Slukem
5301.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
5311.131Slukem
5321.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
5331.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
5341.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
5351.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
5361.133Slukemdependencies for the .d files.  In order for this to function correctly,
5371.132Slukemit should be .included after all other .mk files and directives that may
5381.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
5391.132Slukem
5401.132SlukemSRCS		List of source files to build the program.
5411.132Slukem
5421.132SlukemDPSRCS		List of source files which are needed for generating
5431.132Slukem		dependencies, but are not needed in ${SRCS}.
5441.1Scgd
5451.1Scgd
5461.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
5471.106Sthorpej
5481.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
5491.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
5501.124Slukem
5511.124SlukemFILES		The list of files to install.
5521.124Slukem
5531.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
5541.153Slukem		are installed by the `configinstall' target,
5551.153Slukem		not the `install' target.
5561.153Slukem		The FILES* variables documented below also apply.
5571.153Slukem
5581.124SlukemFILESOWN	File owner.  [${BINOWN}]
5591.124Slukem
5601.124SlukemFILESGRP	File group.  [${BINGRP}]
5611.124Slukem
5621.124SlukemFILESMODE	File mode.  [${BINMODE}]
5631.124Slukem
5641.124SlukemFILESDIR	The location to install the files.
5651.124Slukem
5661.124SlukemFILESNAME	Optional name to install each file as.
5671.124Slukem
5681.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
5691.153Slukem
5701.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
5711.153Slukem
5721.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
5731.153Slukem
5741.153SlukemFILESDIR_<fn>	The location to install the specific file <fn>>
5751.153Slukem
5761.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
5771.124Slukem
5781.135Slukem
5791.139SlukemBUILDSYMLINKS	List of two word items:
5801.135Slukem			lnsrc lntgt
5811.135Slukem		For each lnsrc item, create a symlink named lntgt.
5821.135Slukem		The lntgt symlinks are removed by the cleandir target.
5831.106Sthorpej
5841.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
5851.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
5861.148Sjmc		The source files have a `.uue' suffix, the generated files do 
5871.148Sjmc		not.
5881.149Sjmc
5891.149SjmcUUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
5901.148Sjmc		
5911.148Sjmc		*NOTE: These files are simply decoded, with no install or other
5921.148Sjmc		       rule applying implicitly except being added to the clean
5931.148Sjmc		       target.
5941.106Sthorpej
5951.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
5961.113Sthorpej
5971.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
5981.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
5991.134Slukembefore <bsd.gcc.mk>.
6001.113Sthorpej
6011.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
6021.113Sthorpejof which need to know where to find certain GCC support libraries.
6031.113Sthorpej
6041.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
6051.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
6061.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
6071.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
6081.113Sthorpej
6091.134Slukem<bsd.gcc.mk> sets the following variables:
6101.113Sthorpej
6111.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
6121.118Slukem
6131.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
6141.118Slukem
6151.118Slukem_GCC_CRTEND	The full path name to crtend.o.
6161.118Slukem
6171.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
6181.118Slukem
6191.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
6201.118Slukem
6211.118Slukem
6221.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
6231.118Slukem
6241.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
6251.118Slukemvariables:
6261.118Slukem
6271.124SlukemINCS		The list of include files.
6281.118Slukem
6291.118SlukemINCSDIR		The location to install the include files.
6301.118Slukem
6311.118SlukemINCSNAME	Target name of the include file, if only one; same as
6321.118Slukem		FILESNAME, but for include files.
6331.118Slukem
6341.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
6351.134Slukem		are installed in the 'includes' target and not the
6361.134Slukem		(much later) 'install' target.
6371.134Slukem
6381.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
6391.118Slukem		same as FILESNAME_<file>, but for include files.
6401.118Slukem
6411.118Slukem
6421.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
6431.118Slukem
6441.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
6451.118Slukemdocumentation from respective Texinfo source files.  It defines three
6461.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
6471.118Slukemfollowing variables:
6481.118Slukem
6491.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
6501.118Slukem		consist of single files with the extension replaced by
6511.118Slukem		.info.
6521.118Slukem
6531.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
6541.118Slukem
6551.118Slukem
6561.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
6571.118Slukem
6581.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
6591.118Slukemlocation of kernel sources and object directories.
6601.118Slukem
6611.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
6621.124Slukem		[${_SRC_TOP_}/sys]
6631.118Slukem
6641.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
6651.124Slukem		[arch/${MACHINE}]
6661.120Slukem
6671.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
6681.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
6691.118Slukem
6701.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
6711.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
6721.118Slukem		The default value is
6731.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
6741.118Slukem		if it exists or the target 'obj' is being made.
6751.118Slukem		Otherwise the default is
6761.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
6771.118Slukem
6781.118SlukemIt is important that Makefiles (such as those under src/distrib) that
6791.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
6801.118Slukemrather than make assumptions about the location of the compiled kernel.
6811.118Slukem
6821.118Slukem
6831.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
6841.118Slukem
6851.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
6861.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
6871.118Slukeminclude file installation.  It is intended to be included alone, by
6881.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
6891.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
6901.134Slukemin that file up to date.
6911.118Slukem
6921.118Slukem
6931.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
6941.118Slukem
6951.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
6961.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
6971.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
6981.118Slukemwhich checks for installed shared object libraries whose version is greater
6991.118Slukemthat the version of the source. It has a limited number of suffixes,
7001.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
7011.118Slukem<bsd.shlib.mk> to get shared library parameters.
7021.118Slukem
7031.118SlukemIt sets/uses the following variables:
7041.118Slukem
7051.118SlukemLIB		The name of the library to build.
7061.118Slukem
7071.118SlukemLIBDIR		Target directory for libraries.
7081.118Slukem
7091.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
7101.142Slukem		is not "no".
7111.118Slukem
7121.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
7131.118Slukem		as the path to install shared libraries to.
7141.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
7151.130Slukem		Default: no
7161.118Slukem
7171.154SlukemMKPRIVATELIB	If not "no", act as "MKPROFILE=no MKPIC=no MKLINT=no",
7181.154Slukem		and don't install the (.a) library.
7191.154Slukem		This is useful for "build only" helper libraries.
7201.154Slukem		Default: no
7211.154Slukem
7221.118SlukemLINTLIBDIR	Target directory for lint libraries.
7231.118Slukem
7241.118SlukemLIBGRP		Library group.
7251.118Slukem
7261.118SlukemLIBOWN		Library owner.
7271.118Slukem
7281.118SlukemLIBMODE		Library mode.
7291.118Slukem
7301.118SlukemLDADD		Additional loader objects.
7311.118Slukem
7321.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
7331.118Slukem
7341.118SlukemNOCHECKVER_<library>
7351.118SlukemNOCHECKVER	If set, disables checking for installed shared object
7361.118Slukem		libraries with versions greater than the source.  A
7371.118Slukem		particular library name, without the "lib" prefix, may
7381.118Slukem		be appended to the variable name to disable the check for
7391.118Slukem		only that library.
7401.118Slukem
7411.118SlukemSRCS		List of source files to build the library.  Suffix types
7421.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
7431.118Slukem		to .c files of the same name.  (This is not the default for
7441.118Slukem		versions of make.)
7451.118Slukem
7461.157SlukemLIBDPLIBS	A list of the tuples:
7471.157Slukem			libname  path-to-srcdir-of-libname
7481.157Slukem
7491.157Slukem		For each tuple;
7501.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
7511.157Slukem			`libname', and if it is not set it is determined
7521.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
7531.157Slukem			latter is to allow for build time optimization).
7541.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
7551.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
7561.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
7571.157Slukem
7581.157Slukem		This variable may be used for individual libraries, as
7591.157Slukem		well as in parent directories to cache common libraries 
7601.157Slukem		as a build-time optimization.
7611.157Slukem
7621.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
7631.118Slukemif it exists, as well as the include file <bsd.man.mk>.
7641.118Slukem
7651.118SlukemIt has rules for building profiled objects; profiled libraries are
7661.118Slukembuilt by default.
7671.118Slukem
7681.118SlukemLibraries are ranlib'd when made.
7691.118Slukem
7701.118Slukem
7711.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
7721.118Slukem
7731.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
7741.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
7751.134Slukem
7761.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
7771.134Slukem			source-file target-file
7781.134Slukem		${DESTDIR} is prepended to both paths before linking.
7791.134Slukem		For example, to link /bin/test and /bin/[, use:
7801.134Slukem			LINKS=/bin/test /bin/[
7811.134Slukem
7821.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
7831.153Slukem		are installed by the `configinstall' target,
7841.153Slukem		not the `install' target.
7851.153Slukem
7861.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
7871.134Slukem			source-file target-file
7881.134Slukem		${DESTDIR} is only prepended to target-file before linking.
7891.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
7901.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
7911.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
7921.118Slukem
7931.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
7941.153Slukem		are installed by the `configinstall' target,
7951.153Slukem		not the `install' target.
7961.153Slukem
7971.118Slukem
7981.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
7991.118Slukem
8001.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
8011.118Slukemlinks.
8021.118Slukem
8031.118SlukemIt has a two targets:
8041.118Slukem
8051.118Slukem	maninstall:
8061.118Slukem		Install the manual page sources and their links.
8071.118Slukem	catinstall:
8081.118Slukem		Install the preformatted manual pages and their links.
8091.118Slukem
8101.118SlukemIt sets/uses the following variables:
8111.118Slukem
8121.118SlukemMANDIR		Base path for manual installation.
8131.118Slukem
8141.118SlukemMANGRP		Manual group.
8151.118Slukem
8161.118SlukemMANOWN		Manual owner.
8171.118Slukem
8181.118SlukemMANMODE		Manual mode.
8191.118Slukem
8201.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
8211.118Slukem		or "/tahoe" for machine specific manual pages.
8221.118Slukem
8231.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
8241.118Slukem
8251.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
8261.118Slukem		linked-to file must come first, the linked file second,
8271.118Slukem		and there may be multiple pairs.  The files are soft-linked.
8281.118Slukem
8291.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
8301.118Slukemit exists.
8311.118Slukem
8321.118Slukem
8331.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
8341.118Slukem
8351.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
8361.118Slukemand use of separated object and source directories.
8371.118Slukem
8381.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
8391.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
8401.118Slukemit exists.  Otherwise make(1) looks for the existence of a
8411.118Slukemsubdirectory (or a symlink to a directory) of the source directory
8421.118Slukeminto which built targets should be placed.  If an environment variable
8431.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
8441.118Slukemobject directory; failing that, make first looks for a subdirectory
8451.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
8461.118Slukem
8471.118SlukemObject directories are not created automatically by make(1) if they
8481.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
8491.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
8501.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
8511.118Slukemand this is determined by a simple string prefix comparison -- object
8521.118Slukemdirectories are created in a separate object directory tree, and a
8531.118Slukemsymlink to the object directory in that tree is created in the source
8541.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
8551.118Slukemsource tree and that it's not safe to use a separate object tree.
8561.118Slukem
8571.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
8581.118Slukemdirectories and links get created during a "make obj":
8591.118Slukem
8601.118SlukemMAKEOBJDIR	If set, this is the component name of the object
8611.118Slukem		directory.
8621.118Slukem
8631.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
8641.118Slukem		object directories or links named "obj.${MACHINE}";
8651.118Slukem		otherwise, just creates ones named "obj".
8661.118Slukem
8671.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
8681.118Slukem		${BSDSRCDIR}, create object directory in the
8691.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
8701.118Slukem		otherwise, create it in the corresponding subdirectory
8711.118Slukem		of ${BSDOBJDIR}
8721.113Sthorpej
8731.118SlukemBUILDID		If set, the contents of this variable are appended
8741.118Slukem		to the object directory name.  If OBJMACHINE is also
8751.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
8761.113Sthorpej
8771.106Sthorpej
8781.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
8791.106Sthorpej
8801.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
8811.1Scgdmore source files, along with their manual pages.  It has a limited number
8821.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
8831.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
8841.1Scgd
8851.16SjtcIt has eight targets:
8861.1Scgd
8871.1Scgd	all:
8881.102Sthorpej		build the program and its manual page.  This also
8891.102Sthorpej		creates a GDB initialization file (.gdbinit) in
8901.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
8911.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
8921.1Scgd	clean:
8931.1Scgd		remove the program, any object files and the files a.out,
8941.24Smikel		Errs, errs, mklog, and ${PROG}.core.
8951.1Scgd	cleandir:
8961.1Scgd		remove all of the files removed by the target clean, as
8971.1Scgd		well as .depend, tags, and any manual pages.
8981.42Slukem		`distclean' is a synonym for `cleandir'.
8991.1Scgd	depend:
9001.1Scgd		make the dependencies for the source files, and store
9011.1Scgd		them in the file .depend.
9021.16Sjtc	includes:
9031.16Sjtc		install any header files.
9041.1Scgd	install:
9051.1Scgd		install the program and its manual pages; if the Makefile
9061.1Scgd		does not itself define the target install, the targets
9071.1Scgd		beforeinstall and afterinstall may also be used to cause
9081.1Scgd		actions immediately before and after the install target
9091.1Scgd		is executed.
9101.1Scgd	lint:
9111.1Scgd		run lint on the source files
9121.1Scgd	tags:
9131.1Scgd		create a tags file for the source files.
9141.1Scgd
9151.1ScgdIt sets/uses the following variables:
9161.1Scgd
9171.1ScgdBINGRP		Binary group.
9181.1Scgd
9191.1ScgdBINOWN		Binary owner.
9201.1Scgd
9211.1ScgdBINMODE		Binary mode.
9221.1Scgd
9231.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
9241.1Scgd
9251.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
9261.112Sthorpej
9271.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
9281.125Slukem		C objects for <fn>.
9291.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9301.125Slukem
9311.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
9321.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
9331.35Slukem
9341.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
9351.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9361.125Slukem
9371.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
9381.125Slukem
9391.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
9401.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9411.102Sthorpej
9421.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
9431.102Sthorpej		directives in the .gdbinit file that is created in the
9441.102Sthorpej		objdir.
9451.1Scgd
9461.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
9471.1Scgd		For example, to load with the compatibility and utility
9481.1Scgd		libraries, use:
9491.1Scgd
9501.5Sjtc			LDADD+=-lutil -lcompat
9511.1Scgd
9521.1ScgdLDFLAGS		Additional loader flags.
9531.1Scgd
9541.134SlukemLINKS		See <bsd.links.mk>
9551.134Slukem
9561.134SlukemSYMLINKS	See <bsd.links.mk>
9571.1Scgd
9581.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
9591.8Scgd		defined, "MAN=${PROG}.1" is assumed.
9601.1Scgd
9611.1ScgdPROG		The name of the program to build.  If not supplied, nothing
9621.1Scgd		is built.
9631.1Scgd
9641.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
9651.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
9661.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
9671.88Sthorpej		the value of PROG if PROG is also set.
9681.87Sthorpej
9691.21SchristosPROGNAME	The name that the above program will be installed as, if
9701.21Schristos		different from ${PROG}.
9711.21Schristos
9721.37StvSRCS		List of source files to build the program.  If SRCS is not
9731.1Scgd		defined, it's assumed to be ${PROG}.c.
9741.108Sjwise
9751.108SjwiseDPSRCS		List of source files which are needed for generating
9761.108Sjwise		dependencies, but are not needed in ${SRCS}.
9771.1Scgd
9781.1ScgdDPADD		Additional dependencies for the program.  Usually used for
9791.1Scgd		libraries.  For example, to depend on the compatibility and
9801.1Scgd		utility libraries use:
9811.1Scgd
9821.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
9831.1Scgd
9841.1Scgd		The following libraries are predefined for DPADD:
9851.1Scgd
9861.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
9871.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
9881.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
9891.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
9901.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
9911.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
9921.99Sitojun		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
9931.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
9941.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
9951.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
9961.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
9971.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
9981.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
9991.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
10001.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
10011.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
10021.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
10031.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
10041.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
10051.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
10061.159Slukem		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
10071.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
10081.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
10091.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
10101.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
10111.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
10121.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
10131.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
10141.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
10151.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
10161.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
10171.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
10181.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
10191.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
10201.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
10211.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
10221.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
10231.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
10241.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
10251.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
10261.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
10271.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
10281.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
10291.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
10301.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
10311.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
10321.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
10331.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
10341.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
10351.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
10361.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
10371.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
10381.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
10391.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
10401.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
10411.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
10421.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
10431.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
10441.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
10451.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
10461.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
10471.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
10481.1Scgd
10491.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
10501.12Schristos		strings, using xstr(1). Note that this will not work with
10511.12Schristos		parallel makes.
10521.1Scgd
10531.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
10541.1Scgd		to be stripped.
10551.1Scgd
10561.1ScgdSUBDIR		A list of subdirectories that should be built as well.
10571.1Scgd		Each of the targets will execute the same target in the
10581.1Scgd		subdirectories.
10591.1Scgd
10601.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
10611.21Schristos		These are installed exactly like programs.
10621.21Schristos
10631.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
10641.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
10651.166Srtr
10661.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
10671.21Schristos		different from ${SCRIPTS}. These can be further specialized
10681.21Schristos		by setting SCRIPTSNAME_<script>.
10691.21Schristos
10701.124SlukemFILES		See description of <bsd.files.mk>.
10711.21Schristos
10721.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
10731.106Sthorpej		<bsd.own.mk> for additional information about this variable.
10741.130Slukem
10751.130SlukemUSE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
10761.130Slukem		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
10771.130Slukem		Default: yes
10781.85Slukem
10791.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
10801.1Scgdif it exists, as well as the include file <bsd.man.mk>.
10811.1Scgd
10821.1ScgdSome simple examples:
10831.1Scgd
10841.1ScgdTo build foo from foo.c with a manual page foo.1, use:
10851.1Scgd
10861.1Scgd	PROG=	foo
10871.1Scgd
10881.1Scgd	.include <bsd.prog.mk>
10891.1Scgd
10901.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
10911.1Scgd
10921.9Scgd	MAN=	foo.2
10931.1Scgd
10941.1ScgdIf foo does not have a manual page at all, add the line:
10951.1Scgd
10961.75Sagc	MKMAN=	no
10971.1Scgd
10981.1ScgdIf foo has multiple source files, add the line:
10991.1Scgd
11001.1Scgd	SRCS=	a.c b.c c.c d.c
11011.1Scgd
11021.1Scgd
11031.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
11041.118Slukem
11051.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
11061.118Slukemconstruct source files built by rpcgen.
11071.72Ssommerfe
11081.118SlukemThe following macros may be defined in makefiles which include
11091.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
11101.118Slukemare to be built:
11111.21Schristos
11121.118SlukemRPC_INCS:	construct .h file from .x file
11131.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
11141.118Slukem		(for marshalling/unmarshalling data types)
11151.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
11161.118Slukem		(server-side stubs)
11171.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
11181.21Schristos
11191.118SlukemRPC_XDIR:	Directory containing .x/.h files
11201.23Schristos
11211.23Schristos
11221.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
11231.21Schristos
11241.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
11251.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
11261.134Slukemincluded before <bsd.shlib.mk>.
11271.21Schristos
11281.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
11291.118Slukem(defaults are in brackets):
11301.21Schristos
11311.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
11321.142Slukem		instead of ${LIBDIR} as the base path for shared library
11331.142Slukem		installation.  [/lib]
11341.21Schristos
11351.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
11361.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
11371.118Slukem		for all others.]
11381.81Swiz
11391.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
11401.118Slukem		otherwise set to ${LIBDIR}
11411.81Swiz
11421.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
11431.39Scgd
11441.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
11451.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
11461.118Slukem		all others.]
11471.39Scgd
11481.13Schristos
11491.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
11501.13Schristos
11511.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
11521.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
11531.118Slukemclean, cleandir, depend, includes, install, lint, and tags.  For all of
11541.142Slukemthe directories listed in ${SUBDIR}, the specified directory will be
11551.142Slukemvisited and the target made.  There is also a default target which allows
11561.142Slukemthe command "make subdir" where subdir is any directory listed in ${SUBDIR}.
11571.47Stv
11581.118SlukemAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
11591.118Slukemas a synchronization barrier when multiple make jobs are run; subdirs
11601.118Slukembefore the .WAIT must complete before any subdirs after .WAIT are
11611.118Slukemstarted.  See make(1) for some caveats on use of .WAIT and other
11621.118Slukemspecial sources.
11631.47Stv
11641.47Stv
11651.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
11661.47Stv
11671.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
11681.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
11691.133Slukemthe NetBSD source tree.
11701.133Slukem
11711.133SlukemThe following variables control how various files are compiled/built.
11721.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
11731.133Slukem
11741.133SlukemAR		Create, modify, and extract from archives.  [ar]
11751.133Slukem
11761.133SlukemARFLAGS		Options to ${AR}.  [rl]
11771.133Slukem
11781.151SlukemAS		Assembler.  [as]
11791.151Slukem
11801.151SlukemAFLAGS		Options to ${AS}.  []
11811.151Slukem
11821.133SlukemCC		C compiler.  [cc]
11831.133Slukem
11841.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
11851.133Slukem
11861.133SlukemCPP		C Pre-Processor.  [cpp]
11871.133Slukem
11881.133SlukemCPPFLAGS	Options to ${CPP}.  []
11891.133Slukem
11901.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
11911.133Slukem
11921.133SlukemCXX		C++ compiler.  [c++]
11931.133Slukem
11941.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
11951.133Slukem
11961.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
11971.133Slukem
11981.133SlukemFC		Fortran compiler.  [f77]
11991.133Slukem
12001.133SlukemFFLAGS		Options to {$FC}.  [-O]
12011.133Slukem
12021.133SlukemINSTALL		install(1) command.  [install]
12031.133Slukem
12041.133SlukemLEX		Lexical analyzer.  [lex]
12051.133Slukem
12061.133SlukemLFLAGS		Options to ${LEX}.  []
12071.133Slukem
12081.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
12091.145Sjwise
12101.133SlukemLD		Linker.  [ld]
12111.133Slukem
12121.133SlukemLDFLAGS		Options to ${LD}.  []
12131.133Slukem
12141.133SlukemLINT		C program verifier.  [lint]
12151.133Slukem
12161.173SperryLINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
12171.133Slukem
12181.133SlukemLORDER		List dependencies for object files.  [lorder]
12191.133Slukem
12201.133SlukemMAKE		make(1).  [make]
12211.133Slukem
12221.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
12231.133Slukem
12241.133SlukemNM		List symbols from object files.  [nm]
12251.133Slukem
12261.133SlukemPC		Pascal compiler.  [pc]  (Not present)
12271.133Slukem
12281.133SlukemPFLAGS		Options to ${PC}.  []
12291.133Slukem
12301.133SlukemOBJC		Objective C compiler.  [${CC}]
12311.133Slukem
12321.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
12331.133Slukem
12341.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
12351.133Slukem
12361.168SrizOBJDUMP		Display information from object files.  [objdump]
12371.168Sriz
12381.133SlukemRANLIB		Generate index to archive.  [ranlib]
12391.133Slukem
12401.133SlukemSHELL		Shell.  [sh]
12411.133Slukem
12421.133SlukemSIZE		List section sizes and total size.  [size]
12431.133Slukem
12441.133SlukemSTRIP		Discard symbols from object files.  [strip]
12451.133Slukem
12461.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
12471.133Slukem
12481.133SlukemYACC		LALR(1) parser generator.  [yacc]
12491.133Slukem
12501.133SlukemYFLAGS		Options to ${YACC}.  []
12511.133Slukem
12521.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
12531.133Slukem		from <file>.y to <file>.h and <file>.c, and add
12541.133Slukem		<foo>.h to CLEANFILES.
12551.133Slukem
12561.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
12571.133Slukem
12581.116Slukem
12591.116SlukemThe following variables are defined to commands to perform the
12601.116Slukemappropriate operation, with the default in [brackets].
12611.142Slukem(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
12621.116Slukem
12631.116SlukemTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
12641.116Slukem
12651.116SlukemTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
12661.116Slukem
12671.116SlukemTOOL_CAT		Concatenate and print files.  [cat]
12681.116Slukem
12691.116SlukemTOOL_CKSUM		Display file checksums.  [cksum]
12701.116Slukem
12711.116SlukemTOOL_COMPILE_ET		Error table compiler.  [compile_et]
12721.116Slukem
12731.116SlukemTOOL_CONFIG		Build kernel compilation directories.  [config]
12741.116Slukem
12751.116SlukemTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
12761.116Slukem
12771.116SlukemTOOL_CTAGS		Create a tags file.  [ctags]
12781.116Slukem
12791.116SlukemTOOL_DB			Manipulate db(3) databases.  [db]
12801.116Slukem
12811.116SlukemTOOL_EQN		Format equations for groff.  [eqn]
12821.116Slukem
12831.116SlukemTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
12841.116Slukem
12851.169SthorpejTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
12861.169Sthorpej
12871.116SlukemTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
12881.116Slukem
12891.116SlukemTOOL_GROFF		Front end for groff document formatting system.  [groff]
12901.116Slukem
12911.116SlukemTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
12921.116Slukem
12931.116SlukemTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
12941.116Slukem
12951.116SlukemTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
12961.116Slukem
12971.116SlukemTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
12981.116Slukem
12991.116SlukemTOOL_M4			M4 macro language processor.  [m4]
13001.116Slukem
13011.116SlukemTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
13021.116Slukem
13031.116SlukemTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
13041.116Slukem
13051.116SlukemTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
13061.116Slukem
13071.116SlukemTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
13081.116Slukem
13091.116SlukemTOOL_MENUC		Menu compiler.  [menuc]
13101.116Slukem
13111.116SlukemTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
13121.116Slukem
13131.116SlukemTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
13141.116Slukem
13151.116SlukemTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
13161.116Slukem
13171.116SlukemTOOL_MKMAGIC		Create database for file(1).  [file]
13181.116Slukem
13191.116SlukemTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
13201.116Slukem
13211.116SlukemTOOL_MSGC		Simple message list compiler.  [msgc]
13221.116Slukem
13231.116SlukemTOOL_MTREE		Map a directory hierarchy.  [mtree]
13241.116Slukem
13251.116SlukemTOOL_PAX		Manipulate file archives and copy directories.  [pax]
13261.116Slukem
13271.116SlukemTOOL_PIC		Compile pictures for groff.  [pic]
13281.116Slukem
13291.116SlukemTOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
13301.116Slukem
13311.116SlukemTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
13321.116Slukem
13331.116SlukemTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
13341.116Slukem
13351.116SlukemTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
13361.116Slukem
13371.116SlukemTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
13381.116Slukem
13391.116SlukemTOOL_ROFF_HTML		Generate HTML groff output.
13401.119Slukem			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
13411.116Slukem
13421.116SlukemTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
13431.116Slukem
13441.116SlukemTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
13451.116Slukem
13461.116SlukemTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
13471.116Slukem
13481.116SlukemTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
13491.123Slukem
13501.123SlukemTOOL_STAT		Display file status.  [stat]
13511.116Slukem
13521.116SlukemTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
13531.116Slukem
13541.116SlukemTOOL_TBL		Format tables for groff.  [tbl]
13551.116Slukem
13561.116SlukemTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
13571.116Slukem
13581.116SlukemTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
13591.116Slukem
13601.116SlukemTOOL_ZIC		Time zone compiler.  [zic]
13611.116Slukem
13621.69Ssommerfe
13631.69SsommerfeOther variables of note (incomplete list):
13641.69Ssommerfe
13651.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
13661.82Slukem			WARNS=1
13671.82Slukem			WARNS=2
13681.82Slukem			WARNS=3
13691.164Smatt			WARNS=4
13701.69Ssommerfe
13711.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
13721.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
13731.75Sagc		WFORMAT belongs in individual makefiles and/or
13741.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
13751.75Sagc		makefiles if a program is not security critical and is
13761.75Sagc		doing bizarre things with format strings which would
13771.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
13781.120Slukem		mk.conf if you're doing format-string auditing.
13791.69Ssommerfe		FORMAT_AUDIT may go away in time.
13801.30Sagc
13811.144Slukem
13821.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
13831.144Slukem
13841.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
13851.144Slukemcross-building X11R6 from ${X11SRCDIR.xc}.
13861.144SlukemIt should be included after the general Makefile contents but before
13871.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
13881.144Slukem
13891.144SlukemIt provides the following targets:
13901.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
13911.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
13921.144Slukem		these rules convert from X11R6's manual page source
13931.144Slukem		into an mdoc.old source file.
13941.144Slukem	cleanx11man:
13951.144Slukem		Clean up the mdoc.old files generated by the above.
13961.144Slukem
13971.144SlukemIt sets the following variables:
13981.144Slukem
13991.144SlukemBINDIR			Set to ${X11BINDIR}.
14001.144Slukem			To override, define after including <bsd.x11.mk>
14011.144Slukem
14021.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
14031.144Slukem			To override, define after including <bsd.x11.mk>
14041.144Slukem
14051.144SlukemMANDIR			Set to ${X11MANDIR}.
14061.144Slukem			To override, define after including <bsd.x11.mk>
14071.144Slukem
14081.144SlukemCPPFLAGS		Appended with definitions to include from
14091.144Slukem			${DESTDIR}${X11INCDIR}
14101.144Slukem
14111.144SlukemLDFLAGS			Appended with definitions to link from
14121.144Slukem			${DESTDIR}${X11USRLIBDIR}
14131.144Slukem
14141.144SlukemX11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
14151.144Slukem
14161.144SlukemX11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
14171.144Slukem
14181.144SlukemX11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
14191.144Slukem
14201.144SlukemX11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
14211.144Slukem
14221.144SlukemX11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
14231.144Slukem
14241.144SlukemX11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
14251.144Slukem
14261.144SlukemX11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
14271.144Slukem
14281.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
14291.144Slukem
14301.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
14311.144Slukem
14321.144SlukemIt uses the following variables:
14331.144Slukem
14341.144SlukemAPPDEFS			List of app-default files to install.
14351.144Slukem
14361.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
14371.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
14381.144Slukem			have a `.cpp' suffix, the generated files do not.
14391.144Slukem
14401.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
14411.144Slukem
14421.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
14431.144Slukem
14441.144Slukem
14451.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1446