bsd.README revision 1.172
11.171Shubertf#	$NetBSD: bsd.README,v 1.172 2005/12/22 02:54:01 hubertf 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.172Shubertf		and also acts as "MKKERBEROS=no MKKERBEROS4=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.172ShubertfMKKERBEROS4	If "no", disables building of Kerberos v4
1761.172Shubertf		infrastructure (libraries and support programs).
1771.172Shubertf		Default: yes
1781.172Shubertf
1791.172ShubertfMKKERBEROS	If "no", disables building of Kerberos v5
1801.172Shubertf		infrastructure (libraries and support programs).
1811.172Shubertf		Default: yes
1821.172Shubertf
1831.172ShubertfMKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
1841.172Shubertf		Also:
1851.172Shubertf			- don't install the .a libraries
1861.172Shubertf			- don't install _pic.a libraries on PIC systems
1871.172Shubertf			- don't build .a libraries on PIC systems
1881.172Shubertf			- don't install the .so symlink on ELF systems
1891.172Shubertf		I.e, only install the shared library (and the .so.major
1901.172Shubertf		symlink on ELF).
1911.172Shubertf		Default: yes
1921.172Shubertf
1931.172ShubertfMKLINT		If "no", don't build or install the lint libraries.
1941.172Shubertf		Default: yes
1951.172Shubertf
1961.172ShubertfMKMAN		If "no", don't build or install the man or catman pages,
1971.172Shubertf		and also acts as "MKCATPAGES=no MKHTML=no".
1981.172Shubertf		Default: yes
1991.172Shubertf
2001.172ShubertfMKMANZ		If not "no", compress manual pages at installation time.
2011.172Shubertf		Default: no
2021.172Shubertf
2031.172ShubertfMKNLS		If "no", don't build or install the NLS files and locale
2041.172Shubertf		definition files.
2051.172Shubertf		Default: yes
2061.172Shubertf
2071.172ShubertfMKOBJ		If "no", don't enable the rule which creates objdirs,
2081.172Shubertf		and also acts as "MKOBJDIRS=no".
2091.172Shubertf		Default: yes
2101.172Shubertf
2111.172ShubertfMKOBJDIRS	If "no", don't create objdirs during a "make build".
2121.172Shubertf		Default: no
2131.172Shubertf
2141.172ShubertfMKPAM		If "no", disables building of PAM authentication
2151.172Shubertf		infrastructure (libraries and support programs).
2161.172Shubertf		Default: no
2171.172Shubertf
2181.172ShubertfMKPF		If "no", don't build or install the pf programs and LKM.
2191.172Shubertf		Default: yes
2201.172Shubertf
2211.172ShubertfMKPIC		If "no", don't build or install shared libraries, and
2221.172Shubertf		also acts as "MKPICLIB=no"
2231.172Shubertf		Default: yes (for MACHINE_ARCHs that support it) 
2241.172Shubertf
2251.172ShubertfMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2261.172Shubertf		Default: yes
2271.172Shubertf
2281.172ShubertfMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2291.172Shubertf		shared object libraries from the .a libraries.
2301.172Shubertf		A symlink is installed in ${DESTDIR}/usr/lib for the
2311.172Shubertf		_pic.a library pointing to the .a library.
2321.172Shubertf		Default: yes
2331.172Shubertf
2341.172ShubertfMKPOSTFIX	If "no", don't build or install postfix(1).
2351.172Shubertf		Default: yes
2361.172Shubertf
2371.172ShubertfMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
2381.172Shubertf		Default: yes
2391.172Shubertf
2401.172ShubertfMKSENDMAIL	If "no", don't build or install sendmail(8).
2411.172Shubertf		Default: yes
2421.172Shubertf
2431.172ShubertfMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
2441.172Shubertf		MKMAN=no MKNLS=no".
2451.172Shubertf		I.e, don't build catman pages, documentation, Info
2461.172Shubertf		documentation, man pages, NLS files, ...
2471.172Shubertf		Default: yes
2481.172Shubertf
2491.172ShubertfMKSKEY		If "no", disables building of S/key authentication
2501.172Shubertf		infrastructure (libraries and support programs).
2511.172Shubertf		Default: yes
2521.172Shubertf
2531.172ShubertfMKSOFTFLOAT	If not "no", build with options to enable the compiler to
2541.172Shubertf		generate output containing library calls for floating
2551.172Shubertf		point and possibly soft-float library support.
2561.172Shubertf		Default: no
2571.172Shubertf
2581.172ShubertfMKSTATICLIB	If "no", don't build or install the normal static (*.a)
2591.172Shubertf		libraries.
2601.172Shubertf		Default: yes
2611.172Shubertf
2621.172ShubertfMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
2631.172Shubertf		files or directories, and keep a metadata log of what
2641.172Shubertf		the owner/group/mode should be.  This allows a
2651.172Shubertf		non-root "make install".
2661.172Shubertf		Default: no
2671.172Shubertf
2681.172ShubertfMKUPDATE 	If not "no", 'make install' only installs targets that are
2691.172Shubertf		more recently modified in the source directories that their
2701.172Shubertf		installed counterparts.
2711.172Shubertf		Default: no
2721.172Shubertf
2731.172ShubertfMKUUCP		If "no", don't build or install uucp(1).
2741.172Shubertf		Default: yes
2751.172Shubertf
2761.172ShubertfMKX11		If not "no", 'make build' also descends into src/x11
2771.172Shubertf		to cross build X11R6 and automatically enables creation
2781.172Shubertf		of X sets.
2791.172Shubertf		Default: no
2801.172Shubertf
2811.172ShubertfMKYP		If "no", disables building of YP (NIS)
2821.172Shubertf		infrastructure (libraries and support programs).
2831.172Shubertf		Default: yes
2841.172Shubertf
2851.172ShubertfUSE_HESIOD	If "no", disables building Hesiod support into
2861.172Shubertf		various system utilities/libraries that support it.
2871.172Shubertf		If ${MKHESIOD} is "no", USE_HESIOD will also be
2881.172Shubertf		forced to "no".
2891.172Shubertf
2901.172ShubertfUSE_INET6	If "no", disables building INET6 (IPv6) support into
2911.172Shubertf		various system utilities/libraries that support it.
2921.172Shubertf		If ${MKINET6} is "no", USE_INET6 will also be
2931.172Shubertf		forced to "no".
2941.172Shubertf
2951.172ShubertfUSE_KERBEROS4	If "no", disables building Kerberos v4
2961.172Shubertf		support into various system utilities/libraries that
2971.172Shubertf		support it.  If ${MKKERBEROS4} is "no", USE_KERBEROS4
2981.172Shubertf		will also be forced to "no".
2991.172Shubertf
3001.172ShubertfUSE_KERBEROS	If "no", disables building Kerberos v4 or v5)
3011.172Shubertf		support into various system utilities/libraries that
3021.172Shubertf		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
3031.172Shubertf		will also be forced to "no".
3041.172Shubertf
3051.172ShubertfUSE_PAM		If "no", disables building PAM authentication support
3061.172Shubertf		into various system utilities/libraries that support it.
3071.172Shubertf		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
3081.172Shubertf
3091.172ShubertfUSE_SKEY	If "no", disables building S/key authentication
3101.172Shubertf		support into various system utilities/libraries that
3111.172Shubertf		support it.  If ${MKSKEY} is "no", USE_SKEY will
3121.172Shubertf		also be forced to "no".
3131.172Shubertf
3141.172ShubertfUSE_YP		If "no", disables building YP (NIS) support into
3151.172Shubertf		various system utilities/libraries that support it.
3161.172Shubertf		If ${MKYP} is "no", USE_YP will also be forced to "no".
3171.172Shubertf
3181.172ShubertfCOPTS.lib<lib>
3191.172ShubertfLDADD.lib<lib>
3201.172ShubertfCPPFLAGS.lib<lib>
3211.172ShubertfCXXFLAGS.lib<lib>
3221.172ShubertfCOPTS.<prog>
3231.172ShubertfLDADD.<prog>
3241.172ShubertfCPPFLAGS.<prog>
3251.172ShubertfCXXFLAGS.<prog>	These provide a way to specify additions to the associated
3261.172Shubertf		variables in a way that applies only to a particular library
3271.172Shubertf		or program.  <lib> corresponds to the LIB variable set in
3281.172Shubertf		the library's makefile.  <prog> corresponds to either PROG
3291.172Shubertf		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
3301.172Shubertf		set to "-g", "-g" will be added to COPTS only when compiling
3311.172Shubertf		the crypto library.
3321.118Slukem
3331.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
3341.1Scgd
3351.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
3361.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
3371.1Scgd
3381.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
3391.1Scgd
3401.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
3411.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
3421.17Sthorpeja few global "feature configuration" parameters.
3431.1Scgd
3441.1ScgdIt has no targets.
3451.1Scgd
3461.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
3471.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
3481.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
3491.29Scjsis included.  These files may define any of the variables described below.
3501.17Sthorpej
3511.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
3521.17Sthorpej(defaults are in brackets):
3531.15Scgd
3541.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
3551.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
3561.98Slukem		otherwise BSDSRCDIR will be used as the default.
3571.98Slukem		Various makefiles within the NetBSD source tree will
3581.98Slukem		use this to reference the top level of the source tree.
3591.98Slukem
3601.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
3611.98Slukem		based on the presence of tools/ and build.sh.  This variable
3621.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
3631.98Slukem		determined once and then propagated to all sub-makes.
3641.95Slukem
3651.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
3661.116Slukem		will work correctly.  [/usr/src]
3671.15Scgd
3681.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
3691.116Slukem		will work correctly.  [/usr/obj]
3701.15Scgd
3711.116SlukemBINGRP		Binary group.  [wheel]
3721.15Scgd
3731.116SlukemBINOWN		Binary owner.  [root]
3741.15Scgd
3751.116SlukemBINMODE		Binary mode.  [555]
3761.15Scgd
3771.116SlukemNONBINMODE	Mode for non-executable files.  [444]
3781.15Scgd
3791.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
3801.15Scgd
3811.116SlukemMANGRP		Manual group.  [wheel]
3821.15Scgd
3831.116SlukemMANOWN		Manual owner.  [root]
3841.15Scgd
3851.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
3861.15Scgd
3871.21SchristosMANINSTALL	Manual installation type: maninstall, catinstall, or both
3881.155Sjmc		[maninstall catinstall]
3891.76Sfair
3901.76SfairLDSTATIC	Control program linking; if set blank, link everything
3911.129Slukem		dynamically.  If set to "-static", link everything statically.
3921.76Sfair		If not set, programs link according to their makefile.
3931.21Schristos
3941.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
3951.15Scgd
3961.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
3971.15Scgd
3981.116SlukemLIBGRP		Library group.  [${BINGRP}]
3991.15Scgd
4001.116SlukemLIBOWN		Library owner.  [${BINOWN}]
4011.15Scgd
4021.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
4031.15Scgd
4041.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
4051.116Slukem	        installation.  [/usr/share/doc]
4061.62Ssimonb
4071.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
4081.62Ssimonb		[/usr/share/doc/html]
4091.15Scgd
4101.116SlukemDOCGRP		Documentation group.  [wheel]
4111.15Scgd
4121.116SlukemDOCOWN		Documentation owner.  [root]
4131.15Scgd
4141.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
4151.15Scgd
4161.84SkleinkNLSDIR		Base path for Native Language Support files installation.
4171.15Scgd		[/usr/share/nls]
4181.1Scgd
4191.116SlukemNLSGRP		Native Language Support files group.  [wheel]
4201.1Scgd
4211.116SlukemNLSOWN		Native Language Support files owner.  [root]
4221.1Scgd
4231.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
4241.1Scgd
4251.144SlukemX11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
4261.144Slukem
4271.144SlukemX11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
4281.144Slukem
4291.144SlukemX11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
4301.144Slukem
4311.144SlukemX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
4321.144Slukem
4331.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
4341.144Slukem
4351.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
4361.144Slukem
4371.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
4381.144Slukem
4391.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
4401.144Slukem
4411.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
4421.144Slukem
4431.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
4441.144Slukem
4451.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
4461.1Scgd		to be stripped.  This is to be used when building your
4471.1Scgd		own install script so that the entire system can be made
4481.146Slukem		stripped/not-stripped using a single knob.  []
4491.1Scgd
4501.2ScgdCOPY		The flag passed to the install program to cause the binary
4511.2Scgd		to be copied rather than moved.  This is to be used when
4521.2Scgd		building our own install script so that the entire system
4531.2Scgd		can either be installed with copies, or with moves using
4541.116Slukem		a single knob.  [-c]
4551.15Scgd
4561.150SlukemMAKEDIRTARGET dir target [params]
4571.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
4581.150Slukem		displaying a "pretty" message whilst doing so.
4591.150Slukem
4601.152SclRELEASEMACHINEDIR
4611.152Scl		Subdirectory used below RELEASEDIR when building
4621.152Scl		a release.  [${MACHINE}]
4631.152Scl
4641.152SclRELEASEMACHINE	Subdirectory or path component used for the following
4651.152Scl		paths:
4661.152Scl			distrib/${RELEASEMACHINE}
4671.152Scl			distrib/notes/${RELEASEMACHINE}
4681.152Scl			etc/etc.${RELEASEMACHINE}
4691.152Scl		Used when building a release.  [${MACHINE}]
4701.150Slukem
4711.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
4721.17Sthorpejmake configuration file to modify the behaviour of the system build
4731.17Sthorpejprocess (default values are in brackets along with comments, if set by
4741.134Slukem<bsd.own.mk>):
4751.33Sjonathan
4761.172ShubertfUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
4771.172Shubertf		be used as part of a build in progress.
4781.172Shubertf		Supported values:
4791.172Shubertf
4801.172Shubertf		yes	Use the tools from TOOLDIR.
4811.172Shubertf			Must be set to this if cross-compiling.
4821.172Shubertf
4831.172Shubertf		no	Do not use the tools from TOOLDIR, but refuse to
4841.172Shubertf			build native compilation tool components that are
4851.172Shubertf			version-specific for that tool.
4861.172Shubertf
4871.172Shubertf		never	Do not use the tools from TOOLDIR, even when
4881.172Shubertf			building native tool components.  This is similar to
4891.172Shubertf			the traditional NetBSD build method, but does not
4901.172Shubertf			verify that the compilation tools in use are
4911.172Shubertf			up-to-date enough in order to build the tree
4921.172Shubertf			successfully.  This may cause build or runtime
4931.172Shubertf			problems when building the whole NetBSD source tree.
4941.172Shubertf
4951.172Shubertf		Default: "yes" if building all or part of a whole NetBSD
4961.172Shubertf		source tree (detected automatically); "no" otherwise
4971.172Shubertf		(to preserve traditional semantics of the <bsd.*.mk>
4981.172Shubertf		make(1) include files).
4991.142Slukem
5001.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
5011.156Stron		use ELF -- currently all architectures but ns32k, set to
5021.156Stron		"a.out" on ns32k].
5031.33Sjonathan
5041.103SthorpejTOOLCHAIN_MISSING
5051.142Slukem		If not "no", this indicates that the platform being built
5061.103Sthorpej		does not have a working in-tree toolchain.  If the
5071.142Slukem		${MACHINE_ARCH} in question falls into this category,
5081.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
5091.103Sthorpej		Otherwise, the variable is unconditionally assigned the
5101.103Sthorpej		value "no".
5111.142Slukem		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
5121.142Slukem		unconditionally assigned the value "no".
5131.103Sthorpej
5141.103SthorpejEXTERNAL_TOOLCHAIN
5151.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
5161.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
5171.103Sthorpej		access to this variable.  The variable should be defined
5181.103Sthorpej		either in the user's environment or in the user's mk.conf
5191.103Sthorpej		file.  If defined, this variable indicates the root of
5201.103Sthorpej		an external toolchain which will be used to build the
5211.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
5221.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
5231.103Sthorpej		cross-compile framework.
5241.103Sthorpej
5251.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
5261.142Slukem		assigned the value "no", since the external version of the
5271.142Slukem		compiler may not be able to build the library components of
5281.142Slukem		the in-tree compiler.
5291.103Sthorpej
5301.103Sthorpej		NOTE: This variable is not yet used in as many places as
5311.103Sthorpej		it should be.  Expect the exact semantics of this variable
5321.103Sthorpej		to change in the short term as parts of the cross-compile
5331.103Sthorpej		framework continue to be cleaned up.
5341.1Scgd
5351.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
5361.1Scgdthey use the same default owners etc. as the rest of the tree.
5371.131Slukem
5381.131Slukem
5391.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
5401.131Slukem
5411.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
5421.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
5431.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
5441.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
5451.133Slukemdependencies for the .d files.  In order for this to function correctly,
5461.132Slukemit should be .included after all other .mk files and directives that may
5471.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
5481.132Slukem
5491.132SlukemSRCS		List of source files to build the program.
5501.132Slukem
5511.132SlukemDPSRCS		List of source files which are needed for generating
5521.132Slukem		dependencies, but are not needed in ${SRCS}.
5531.1Scgd
5541.1Scgd
5551.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
5561.106Sthorpej
5571.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
5581.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
5591.124Slukem
5601.124SlukemFILES		The list of files to install.
5611.124Slukem
5621.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
5631.153Slukem		are installed by the `configinstall' target,
5641.153Slukem		not the `install' target.
5651.153Slukem		The FILES* variables documented below also apply.
5661.153Slukem
5671.124SlukemFILESOWN	File owner.  [${BINOWN}]
5681.124Slukem
5691.124SlukemFILESGRP	File group.  [${BINGRP}]
5701.124Slukem
5711.124SlukemFILESMODE	File mode.  [${BINMODE}]
5721.124Slukem
5731.124SlukemFILESDIR	The location to install the files.
5741.124Slukem
5751.124SlukemFILESNAME	Optional name to install each file as.
5761.124Slukem
5771.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
5781.153Slukem
5791.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
5801.153Slukem
5811.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
5821.153Slukem
5831.153SlukemFILESDIR_<fn>	The location to install the specific file <fn>>
5841.153Slukem
5851.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
5861.124Slukem
5871.135Slukem
5881.139SlukemBUILDSYMLINKS	List of two word items:
5891.135Slukem			lnsrc lntgt
5901.135Slukem		For each lnsrc item, create a symlink named lntgt.
5911.135Slukem		The lntgt symlinks are removed by the cleandir target.
5921.106Sthorpej
5931.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
5941.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
5951.148Sjmc		The source files have a `.uue' suffix, the generated files do 
5961.148Sjmc		not.
5971.149Sjmc
5981.149SjmcUUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
5991.148Sjmc		
6001.148Sjmc		*NOTE: These files are simply decoded, with no install or other
6011.148Sjmc		       rule applying implicitly except being added to the clean
6021.148Sjmc		       target.
6031.106Sthorpej
6041.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
6051.113Sthorpej
6061.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
6071.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
6081.134Slukembefore <bsd.gcc.mk>.
6091.113Sthorpej
6101.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
6111.113Sthorpejof which need to know where to find certain GCC support libraries.
6121.113Sthorpej
6131.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
6141.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
6151.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
6161.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
6171.113Sthorpej
6181.134Slukem<bsd.gcc.mk> sets the following variables:
6191.113Sthorpej
6201.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
6211.118Slukem
6221.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
6231.118Slukem
6241.118Slukem_GCC_CRTEND	The full path name to crtend.o.
6251.118Slukem
6261.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
6271.118Slukem
6281.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
6291.118Slukem
6301.118Slukem
6311.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
6321.118Slukem
6331.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
6341.118Slukemvariables:
6351.118Slukem
6361.124SlukemINCS		The list of include files.
6371.118Slukem
6381.118SlukemINCSDIR		The location to install the include files.
6391.118Slukem
6401.118SlukemINCSNAME	Target name of the include file, if only one; same as
6411.118Slukem		FILESNAME, but for include files.
6421.118Slukem
6431.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
6441.134Slukem		are installed in the 'includes' target and not the
6451.134Slukem		(much later) 'install' target.
6461.134Slukem
6471.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
6481.118Slukem		same as FILESNAME_<file>, but for include files.
6491.118Slukem
6501.118Slukem
6511.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
6521.118Slukem
6531.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
6541.118Slukemdocumentation from respective Texinfo source files.  It defines three
6551.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
6561.118Slukemfollowing variables:
6571.118Slukem
6581.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
6591.118Slukem		consist of single files with the extension replaced by
6601.118Slukem		.info.
6611.118Slukem
6621.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
6631.118Slukem
6641.118Slukem
6651.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
6661.118Slukem
6671.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
6681.118Slukemlocation of kernel sources and object directories.
6691.118Slukem
6701.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
6711.124Slukem		[${_SRC_TOP_}/sys]
6721.118Slukem
6731.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
6741.124Slukem		[arch/${MACHINE}]
6751.120Slukem
6761.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
6771.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
6781.118Slukem
6791.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
6801.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
6811.118Slukem		The default value is
6821.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
6831.118Slukem		if it exists or the target 'obj' is being made.
6841.118Slukem		Otherwise the default is
6851.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
6861.118Slukem
6871.118SlukemIt is important that Makefiles (such as those under src/distrib) that
6881.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
6891.118Slukemrather than make assumptions about the location of the compiled kernel.
6901.118Slukem
6911.118Slukem
6921.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
6931.118Slukem
6941.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
6951.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
6961.118Slukeminclude file installation.  It is intended to be included alone, by
6971.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
6981.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
6991.134Slukemin that file up to date.
7001.118Slukem
7011.118Slukem
7021.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
7031.118Slukem
7041.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
7051.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
7061.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
7071.118Slukemwhich checks for installed shared object libraries whose version is greater
7081.118Slukemthat the version of the source. It has a limited number of suffixes,
7091.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
7101.118Slukem<bsd.shlib.mk> to get shared library parameters.
7111.118Slukem
7121.118SlukemIt sets/uses the following variables:
7131.118Slukem
7141.118SlukemLIB		The name of the library to build.
7151.118Slukem
7161.118SlukemLIBDIR		Target directory for libraries.
7171.118Slukem
7181.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
7191.142Slukem		is not "no".
7201.118Slukem
7211.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
7221.118Slukem		as the path to install shared libraries to.
7231.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
7241.130Slukem		Default: no
7251.118Slukem
7261.154SlukemMKPRIVATELIB	If not "no", act as "MKPROFILE=no MKPIC=no MKLINT=no",
7271.154Slukem		and don't install the (.a) library.
7281.154Slukem		This is useful for "build only" helper libraries.
7291.154Slukem		Default: no
7301.154Slukem
7311.118SlukemLINTLIBDIR	Target directory for lint libraries.
7321.118Slukem
7331.118SlukemLIBGRP		Library group.
7341.118Slukem
7351.118SlukemLIBOWN		Library owner.
7361.118Slukem
7371.118SlukemLIBMODE		Library mode.
7381.118Slukem
7391.118SlukemLDADD		Additional loader objects.
7401.118Slukem
7411.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
7421.118Slukem
7431.118SlukemNOCHECKVER_<library>
7441.118SlukemNOCHECKVER	If set, disables checking for installed shared object
7451.118Slukem		libraries with versions greater than the source.  A
7461.118Slukem		particular library name, without the "lib" prefix, may
7471.118Slukem		be appended to the variable name to disable the check for
7481.118Slukem		only that library.
7491.118Slukem
7501.118SlukemSRCS		List of source files to build the library.  Suffix types
7511.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
7521.118Slukem		to .c files of the same name.  (This is not the default for
7531.118Slukem		versions of make.)
7541.118Slukem
7551.157SlukemLIBDPLIBS	A list of the tuples:
7561.157Slukem			libname  path-to-srcdir-of-libname
7571.157Slukem
7581.157Slukem		For each tuple;
7591.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
7601.157Slukem			`libname', and if it is not set it is determined
7611.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
7621.157Slukem			latter is to allow for build time optimization).
7631.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
7641.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
7651.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
7661.157Slukem
7671.157Slukem		This variable may be used for individual libraries, as
7681.157Slukem		well as in parent directories to cache common libraries 
7691.157Slukem		as a build-time optimization.
7701.157Slukem
7711.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
7721.118Slukemif it exists, as well as the include file <bsd.man.mk>.
7731.118Slukem
7741.118SlukemIt has rules for building profiled objects; profiled libraries are
7751.118Slukembuilt by default.
7761.118Slukem
7771.118SlukemLibraries are ranlib'd when made.
7781.118Slukem
7791.118Slukem
7801.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
7811.118Slukem
7821.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
7831.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
7841.134Slukem
7851.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
7861.134Slukem			source-file target-file
7871.134Slukem		${DESTDIR} is prepended to both paths before linking.
7881.134Slukem		For example, to link /bin/test and /bin/[, use:
7891.134Slukem			LINKS=/bin/test /bin/[
7901.134Slukem
7911.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
7921.153Slukem		are installed by the `configinstall' target,
7931.153Slukem		not the `install' target.
7941.153Slukem
7951.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
7961.134Slukem			source-file target-file
7971.134Slukem		${DESTDIR} is only prepended to target-file before linking.
7981.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
7991.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
8001.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
8011.118Slukem
8021.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
8031.153Slukem		are installed by the `configinstall' target,
8041.153Slukem		not the `install' target.
8051.153Slukem
8061.118Slukem
8071.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
8081.118Slukem
8091.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
8101.118Slukemlinks.
8111.118Slukem
8121.118SlukemIt has a two targets:
8131.118Slukem
8141.118Slukem	maninstall:
8151.118Slukem		Install the manual page sources and their links.
8161.118Slukem	catinstall:
8171.118Slukem		Install the preformatted manual pages and their links.
8181.118Slukem
8191.118SlukemIt sets/uses the following variables:
8201.118Slukem
8211.118SlukemMANDIR		Base path for manual installation.
8221.118Slukem
8231.118SlukemMANGRP		Manual group.
8241.118Slukem
8251.118SlukemMANOWN		Manual owner.
8261.118Slukem
8271.118SlukemMANMODE		Manual mode.
8281.118Slukem
8291.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
8301.118Slukem		or "/tahoe" for machine specific manual pages.
8311.118Slukem
8321.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
8331.118Slukem
8341.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
8351.118Slukem		linked-to file must come first, the linked file second,
8361.118Slukem		and there may be multiple pairs.  The files are soft-linked.
8371.118Slukem
8381.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
8391.118Slukemit exists.
8401.118Slukem
8411.118Slukem
8421.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
8431.118Slukem
8441.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
8451.118Slukemand use of separated object and source directories.
8461.118Slukem
8471.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
8481.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
8491.118Slukemit exists.  Otherwise make(1) looks for the existence of a
8501.118Slukemsubdirectory (or a symlink to a directory) of the source directory
8511.118Slukeminto which built targets should be placed.  If an environment variable
8521.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
8531.118Slukemobject directory; failing that, make first looks for a subdirectory
8541.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
8551.118Slukem
8561.118SlukemObject directories are not created automatically by make(1) if they
8571.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
8581.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
8591.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
8601.118Slukemand this is determined by a simple string prefix comparison -- object
8611.118Slukemdirectories are created in a separate object directory tree, and a
8621.118Slukemsymlink to the object directory in that tree is created in the source
8631.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
8641.118Slukemsource tree and that it's not safe to use a separate object tree.
8651.118Slukem
8661.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
8671.118Slukemdirectories and links get created during a "make obj":
8681.118Slukem
8691.118SlukemMAKEOBJDIR	If set, this is the component name of the object
8701.118Slukem		directory.
8711.118Slukem
8721.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
8731.118Slukem		object directories or links named "obj.${MACHINE}";
8741.118Slukem		otherwise, just creates ones named "obj".
8751.118Slukem
8761.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
8771.118Slukem		${BSDSRCDIR}, create object directory in the
8781.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
8791.118Slukem		otherwise, create it in the corresponding subdirectory
8801.118Slukem		of ${BSDOBJDIR}
8811.113Sthorpej
8821.118SlukemBUILDID		If set, the contents of this variable are appended
8831.118Slukem		to the object directory name.  If OBJMACHINE is also
8841.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
8851.113Sthorpej
8861.106Sthorpej
8871.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
8881.106Sthorpej
8891.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
8901.1Scgdmore source files, along with their manual pages.  It has a limited number
8911.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
8921.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
8931.1Scgd
8941.16SjtcIt has eight targets:
8951.1Scgd
8961.1Scgd	all:
8971.102Sthorpej		build the program and its manual page.  This also
8981.102Sthorpej		creates a GDB initialization file (.gdbinit) in
8991.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
9001.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
9011.1Scgd	clean:
9021.1Scgd		remove the program, any object files and the files a.out,
9031.24Smikel		Errs, errs, mklog, and ${PROG}.core.
9041.1Scgd	cleandir:
9051.1Scgd		remove all of the files removed by the target clean, as
9061.1Scgd		well as .depend, tags, and any manual pages.
9071.42Slukem		`distclean' is a synonym for `cleandir'.
9081.1Scgd	depend:
9091.1Scgd		make the dependencies for the source files, and store
9101.1Scgd		them in the file .depend.
9111.16Sjtc	includes:
9121.16Sjtc		install any header files.
9131.1Scgd	install:
9141.1Scgd		install the program and its manual pages; if the Makefile
9151.1Scgd		does not itself define the target install, the targets
9161.1Scgd		beforeinstall and afterinstall may also be used to cause
9171.1Scgd		actions immediately before and after the install target
9181.1Scgd		is executed.
9191.1Scgd	lint:
9201.1Scgd		run lint on the source files
9211.1Scgd	tags:
9221.1Scgd		create a tags file for the source files.
9231.1Scgd
9241.1ScgdIt sets/uses the following variables:
9251.1Scgd
9261.1ScgdBINGRP		Binary group.
9271.1Scgd
9281.1ScgdBINOWN		Binary owner.
9291.1Scgd
9301.1ScgdBINMODE		Binary mode.
9311.1Scgd
9321.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
9331.1Scgd
9341.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
9351.112Sthorpej
9361.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
9371.125Slukem		C objects for <fn>.
9381.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9391.125Slukem
9401.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
9411.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
9421.35Slukem
9431.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
9441.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9451.125Slukem
9461.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
9471.125Slukem
9481.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
9491.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9501.102Sthorpej
9511.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
9521.102Sthorpej		directives in the .gdbinit file that is created in the
9531.102Sthorpej		objdir.
9541.1Scgd
9551.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
9561.1Scgd		For example, to load with the compatibility and utility
9571.1Scgd		libraries, use:
9581.1Scgd
9591.5Sjtc			LDADD+=-lutil -lcompat
9601.1Scgd
9611.1ScgdLDFLAGS		Additional loader flags.
9621.1Scgd
9631.134SlukemLINKS		See <bsd.links.mk>
9641.134Slukem
9651.134SlukemSYMLINKS	See <bsd.links.mk>
9661.1Scgd
9671.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
9681.8Scgd		defined, "MAN=${PROG}.1" is assumed.
9691.1Scgd
9701.1ScgdPROG		The name of the program to build.  If not supplied, nothing
9711.1Scgd		is built.
9721.1Scgd
9731.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
9741.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
9751.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
9761.88Sthorpej		the value of PROG if PROG is also set.
9771.87Sthorpej
9781.21SchristosPROGNAME	The name that the above program will be installed as, if
9791.21Schristos		different from ${PROG}.
9801.21Schristos
9811.37StvSRCS		List of source files to build the program.  If SRCS is not
9821.1Scgd		defined, it's assumed to be ${PROG}.c.
9831.108Sjwise
9841.108SjwiseDPSRCS		List of source files which are needed for generating
9851.108Sjwise		dependencies, but are not needed in ${SRCS}.
9861.1Scgd
9871.1ScgdDPADD		Additional dependencies for the program.  Usually used for
9881.1Scgd		libraries.  For example, to depend on the compatibility and
9891.1Scgd		utility libraries use:
9901.1Scgd
9911.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
9921.1Scgd
9931.1Scgd		The following libraries are predefined for DPADD:
9941.1Scgd
9951.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
9961.159Slukem		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
9971.159Slukem		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
9981.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
9991.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
10001.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
10011.99Sitojun		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
10021.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
10031.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
10041.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
10051.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
10061.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
10071.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
10081.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
10091.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
10101.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
10111.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
10121.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
10131.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
10141.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
10151.159Slukem		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
10161.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
10171.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
10181.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
10191.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
10201.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
10211.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
10221.99Sitojun		LIBKADM?=	${DESTDIR}/usr/lib/libkadm.a
10231.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
10241.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
10251.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
10261.21Schristos		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
10271.21Schristos		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
10281.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
10291.99Sitojun		LIBKSTREAM?=	${DESTDIR}/usr/lib/libkstream.a
10301.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
10311.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
10321.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
10331.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
10341.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
10351.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
10361.159Slukem		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
10371.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
10381.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
10391.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
10401.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
10411.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
10421.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
10431.163Schristos		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
10441.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
10451.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
10461.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
10471.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
10481.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
10491.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
10501.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
10511.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
10521.159Slukem		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
10531.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
10541.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
10551.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
10561.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
10571.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
10581.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
10591.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
10601.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
10611.1Scgd
10621.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
10631.12Schristos		strings, using xstr(1). Note that this will not work with
10641.12Schristos		parallel makes.
10651.1Scgd
10661.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
10671.1Scgd		to be stripped.
10681.1Scgd
10691.1ScgdSUBDIR		A list of subdirectories that should be built as well.
10701.1Scgd		Each of the targets will execute the same target in the
10711.1Scgd		subdirectories.
10721.1Scgd
10731.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
10741.21Schristos		These are installed exactly like programs.
10751.21Schristos
10761.166SrtrSCRIPTSDIR	The location to install the scripts.  Each script can be
10771.166Srtr		installed to a separate path by setting SCRIPTSDIR_<script>.
10781.166Srtr
10791.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
10801.21Schristos		different from ${SCRIPTS}. These can be further specialized
10811.21Schristos		by setting SCRIPTSNAME_<script>.
10821.21Schristos
10831.124SlukemFILES		See description of <bsd.files.mk>.
10841.21Schristos
10851.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
10861.106Sthorpej		<bsd.own.mk> for additional information about this variable.
10871.130Slukem
10881.130SlukemUSE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
10891.130Slukem		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
10901.130Slukem		Default: yes
10911.85Slukem
10921.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
10931.1Scgdif it exists, as well as the include file <bsd.man.mk>.
10941.1Scgd
10951.1ScgdSome simple examples:
10961.1Scgd
10971.1ScgdTo build foo from foo.c with a manual page foo.1, use:
10981.1Scgd
10991.1Scgd	PROG=	foo
11001.1Scgd
11011.1Scgd	.include <bsd.prog.mk>
11021.1Scgd
11031.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
11041.1Scgd
11051.9Scgd	MAN=	foo.2
11061.1Scgd
11071.1ScgdIf foo does not have a manual page at all, add the line:
11081.1Scgd
11091.75Sagc	MKMAN=	no
11101.1Scgd
11111.1ScgdIf foo has multiple source files, add the line:
11121.1Scgd
11131.1Scgd	SRCS=	a.c b.c c.c d.c
11141.1Scgd
11151.1Scgd
11161.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
11171.118Slukem
11181.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
11191.118Slukemconstruct source files built by rpcgen.
11201.72Ssommerfe
11211.118SlukemThe following macros may be defined in makefiles which include
11221.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
11231.118Slukemare to be built:
11241.21Schristos
11251.118SlukemRPC_INCS:	construct .h file from .x file
11261.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
11271.118Slukem		(for marshalling/unmarshalling data types)
11281.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
11291.118Slukem		(server-side stubs)
11301.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
11311.21Schristos
11321.118SlukemRPC_XDIR:	Directory containing .x/.h files
11331.23Schristos
11341.23Schristos
11351.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
11361.21Schristos
11371.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
11381.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
11391.134Slukemincluded before <bsd.shlib.mk>.
11401.21Schristos
11411.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
11421.118Slukem(defaults are in brackets):
11431.21Schristos
11441.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
11451.142Slukem		instead of ${LIBDIR} as the base path for shared library
11461.142Slukem		installation.  [/lib]
11471.21Schristos
11481.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
11491.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
11501.118Slukem		for all others.]
11511.81Swiz
11521.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
11531.118Slukem		otherwise set to ${LIBDIR}
11541.81Swiz
11551.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
11561.39Scgd
11571.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
11581.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
11591.118Slukem		all others.]
11601.39Scgd
11611.13Schristos
11621.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
11631.13Schristos
11641.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
11651.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
11661.118Slukemclean, cleandir, depend, includes, install, lint, and tags.  For all of
11671.142Slukemthe directories listed in ${SUBDIR}, the specified directory will be
11681.142Slukemvisited and the target made.  There is also a default target which allows
11691.142Slukemthe command "make subdir" where subdir is any directory listed in ${SUBDIR}.
11701.47Stv
11711.118SlukemAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
11721.118Slukemas a synchronization barrier when multiple make jobs are run; subdirs
11731.118Slukembefore the .WAIT must complete before any subdirs after .WAIT are
11741.118Slukemstarted.  See make(1) for some caveats on use of .WAIT and other
11751.118Slukemspecial sources.
11761.47Stv
11771.47Stv
11781.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
11791.47Stv
11801.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
11811.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
11821.133Slukemthe NetBSD source tree.
11831.133Slukem
11841.133SlukemThe following variables control how various files are compiled/built.
11851.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
11861.133Slukem
11871.133SlukemAR		Create, modify, and extract from archives.  [ar]
11881.133Slukem
11891.133SlukemARFLAGS		Options to ${AR}.  [rl]
11901.133Slukem
11911.151SlukemAS		Assembler.  [as]
11921.151Slukem
11931.151SlukemAFLAGS		Options to ${AS}.  []
11941.151Slukem
11951.133SlukemCC		C compiler.  [cc]
11961.133Slukem
11971.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
11981.133Slukem
11991.133SlukemCPP		C Pre-Processor.  [cpp]
12001.133Slukem
12011.133SlukemCPPFLAGS	Options to ${CPP}.  []
12021.133Slukem
12031.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
12041.133Slukem
12051.133SlukemCXX		C++ compiler.  [c++]
12061.133Slukem
12071.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
12081.133Slukem
12091.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
12101.133Slukem
12111.133SlukemFC		Fortran compiler.  [f77]
12121.133Slukem
12131.133SlukemFFLAGS		Options to {$FC}.  [-O]
12141.133Slukem
12151.133SlukemINSTALL		install(1) command.  [install]
12161.133Slukem
12171.133SlukemLEX		Lexical analyzer.  [lex]
12181.133Slukem
12191.133SlukemLFLAGS		Options to ${LEX}.  []
12201.133Slukem
12211.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
12221.145Sjwise
12231.133SlukemLD		Linker.  [ld]
12241.133Slukem
12251.133SlukemLDFLAGS		Options to ${LD}.  []
12261.133Slukem
12271.133SlukemLINT		C program verifier.  [lint]
12281.133Slukem
12291.133SlukemLINTFLAGS	Options to ${LINT}.  [-chapbxzF]
12301.133Slukem
12311.133SlukemLORDER		List dependencies for object files.  [lorder]
12321.133Slukem
12331.133SlukemMAKE		make(1).  [make]
12341.133Slukem
12351.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
12361.133Slukem
12371.133SlukemNM		List symbols from object files.  [nm]
12381.133Slukem
12391.133SlukemPC		Pascal compiler.  [pc]  (Not present)
12401.133Slukem
12411.133SlukemPFLAGS		Options to ${PC}.  []
12421.133Slukem
12431.133SlukemOBJC		Objective C compiler.  [${CC}]
12441.133Slukem
12451.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
12461.133Slukem
12471.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
12481.133Slukem
12491.168SrizOBJDUMP		Display information from object files.  [objdump]
12501.168Sriz
12511.133SlukemRANLIB		Generate index to archive.  [ranlib]
12521.133Slukem
12531.133SlukemSHELL		Shell.  [sh]
12541.133Slukem
12551.133SlukemSIZE		List section sizes and total size.  [size]
12561.133Slukem
12571.133SlukemSTRIP		Discard symbols from object files.  [strip]
12581.133Slukem
12591.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
12601.133Slukem
12611.133SlukemYACC		LALR(1) parser generator.  [yacc]
12621.133Slukem
12631.133SlukemYFLAGS		Options to ${YACC}.  []
12641.133Slukem
12651.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
12661.133Slukem		from <file>.y to <file>.h and <file>.c, and add
12671.133Slukem		<foo>.h to CLEANFILES.
12681.133Slukem
12691.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
12701.133Slukem
12711.116Slukem
12721.116SlukemThe following variables are defined to commands to perform the
12731.116Slukemappropriate operation, with the default in [brackets].
12741.142Slukem(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
12751.116Slukem
12761.116SlukemTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
12771.116Slukem
12781.116SlukemTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
12791.116Slukem
12801.116SlukemTOOL_CAT		Concatenate and print files.  [cat]
12811.116Slukem
12821.116SlukemTOOL_CKSUM		Display file checksums.  [cksum]
12831.116Slukem
12841.116SlukemTOOL_COMPILE_ET		Error table compiler.  [compile_et]
12851.116Slukem
12861.116SlukemTOOL_CONFIG		Build kernel compilation directories.  [config]
12871.116Slukem
12881.116SlukemTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
12891.116Slukem
12901.116SlukemTOOL_CTAGS		Create a tags file.  [ctags]
12911.116Slukem
12921.116SlukemTOOL_DB			Manipulate db(3) databases.  [db]
12931.116Slukem
12941.116SlukemTOOL_EQN		Format equations for groff.  [eqn]
12951.116Slukem
12961.116SlukemTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
12971.116Slukem
12981.169SthorpejTOOL_GENASSYM		Generate constants for assembly files.  [genassym]
12991.169Sthorpej
13001.116SlukemTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
13011.116Slukem
13021.116SlukemTOOL_GROFF		Front end for groff document formatting system.  [groff]
13031.116Slukem
13041.116SlukemTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
13051.116Slukem
13061.116SlukemTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
13071.116Slukem
13081.116SlukemTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
13091.116Slukem
13101.116SlukemTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
13111.116Slukem
13121.116SlukemTOOL_M4			M4 macro language processor.  [m4]
13131.116Slukem
13141.116SlukemTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
13151.116Slukem
13161.116SlukemTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
13171.116Slukem
13181.116SlukemTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
13191.116Slukem
13201.116SlukemTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
13211.116Slukem
13221.116SlukemTOOL_MENUC		Menu compiler.  [menuc]
13231.116Slukem
13241.116SlukemTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
13251.116Slukem
13261.116SlukemTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
13271.116Slukem
13281.116SlukemTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
13291.116Slukem
13301.116SlukemTOOL_MKMAGIC		Create database for file(1).  [file]
13311.116Slukem
13321.116SlukemTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
13331.116Slukem
13341.116SlukemTOOL_MSGC		Simple message list compiler.  [msgc]
13351.116Slukem
13361.116SlukemTOOL_MTREE		Map a directory hierarchy.  [mtree]
13371.116Slukem
13381.116SlukemTOOL_PAX		Manipulate file archives and copy directories.  [pax]
13391.116Slukem
13401.116SlukemTOOL_PIC		Compile pictures for groff.  [pic]
13411.116Slukem
13421.116SlukemTOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
13431.116Slukem
13441.116SlukemTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
13451.116Slukem
13461.116SlukemTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
13471.116Slukem
13481.116SlukemTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
13491.116Slukem
13501.116SlukemTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
13511.116Slukem
13521.116SlukemTOOL_ROFF_HTML		Generate HTML groff output.
13531.119Slukem			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
13541.116Slukem
13551.116SlukemTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
13561.116Slukem
13571.116SlukemTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
13581.116Slukem
13591.116SlukemTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
13601.116Slukem
13611.116SlukemTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
13621.123Slukem
13631.123SlukemTOOL_STAT		Display file status.  [stat]
13641.116Slukem
13651.116SlukemTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
13661.116Slukem
13671.116SlukemTOOL_TBL		Format tables for groff.  [tbl]
13681.116Slukem
13691.116SlukemTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
13701.116Slukem
13711.116SlukemTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
13721.116Slukem
13731.116SlukemTOOL_ZIC		Time zone compiler.  [zic]
13741.116Slukem
13751.69Ssommerfe
13761.69SsommerfeOther variables of note (incomplete list):
13771.69Ssommerfe
13781.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
13791.82Slukem			WARNS=1
13801.82Slukem			WARNS=2
13811.82Slukem			WARNS=3
13821.164Smatt			WARNS=4
13831.69Ssommerfe
13841.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
13851.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
13861.75Sagc		WFORMAT belongs in individual makefiles and/or
13871.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
13881.75Sagc		makefiles if a program is not security critical and is
13891.75Sagc		doing bizarre things with format strings which would
13901.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
13911.120Slukem		mk.conf if you're doing format-string auditing.
13921.69Ssommerfe		FORMAT_AUDIT may go away in time.
13931.30Sagc
13941.144Slukem
13951.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
13961.144Slukem
13971.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
13981.144Slukemcross-building X11R6 from ${X11SRCDIR.xc}.
13991.144SlukemIt should be included after the general Makefile contents but before
14001.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
14011.144Slukem
14021.144SlukemIt provides the following targets:
14031.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
14041.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
14051.144Slukem		these rules convert from X11R6's manual page source
14061.144Slukem		into an mdoc.old source file.
14071.144Slukem	cleanx11man:
14081.144Slukem		Clean up the mdoc.old files generated by the above.
14091.144Slukem
14101.144SlukemIt sets the following variables:
14111.144Slukem
14121.144SlukemBINDIR			Set to ${X11BINDIR}.
14131.144Slukem			To override, define after including <bsd.x11.mk>
14141.144Slukem
14151.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
14161.144Slukem			To override, define after including <bsd.x11.mk>
14171.144Slukem
14181.144SlukemMANDIR			Set to ${X11MANDIR}.
14191.144Slukem			To override, define after including <bsd.x11.mk>
14201.144Slukem
14211.144SlukemCPPFLAGS		Appended with definitions to include from
14221.144Slukem			${DESTDIR}${X11INCDIR}
14231.144Slukem
14241.144SlukemLDFLAGS			Appended with definitions to link from
14251.144Slukem			${DESTDIR}${X11USRLIBDIR}
14261.144Slukem
14271.144SlukemX11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
14281.144Slukem
14291.144SlukemX11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
14301.144Slukem
14311.144SlukemX11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
14321.144Slukem
14331.144SlukemX11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
14341.144Slukem
14351.144SlukemX11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
14361.144Slukem
14371.144SlukemX11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
14381.144Slukem
14391.144SlukemX11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
14401.144Slukem
14411.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
14421.144Slukem
14431.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
14441.144Slukem
14451.144SlukemIt uses the following variables:
14461.144Slukem
14471.144SlukemAPPDEFS			List of app-default files to install.
14481.144Slukem
14491.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
14501.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
14511.144Slukem			have a `.cpp' suffix, the generated files do not.
14521.144Slukem
14531.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
14541.144Slukem
14551.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
14561.144Slukem
14571.144Slukem
14581.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1459