bsd.README revision 1.157
11.157Slukem#	$NetBSD: bsd.README,v 1.157 2004/12/29 14:46:24 lukem Exp $
21.24Smikel#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
31.1Scgd
41.1ScgdThis is the README file for the new make "include" files for the BSD
51.1Scgdsource tree.  The files are installed in /usr/share/mk, and are, by
61.11Sjtcconvention, named with the suffix ".mk".
71.1Scgd
81.1ScgdNote, this file is not intended to replace reading through the .mk
91.1Scgdfiles for anything tricky.
101.1Scgd
111.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
121.1Scgd
131.1ScgdRANDOM THINGS WORTH KNOWING:
141.1Scgd
151.1ScgdThe files are simply C-style #include files, and pretty much behave like
161.1Scgdyou'd expect.  The syntax is slightly different in that a single '.' is
171.1Scgdused instead of the hash mark, i.e. ".include <bsd.prog.mk>".
181.1Scgd
191.1ScgdOne difference that will save you lots of debugging time is that inclusion
201.1Scgdof the file is normally done at the *end* of the Makefile.  The reason for
211.1Scgdthis is because .mk files often modify variables and behavior based on the
221.1Scgdvalues of variables set in the Makefile.  To make this work, remember that
231.1Scgdthe FIRST target found is the target that is used, i.e. if the Makefile has:
241.1Scgd
251.1Scgd	a:
261.1Scgd		echo a
271.1Scgd	a:
281.1Scgd		echo a number two
291.1Scgd
301.1Scgdthe command "make a" will echo "a".  To make things confusing, the SECOND
311.1Scgdvariable assignment is the overriding one, i.e. if the Makefile has:
321.1Scgd
331.1Scgd	a=	foo
341.1Scgd	a=	bar
351.1Scgd
361.1Scgd	b:
371.1Scgd		echo ${a}
381.1Scgd
391.1Scgdthe command "make b" will echo "bar".  This is for compatibility with the
401.1Scgdway the V7 make behaved.
411.1Scgd
421.1ScgdIt's fairly difficult to make the BSD .mk files work when you're building
431.75Sagcmultiple programs in a single directory.  It's a lot easier to split up the
441.1Scgdprograms than to deal with the problem.  Most of the agony comes from making
451.36Srossthe "obj" directory stuff work right, not because we switched to a new version
461.1Scgdof make.  So, don't get mad at us, figure out a better way to handle multiple
471.1Scgdarchitectures so we can quit using the symbolic link stuff.  (Imake doesn't
481.1Scgdcount.)
491.1Scgd
501.1ScgdThe file .depend in the source directory is expected to contain dependencies
511.1Scgdfor the source files.  This file is read automatically by make after reading
521.1Scgdthe Makefile.
531.1Scgd
541.1ScgdThe variable DESTDIR works as before.  It's not set anywhere but will change
551.1Scgdthe tree where the file gets installed.
561.1Scgd
571.1ScgdThe profiled libraries are no longer built in a different directory than
581.1Scgdthe regular libraries.  A new suffix, ".po", is used to denote a profiled
591.21Schristosobject, and ".so" denotes a shared (position-independent) object.
601.97Sitojun
611.142SlukemThere are various make variables used during the build.
621.142Slukem
631.142SlukemMany variables support a (case sensitive) value of "no" or "yes",
641.142Slukemand are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
651.142Slukem
661.142Slukem
671.142SlukemThe basic rule for the variable naming scheme is as follows:
681.97Sitojun
691.129SlukemMKxxx		Can be set to "no" to disable functionality, or
701.129Slukem		"yes" to enable it.
711.129Slukem		Usually defaults to "yes", although some variables
721.129Slukem		default to "no".
731.129Slukem		Due to make(1) implementation issues, if a temporary
741.142Slukem		command-line override of a mk.conf or <bsd.own.mk>
751.142Slukem		setting is required whilst still honouring a particular
761.129Slukem		Makefile's setting of MKxxx, use
771.129Slukem			env MKxxx=value make
781.129Slukem		instead of
791.129Slukem			make MKxxx=value
801.97Sitojun
811.116SlukemNOxxx		If defined, disables a feature.
821.116Slukem		Not intended for users.
831.116Slukem		This is to allow Makefiles to disable functionality
841.116Slukem		that they don't support (such as missing man pages).
851.101Slukem		NOxxx variables must be defined before <bsd.own.mk>
861.101Slukem		is included.
871.21Schristos
881.45SlukemThe following variables that control how things are made/installed that
891.47Stvare not set by default. These should not be set by Makefiles; they're for
901.134Slukemthe user to define in MAKECONF (see <bsd.own.mk>, below) or on the make(1)
911.47Stvcommand line:
921.21Schristos
931.45SlukemBUILD 		If defined, 'make install' checks that the targets in the
941.45Slukem		source directories are up-to-date and remakes them if they
951.21Schristos                are out of date, instead of blindly trying to install
961.79Swiz                out of date or non-existent targets.
971.141Slukem
981.141SlukemMAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
991.141Slukem		Default: 2
1001.141Slukem		Supported values:
1011.141Slukem		    0	Minimal output ("quiet")
1021.141Slukem		    1	Describe what is occurring
1031.141Slukem		    2	Describe what is occurring and echo the actual command
1041.141Slukem
1051.21Schristos
1061.120SlukemMKBFD		If "no", don't build libbfd, libiberty, or any of the things
1071.120Slukem		that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage).
1081.120Slukem		Default: yes
1091.120Slukem
1101.121SlukemMKCATPAGES	If "no", don't build or install the catman pages.
1111.121Slukem		Default: yes
1121.121Slukem
1131.120SlukemMKCRYPTO	If "no", no cryptography support will be built into the system,
1141.142Slukem		and also acts as "MKKERBEROS=no MKKERBEROS4=no".
1151.120Slukem		Default: yes
1161.120Slukem
1171.120SlukemMKCRYPTO_IDEA	If not "no", IDEA support will be built into libcrypto_idea.a.
1181.120Slukem		Default: no
1191.52Ssimonb
1201.120SlukemMKCRYPTO_MDC2	If not "no", MDC2 support will be built into libcrypto_mdc2.a
1211.120Slukem		Default: no
1221.45Slukem
1231.120SlukemMKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
1241.120Slukem		Default: no
1251.86Sthorpej
1261.143SlukemMKCVS		If "no", don't build or install cvs(1).
1271.143Slukem		Default: yes
1281.143Slukem
1291.45SlukemMKDOC		If "no", don't build or install the documentation.
1301.120Slukem		Default: yes
1311.86Sthorpej
1321.104SlukemMKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
1331.104Slukem		don't install certain libraries in /lib, and don't
1341.104Slukem		install the shared linker into /libexec.
1351.120Slukem		Default: yes
1361.120Slukem
1371.143SlukemMKGCC		If "no", don't build gcc(1) or any of the gcc-related
1381.120Slukem		libraries (libg2c, libgcc, libobjc, libstdc++).
1391.120Slukem		Default: yes
1401.104Slukem
1411.143SlukemMKGCCCMDS	If "no", don't build gcc(1).
1421.143Slukem		Default: yes
1431.143Slukem
1441.143SlukemMKGDB		If "no", don't build gdb(1).
1451.120Slukem		Default: yes
1461.120Slukem
1471.120SlukemMKHESIOD	If "no", disables building of Hesiod infrastructure
1481.120Slukem		(libraries and support programs).
1491.120Slukem		Default: yes
1501.121Slukem
1511.142SlukemMKHOSTOBJ	If not "no", for programs intended to be run on the compile
1521.142Slukem		host, the name, release, and architecture of the host
1531.142Slukem		operating system will be suffixed to the name of the object
1541.142Slukem		directory created by "make obj".
1551.121Slukem		Default: no
1561.86Sthorpej
1571.120SlukemMKHTML		If "no", don't build or install the html man pages.
1581.120Slukem		Default: yes
1591.92Sross
1601.92SrossMKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
1611.92Sross		Has no effect on most platforms.
1621.120Slukem		Default: yes
1631.45Slukem
1641.47StvMKINFO		If "no", don't build or install Info documentation from
1651.47Stv		Texinfo source files.
1661.120Slukem		Default: yes
1671.120Slukem
1681.126SitojunMKKERBEROS4	If "no", disables building of Kerberos v4
1691.126Sitojun		infrastructure (libraries and support programs).
1701.126Sitojun		Default: yes
1711.126Sitojun
1721.126SitojunMKKERBEROS	If "no", disables building of Kerberos v5
1731.120Slukem		infrastructure (libraries and support programs).
1741.120Slukem		Default: yes
1751.120Slukem
1761.120SlukemMKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
1771.120Slukem		Also:
1781.120Slukem			- don't install the .a libraries
1791.120Slukem			- don't install _pic.a libraries on PIC systems
1801.120Slukem			- don't build .a libraries on PIC systems
1811.120Slukem			- don't install the .so symlink on ELF systems
1821.120Slukem		I.e, only install the shared library (and the .so.major
1831.120Slukem		symlink on ELF).
1841.120Slukem		Default: yes
1851.45Slukem
1861.45SlukemMKLINT		If "no", don't build or install the lint libraries.
1871.120Slukem		Default: yes
1881.45Slukem
1891.120SlukemMKMAN		If "no", don't build or install the man or catman pages,
1901.142Slukem		and also acts as "MKCATPAGES=no MKHTML=no".
1911.120Slukem		Default: yes
1921.45Slukem
1931.119SlukemMKMANZ		If not "no", compress manual pages at installation time.
1941.120Slukem		Default: no
1951.119Slukem
1961.74SitojunMKNLS		If "no", don't build or install the NLS files and locale
1971.74Sitojun		definition files.
1981.120Slukem		Default: yes
1991.45Slukem
2001.120SlukemMKOBJ		If "no", don't enable the rule which creates objdirs,
2011.142Slukem		and also acts as "MKOBJDIRS=no".
2021.120Slukem		Default: yes
2031.55Ssommerfe
2041.55SsommerfeMKOBJDIRS	If "no", don't create objdirs during a "make build".
2051.120Slukem		Default: no
2061.45Slukem
2071.120SlukemMKPIC		If "no", don't build or install shared libraries, and
2081.120Slukem		also acts as "MKPICLIB=no"
2091.147Sskrll		Default: yes (for MACHINE_ARCHs that support it) 
2101.45Slukem
2111.45SlukemMKPICINSTALL	If "no", don't install the *_pic.a libraries.
2121.120Slukem		Default: yes
2131.120Slukem
2141.120SlukemMKPICLIB	If "no", don't build *_pic.a libraries, and build the
2151.120Slukem		shared object libraries from the .a libraries.
2161.120Slukem		A symlink is installed in ${DESTDIR}/usr/lib for the
2171.120Slukem		_pic.a library pointing to the .a library.
2181.120Slukem		Default: yes
2191.45Slukem
2201.143SlukemMKPOSTFIX	If "no", don't build or install postfix(1).
2211.143Slukem		Default: yes
2221.143Slukem
2231.138SlukemMKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
2241.120Slukem		Default: yes
2251.120Slukem
2261.143SlukemMKSENDMAIL	If "no", don't build or install sendmail(8).
2271.143Slukem		Default: yes
2281.143Slukem
2291.120SlukemMKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
2301.120Slukem		MKMAN=no MKNLS=no".
2311.120Slukem		I.e, don't build catman pages, documentation, Info
2321.120Slukem		documentation, man pages, NLS files, ...
2331.120Slukem		Default: yes
2341.120Slukem
2351.120SlukemMKSKEY		If "no", disables building of S/key authentication
2361.120Slukem		infrastructure (libraries and support programs).
2371.120Slukem		Default: yes
2381.120Slukem
2391.120SlukemMKSOFTFLOAT	If not "no", build with options to enable the compiler to
2401.120Slukem		generate output containing library calls for floating
2411.120Slukem		point and possibly soft-float library support.
2421.120Slukem		Default: no
2431.138Slukem
2441.138SlukemMKSTATICLIB	If "no", don't build or install the normal static (*.a)
2451.138Slukem		libraries.
2461.138Slukem		Default: yes
2471.120Slukem
2481.120SlukemMKUNPRIVED	If not "no", don't set the owner/group/mode when installing
2491.120Slukem		files or directories, and keep a metadata log of what
2501.120Slukem		the owner/group/mode should be.  This allows a
2511.120Slukem		non-root "make install".
2521.120Slukem		Default: no
2531.120Slukem
2541.120SlukemMKUPDATE 	If not "no", 'make install' only installs targets that are
2551.120Slukem		more recently modified in the source directories that their
2561.120Slukem		installed counterparts.
2571.120Slukem		Default: no
2581.45Slukem
2591.143SlukemMKUUCP		If "no", don't build or install uucp(1).
2601.143Slukem		Default: yes
2611.143Slukem
2621.144SlukemMKX11		If not "no", 'make build' also descends into src/x11
2631.144Slukem		to cross build X11R6 and automatically enables creation
2641.144Slukem		of X sets.
2651.144Slukem		Default: no
2661.144Slukem
2671.120SlukemMKYP		If "no", disables building of YP (NIS)
2681.120Slukem		infrastructure (libraries and support programs).
2691.120Slukem		Default: yes
2701.1Scgd
2711.129SlukemUSE_HESIOD	If "no", disables building Hesiod support into
2721.122Slukem		various system utilities/libraries that support it.
2731.142Slukem		If ${MKHESIOD} is "no", USE_HESIOD will also be
2741.122Slukem		forced to "no".
2751.122Slukem
2761.129SlukemUSE_KERBEROS4	If "no", disables building Kerberos v4
2771.126Sitojun		support into various system utilities/libraries that
2781.142Slukem		support it.  If ${MKKERBEROS4} is "no", USE_KERBEROS4
2791.126Sitojun		will also be forced to "no".
2801.126Sitojun
2811.129SlukemUSE_KERBEROS	If "no", disables building Kerberos v4 or v5)
2821.122Slukem		support into various system utilities/libraries that
2831.142Slukem		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
2841.122Slukem		will also be forced to "no".
2851.122Slukem
2861.129SlukemUSE_SKEY	If "no", disables building S/key authentication
2871.122Slukem		support into various system utilities/libraries that
2881.142Slukem		support it.  If ${MKSKEY} is "no", USE_SKEY will
2891.122Slukem		also be forced to "no".
2901.122Slukem
2911.129SlukemUSE_YP		If "no", disables building YP (NIS) support into
2921.129Slukem		various system utilities/libraries that support it.
2931.142Slukem		If ${MKYP} is "no", USE_YP will also be forced to "no".
2941.122Slukem
2951.136SerhCOPTS.lib<lib>
2961.136SerhLDADD.lib<lib>
2971.136SerhCPPFLAGS.lib<lib>
2981.136SerhCXXFLAGS.lib<lib>
2991.136SerhCOPTS.<prog>
3001.136SerhLDADD.<prog>
3011.136SerhCPPFLAGS.<prog>
3021.137SsimonbCXXFLAGS.<prog>	These provide a way to specify additions to the associated
3031.137Ssimonb		variables in a way that applies only to a particular library
3041.137Ssimonb		or program.  <lib> corresponds to the LIB variable set in
3051.137Ssimonb		the library's makefile.  <prog> corresponds to either PROG
3061.137Ssimonb		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
3071.137Ssimonb		set to "-g", "-g" will be added to COPTS only when compiling
3081.137Ssimonb		the crypto library.
3091.118Slukem
3101.118Slukem=-=-=-=-=   sys.mk   =-=-=-=-=
3111.1Scgd
3121.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD
3131.1Scgdenvironment or otherwise.  You probably don't want to touch this file.
3141.1Scgd
3151.118Slukem=-=-=-=-=   bsd.own.mk   =-=-=-=-=
3161.1Scgd
3171.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters,
3181.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and
3191.17Sthorpeja few global "feature configuration" parameters.
3201.1Scgd
3211.1ScgdIt has no targets.
3221.1Scgd
3231.134SlukemTo get system-specific configuration parameters, <bsd.own.mk> will try to
3241.29Scjsinclude the file specified by the "MAKECONF" variable.  If MAKECONF is not
3251.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf
3261.29Scjsis included.  These files may define any of the variables described below.
3271.17Sthorpej
3281.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
3291.17Sthorpej(defaults are in brackets):
3301.15Scgd
3311.98SlukemNETBSDSRCDIR	Top of the NetBSD source tree.
3321.98Slukem		If _SRC_TOP_ != "", that will be used as the default,
3331.98Slukem		otherwise BSDSRCDIR will be used as the default.
3341.98Slukem		Various makefiles within the NetBSD source tree will
3351.98Slukem		use this to reference the top level of the source tree.
3361.98Slukem
3371.95Slukem_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
3381.98Slukem		based on the presence of tools/ and build.sh.  This variable
3391.98Slukem		is "internal" to <bsd.own.mk>, although its value is only
3401.98Slukem		determined once and then propagated to all sub-makes.
3411.95Slukem
3421.15ScgdBSDSRCDIR	The real path to the system sources, so that 'make obj'
3431.116Slukem		will work correctly.  [/usr/src]
3441.15Scgd
3451.15ScgdBSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
3461.116Slukem		will work correctly.  [/usr/obj]
3471.15Scgd
3481.116SlukemBINGRP		Binary group.  [wheel]
3491.15Scgd
3501.116SlukemBINOWN		Binary owner.  [root]
3511.15Scgd
3521.116SlukemBINMODE		Binary mode.  [555]
3531.15Scgd
3541.116SlukemNONBINMODE	Mode for non-executable files.  [444]
3551.15Scgd
3561.116SlukemMANDIR		Base path for manual installation.  [/usr/share/man/cat]
3571.15Scgd
3581.116SlukemMANGRP		Manual group.  [wheel]
3591.15Scgd
3601.116SlukemMANOWN		Manual owner.  [root]
3611.15Scgd
3621.116SlukemMANMODE		Manual mode.  [${NONBINMODE}]
3631.15Scgd
3641.21SchristosMANINSTALL	Manual installation type: maninstall, catinstall, or both
3651.155Sjmc		[maninstall catinstall]
3661.76Sfair
3671.76SfairLDSTATIC	Control program linking; if set blank, link everything
3681.129Slukem		dynamically.  If set to "-static", link everything statically.
3691.76Sfair		If not set, programs link according to their makefile.
3701.21Schristos
3711.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
3721.15Scgd
3731.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
3741.15Scgd
3751.116SlukemLIBGRP		Library group.  [${BINGRP}]
3761.15Scgd
3771.116SlukemLIBOWN		Library owner.  [${BINOWN}]
3781.15Scgd
3791.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
3801.15Scgd
3811.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
3821.116Slukem	        installation.  [/usr/share/doc]
3831.62Ssimonb
3841.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
3851.62Ssimonb		[/usr/share/doc/html]
3861.15Scgd
3871.116SlukemDOCGRP		Documentation group.  [wheel]
3881.15Scgd
3891.116SlukemDOCOWN		Documentation owner.  [root]
3901.15Scgd
3911.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
3921.15Scgd
3931.84SkleinkNLSDIR		Base path for Native Language Support files installation.
3941.15Scgd		[/usr/share/nls]
3951.1Scgd
3961.116SlukemNLSGRP		Native Language Support files group.  [wheel]
3971.1Scgd
3981.116SlukemNLSOWN		Native Language Support files owner.  [root]
3991.1Scgd
4001.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
4011.1Scgd
4021.144SlukemX11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
4031.144Slukem
4041.144SlukemX11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
4051.144Slukem
4061.144SlukemX11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
4071.144Slukem
4081.144SlukemX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
4091.144Slukem
4101.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
4111.144Slukem
4121.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
4131.144Slukem
4141.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
4151.144Slukem
4161.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
4171.144Slukem
4181.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
4191.144Slukem
4201.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
4211.144Slukem
4221.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
4231.1Scgd		to be stripped.  This is to be used when building your
4241.1Scgd		own install script so that the entire system can be made
4251.146Slukem		stripped/not-stripped using a single knob.  []
4261.1Scgd
4271.2ScgdCOPY		The flag passed to the install program to cause the binary
4281.2Scgd		to be copied rather than moved.  This is to be used when
4291.2Scgd		building our own install script so that the entire system
4301.2Scgd		can either be installed with copies, or with moves using
4311.116Slukem		a single knob.  [-c]
4321.15Scgd
4331.150SlukemMAKEDIRTARGET dir target [params]
4341.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
4351.150Slukem		displaying a "pretty" message whilst doing so.
4361.150Slukem
4371.152SclRELEASEMACHINEDIR
4381.152Scl		Subdirectory used below RELEASEDIR when building
4391.152Scl		a release.  [${MACHINE}]
4401.152Scl
4411.152SclRELEASEMACHINE	Subdirectory or path component used for the following
4421.152Scl		paths:
4431.152Scl			distrib/${RELEASEMACHINE}
4441.152Scl			distrib/notes/${RELEASEMACHINE}
4451.152Scl			etc/etc.${RELEASEMACHINE}
4461.152Scl		Used when building a release.  [${MACHINE}]
4471.150Slukem
4481.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
4491.17Sthorpejmake configuration file to modify the behaviour of the system build
4501.17Sthorpejprocess (default values are in brackets along with comments, if set by
4511.134Slukem<bsd.own.mk>):
4521.33Sjonathan
4531.142SlukemUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
4541.142Slukem		be used as part of a build in progress.
4551.142Slukem		Supported values:
4561.142Slukem
4571.142Slukem		yes	Use the tools from TOOLDIR.
4581.142Slukem			Must be set to this if cross-compiling.
4591.142Slukem
4601.142Slukem		no	Do not use the tools from TOOLDIR, but refuse to
4611.142Slukem			build native compilation tool components that are
4621.142Slukem			version-specific for that tool.
4631.142Slukem
4641.142Slukem		never	Do not use the tools from TOOLDIR, even when
4651.142Slukem			building native tool components.  This is similar to
4661.142Slukem			the traditional NetBSD build method, but does not
4671.142Slukem			verify that the compilation tools in use are
4681.142Slukem			up-to-date enough in order to build the tree
4691.142Slukem			successfully.  This may cause build or runtime
4701.142Slukem			problems when building the whole NetBSD source tree.
4711.142Slukem
4721.142Slukem		Default: "yes" if building all or part of a whole NetBSD
4731.142Slukem		source tree (detected automatically); "no" otherwise
4741.142Slukem		(to preserve traditional semantics of the <bsd.*.mk>
4751.142Slukem		make(1) include files).
4761.142Slukem
4771.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
4781.156Stron		use ELF -- currently all architectures but ns32k, set to
4791.156Stron		"a.out" on ns32k].
4801.33Sjonathan
4811.103SthorpejTOOLCHAIN_MISSING
4821.142Slukem		If not "no", this indicates that the platform being built
4831.103Sthorpej		does not have a working in-tree toolchain.  If the
4841.142Slukem		${MACHINE_ARCH} in question falls into this category,
4851.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
4861.103Sthorpej		Otherwise, the variable is unconditionally assigned the
4871.103Sthorpej		value "no".
4881.142Slukem		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
4891.142Slukem		unconditionally assigned the value "no".
4901.103Sthorpej
4911.103SthorpejEXTERNAL_TOOLCHAIN
4921.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
4931.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
4941.103Sthorpej		access to this variable.  The variable should be defined
4951.103Sthorpej		either in the user's environment or in the user's mk.conf
4961.103Sthorpej		file.  If defined, this variable indicates the root of
4971.103Sthorpej		an external toolchain which will be used to build the
4981.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
4991.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
5001.103Sthorpej		cross-compile framework.
5011.103Sthorpej
5021.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
5031.142Slukem		assigned the value "no", since the external version of the
5041.142Slukem		compiler may not be able to build the library components of
5051.142Slukem		the in-tree compiler.
5061.103Sthorpej
5071.103Sthorpej		NOTE: This variable is not yet used in as many places as
5081.103Sthorpej		it should be.  Expect the exact semantics of this variable
5091.103Sthorpej		to change in the short term as parts of the cross-compile
5101.103Sthorpej		framework continue to be cleaned up.
5111.1Scgd
5121.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
5131.1Scgdthey use the same default owners etc. as the rest of the tree.
5141.131Slukem
5151.131Slukem
5161.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
5171.131Slukem
5181.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
5191.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
5201.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
5211.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
5221.133Slukemdependencies for the .d files.  In order for this to function correctly,
5231.132Slukemit should be .included after all other .mk files and directives that may
5241.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
5251.132Slukem
5261.132SlukemSRCS		List of source files to build the program.
5271.132Slukem
5281.132SlukemDPSRCS		List of source files which are needed for generating
5291.132Slukem		dependencies, but are not needed in ${SRCS}.
5301.1Scgd
5311.1Scgd
5321.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
5331.106Sthorpej
5341.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
5351.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
5361.124Slukem
5371.124SlukemFILES		The list of files to install.
5381.124Slukem
5391.153SlukemCONFIGFILES	Similar semantics to FILES, except that the files
5401.153Slukem		are installed by the `configinstall' target,
5411.153Slukem		not the `install' target.
5421.153Slukem		The FILES* variables documented below also apply.
5431.153Slukem
5441.124SlukemFILESOWN	File owner.  [${BINOWN}]
5451.124Slukem
5461.124SlukemFILESGRP	File group.  [${BINGRP}]
5471.124Slukem
5481.124SlukemFILESMODE	File mode.  [${BINMODE}]
5491.124Slukem
5501.124SlukemFILESDIR	The location to install the files.
5511.124Slukem
5521.124SlukemFILESNAME	Optional name to install each file as.
5531.124Slukem
5541.153SlukemFILESOWN_<fn>	File owner of the specific file <fn>.
5551.153Slukem
5561.153SlukemFILESGRP_<fn>	File group of the specific file <fn>.
5571.153Slukem
5581.153SlukemFILESMODE_<fn>	File mode of the specific file <fn>.
5591.153Slukem
5601.153SlukemFILESDIR_<fn>	The location to install the specific file <fn>>
5611.153Slukem
5621.153SlukemFILESNAME_<fn>	Optional name to install <fn> as.
5631.124Slukem
5641.135Slukem
5651.139SlukemBUILDSYMLINKS	List of two word items:
5661.135Slukem			lnsrc lntgt
5671.135Slukem		For each lnsrc item, create a symlink named lntgt.
5681.135Slukem		The lntgt symlinks are removed by the cleandir target.
5691.106Sthorpej
5701.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
5711.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
5721.148Sjmc		The source files have a `.uue' suffix, the generated files do 
5731.148Sjmc		not.
5741.149Sjmc
5751.149SjmcUUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
5761.148Sjmc		
5771.148Sjmc		*NOTE: These files are simply decoded, with no install or other
5781.148Sjmc		       rule applying implicitly except being added to the clean
5791.148Sjmc		       target.
5801.106Sthorpej
5811.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
5821.113Sthorpej
5831.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
5841.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
5851.134Slukembefore <bsd.gcc.mk>.
5861.113Sthorpej
5871.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
5881.113Sthorpejof which need to know where to find certain GCC support libraries.
5891.113Sthorpej
5901.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
5911.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
5921.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
5931.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
5941.113Sthorpej
5951.134Slukem<bsd.gcc.mk> sets the following variables:
5961.113Sthorpej
5971.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
5981.118Slukem
5991.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
6001.118Slukem
6011.118Slukem_GCC_CRTEND	The full path name to crtend.o.
6021.118Slukem
6031.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
6041.118Slukem
6051.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
6061.118Slukem
6071.118Slukem
6081.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
6091.118Slukem
6101.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
6111.118Slukemvariables:
6121.118Slukem
6131.124SlukemINCS		The list of include files.
6141.118Slukem
6151.118SlukemINCSDIR		The location to install the include files.
6161.118Slukem
6171.118SlukemINCSNAME	Target name of the include file, if only one; same as
6181.118Slukem		FILESNAME, but for include files.
6191.118Slukem
6201.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
6211.134Slukem		are installed in the 'includes' target and not the
6221.134Slukem		(much later) 'install' target.
6231.134Slukem
6241.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
6251.118Slukem		same as FILESNAME_<file>, but for include files.
6261.118Slukem
6271.118Slukem
6281.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
6291.118Slukem
6301.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
6311.118Slukemdocumentation from respective Texinfo source files.  It defines three
6321.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
6331.118Slukemfollowing variables:
6341.118Slukem
6351.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
6361.118Slukem		consist of single files with the extension replaced by
6371.118Slukem		.info.
6381.118Slukem
6391.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
6401.118Slukem
6411.118Slukem
6421.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
6431.118Slukem
6441.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
6451.118Slukemlocation of kernel sources and object directories.
6461.118Slukem
6471.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
6481.124Slukem		[${_SRC_TOP_}/sys]
6491.118Slukem
6501.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
6511.124Slukem		[arch/${MACHINE}]
6521.120Slukem
6531.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
6541.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
6551.118Slukem
6561.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
6571.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
6581.118Slukem		The default value is
6591.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
6601.118Slukem		if it exists or the target 'obj' is being made.
6611.118Slukem		Otherwise the default is
6621.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
6631.118Slukem
6641.118SlukemIt is important that Makefiles (such as those under src/distrib) that
6651.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
6661.118Slukemrather than make assumptions about the location of the compiled kernel.
6671.118Slukem
6681.118Slukem
6691.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
6701.118Slukem
6711.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
6721.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
6731.118Slukeminclude file installation.  It is intended to be included alone, by
6741.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
6751.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
6761.134Slukemin that file up to date.
6771.118Slukem
6781.118Slukem
6791.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
6801.118Slukem
6811.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
6821.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
6831.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
6841.118Slukemwhich checks for installed shared object libraries whose version is greater
6851.118Slukemthat the version of the source. It has a limited number of suffixes,
6861.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
6871.118Slukem<bsd.shlib.mk> to get shared library parameters.
6881.118Slukem
6891.118SlukemIt sets/uses the following variables:
6901.118Slukem
6911.118SlukemLIB		The name of the library to build.
6921.118Slukem
6931.118SlukemLIBDIR		Target directory for libraries.
6941.118Slukem
6951.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
6961.142Slukem		is not "no".
6971.118Slukem
6981.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
6991.118Slukem		as the path to install shared libraries to.
7001.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
7011.130Slukem		Default: no
7021.118Slukem
7031.154SlukemMKPRIVATELIB	If not "no", act as "MKPROFILE=no MKPIC=no MKLINT=no",
7041.154Slukem		and don't install the (.a) library.
7051.154Slukem		This is useful for "build only" helper libraries.
7061.154Slukem		Default: no
7071.154Slukem
7081.118SlukemLINTLIBDIR	Target directory for lint libraries.
7091.118Slukem
7101.118SlukemLIBGRP		Library group.
7111.118Slukem
7121.118SlukemLIBOWN		Library owner.
7131.118Slukem
7141.118SlukemLIBMODE		Library mode.
7151.118Slukem
7161.118SlukemLDADD		Additional loader objects.
7171.118Slukem
7181.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
7191.118Slukem
7201.118SlukemNOCHECKVER_<library>
7211.118SlukemNOCHECKVER	If set, disables checking for installed shared object
7221.118Slukem		libraries with versions greater than the source.  A
7231.118Slukem		particular library name, without the "lib" prefix, may
7241.118Slukem		be appended to the variable name to disable the check for
7251.118Slukem		only that library.
7261.118Slukem
7271.118SlukemSRCS		List of source files to build the library.  Suffix types
7281.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
7291.118Slukem		to .c files of the same name.  (This is not the default for
7301.118Slukem		versions of make.)
7311.118Slukem
7321.157SlukemLIBDPLIBS	A list of the tuples:
7331.157Slukem			libname  path-to-srcdir-of-libname
7341.157Slukem
7351.157Slukem		For each tuple;
7361.157Slukem		     *	LIBDO.libname contains the .OBJDIR of the library
7371.157Slukem			`libname', and if it is not set it is determined
7381.157Slukem			from the srcdir and added to MAKEOVERRIDES (the
7391.157Slukem			latter is to allow for build time optimization).
7401.157Slukem		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
7411.157Slukem		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
7421.157Slukem				    ${LIBDO.libname}/liblibname.a   added.
7431.157Slukem
7441.157Slukem		This variable may be used for individual libraries, as
7451.157Slukem		well as in parent directories to cache common libraries 
7461.157Slukem		as a build-time optimization.
7471.157Slukem
7481.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
7491.118Slukemif it exists, as well as the include file <bsd.man.mk>.
7501.118Slukem
7511.118SlukemIt has rules for building profiled objects; profiled libraries are
7521.118Slukembuilt by default.
7531.118Slukem
7541.118SlukemLibraries are ranlib'd when made.
7551.118Slukem
7561.118Slukem
7571.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
7581.118Slukem
7591.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
7601.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
7611.134Slukem
7621.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
7631.134Slukem			source-file target-file
7641.134Slukem		${DESTDIR} is prepended to both paths before linking.
7651.134Slukem		For example, to link /bin/test and /bin/[, use:
7661.134Slukem			LINKS=/bin/test /bin/[
7671.134Slukem
7681.153SlukemCONFIGLINKS	Similar semantics to LINKS, except that the links
7691.153Slukem		are installed by the `configinstall' target,
7701.153Slukem		not the `install' target.
7711.153Slukem
7721.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
7731.134Slukem			source-file target-file
7741.134Slukem		${DESTDIR} is only prepended to target-file before linking.
7751.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
7761.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
7771.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
7781.118Slukem
7791.153SlukemCONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
7801.153Slukem		are installed by the `configinstall' target,
7811.153Slukem		not the `install' target.
7821.153Slukem
7831.118Slukem
7841.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
7851.118Slukem
7861.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
7871.118Slukemlinks.
7881.118Slukem
7891.118SlukemIt has a two targets:
7901.118Slukem
7911.118Slukem	maninstall:
7921.118Slukem		Install the manual page sources and their links.
7931.118Slukem	catinstall:
7941.118Slukem		Install the preformatted manual pages and their links.
7951.118Slukem
7961.118SlukemIt sets/uses the following variables:
7971.118Slukem
7981.118SlukemMANDIR		Base path for manual installation.
7991.118Slukem
8001.118SlukemMANGRP		Manual group.
8011.118Slukem
8021.118SlukemMANOWN		Manual owner.
8031.118Slukem
8041.118SlukemMANMODE		Manual mode.
8051.118Slukem
8061.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
8071.118Slukem		or "/tahoe" for machine specific manual pages.
8081.118Slukem
8091.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
8101.118Slukem
8111.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
8121.118Slukem		linked-to file must come first, the linked file second,
8131.118Slukem		and there may be multiple pairs.  The files are soft-linked.
8141.118Slukem
8151.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
8161.118Slukemit exists.
8171.118Slukem
8181.118Slukem
8191.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
8201.118Slukem
8211.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
8221.118Slukemand use of separated object and source directories.
8231.118Slukem
8241.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
8251.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
8261.118Slukemit exists.  Otherwise make(1) looks for the existence of a
8271.118Slukemsubdirectory (or a symlink to a directory) of the source directory
8281.118Slukeminto which built targets should be placed.  If an environment variable
8291.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
8301.118Slukemobject directory; failing that, make first looks for a subdirectory
8311.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
8321.118Slukem
8331.118SlukemObject directories are not created automatically by make(1) if they
8341.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
8351.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
8361.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
8371.118Slukemand this is determined by a simple string prefix comparison -- object
8381.118Slukemdirectories are created in a separate object directory tree, and a
8391.118Slukemsymlink to the object directory in that tree is created in the source
8401.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
8411.118Slukemsource tree and that it's not safe to use a separate object tree.
8421.118Slukem
8431.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
8441.118Slukemdirectories and links get created during a "make obj":
8451.118Slukem
8461.118SlukemMAKEOBJDIR	If set, this is the component name of the object
8471.118Slukem		directory.
8481.118Slukem
8491.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
8501.118Slukem		object directories or links named "obj.${MACHINE}";
8511.118Slukem		otherwise, just creates ones named "obj".
8521.118Slukem
8531.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
8541.118Slukem		${BSDSRCDIR}, create object directory in the
8551.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
8561.118Slukem		otherwise, create it in the corresponding subdirectory
8571.118Slukem		of ${BSDOBJDIR}
8581.113Sthorpej
8591.118SlukemBUILDID		If set, the contents of this variable are appended
8601.118Slukem		to the object directory name.  If OBJMACHINE is also
8611.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
8621.113Sthorpej
8631.106Sthorpej
8641.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
8651.106Sthorpej
8661.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
8671.1Scgdmore source files, along with their manual pages.  It has a limited number
8681.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
8691.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
8701.1Scgd
8711.16SjtcIt has eight targets:
8721.1Scgd
8731.1Scgd	all:
8741.102Sthorpej		build the program and its manual page.  This also
8751.102Sthorpej		creates a GDB initialization file (.gdbinit) in
8761.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
8771.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
8781.1Scgd	clean:
8791.1Scgd		remove the program, any object files and the files a.out,
8801.24Smikel		Errs, errs, mklog, and ${PROG}.core.
8811.1Scgd	cleandir:
8821.1Scgd		remove all of the files removed by the target clean, as
8831.1Scgd		well as .depend, tags, and any manual pages.
8841.42Slukem		`distclean' is a synonym for `cleandir'.
8851.1Scgd	depend:
8861.1Scgd		make the dependencies for the source files, and store
8871.1Scgd		them in the file .depend.
8881.16Sjtc	includes:
8891.16Sjtc		install any header files.
8901.1Scgd	install:
8911.1Scgd		install the program and its manual pages; if the Makefile
8921.1Scgd		does not itself define the target install, the targets
8931.1Scgd		beforeinstall and afterinstall may also be used to cause
8941.1Scgd		actions immediately before and after the install target
8951.1Scgd		is executed.
8961.1Scgd	lint:
8971.1Scgd		run lint on the source files
8981.1Scgd	tags:
8991.1Scgd		create a tags file for the source files.
9001.1Scgd
9011.1ScgdIt sets/uses the following variables:
9021.1Scgd
9031.1ScgdBINGRP		Binary group.
9041.1Scgd
9051.1ScgdBINOWN		Binary owner.
9061.1Scgd
9071.1ScgdBINMODE		Binary mode.
9081.1Scgd
9091.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
9101.1Scgd
9111.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
9121.112Sthorpej
9131.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
9141.125Slukem		C objects for <fn>.
9151.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9161.125Slukem
9171.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
9181.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
9191.35Slukem
9201.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
9211.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9221.125Slukem
9231.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
9241.125Slukem
9251.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
9261.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
9271.102Sthorpej
9281.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
9291.102Sthorpej		directives in the .gdbinit file that is created in the
9301.102Sthorpej		objdir.
9311.1Scgd
9321.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
9331.1Scgd		For example, to load with the compatibility and utility
9341.1Scgd		libraries, use:
9351.1Scgd
9361.5Sjtc			LDADD+=-lutil -lcompat
9371.1Scgd
9381.1ScgdLDFLAGS		Additional loader flags.
9391.1Scgd
9401.134SlukemLINKS		See <bsd.links.mk>
9411.134Slukem
9421.134SlukemSYMLINKS	See <bsd.links.mk>
9431.1Scgd
9441.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
9451.8Scgd		defined, "MAN=${PROG}.1" is assumed.
9461.1Scgd
9471.1ScgdPROG		The name of the program to build.  If not supplied, nothing
9481.1Scgd		is built.
9491.1Scgd
9501.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
9511.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
9521.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
9531.88Sthorpej		the value of PROG if PROG is also set.
9541.87Sthorpej
9551.21SchristosPROGNAME	The name that the above program will be installed as, if
9561.21Schristos		different from ${PROG}.
9571.21Schristos
9581.37StvSRCS		List of source files to build the program.  If SRCS is not
9591.1Scgd		defined, it's assumed to be ${PROG}.c.
9601.108Sjwise
9611.108SjwiseDPSRCS		List of source files which are needed for generating
9621.108Sjwise		dependencies, but are not needed in ${SRCS}.
9631.1Scgd
9641.1ScgdDPADD		Additional dependencies for the program.  Usually used for
9651.1Scgd		libraries.  For example, to depend on the compatibility and
9661.1Scgd		utility libraries use:
9671.1Scgd
9681.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
9691.1Scgd
9701.1Scgd		The following libraries are predefined for DPADD:
9711.1Scgd
9721.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
9731.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
9741.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
9751.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
9761.99Sitojun		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
9771.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
9781.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
9791.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
9801.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
9811.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
9821.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
9831.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
9841.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
9851.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
9861.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
9871.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
9881.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
9891.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
9901.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
9911.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
9921.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
9931.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
9941.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
9951.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
9961.99Sitojun		LIBKADM?=	${DESTDIR}/usr/lib/libkadm.a
9971.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
9981.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
9991.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
10001.21Schristos		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
10011.21Schristos		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
10021.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
10031.99Sitojun		LIBKSTREAM?=	${DESTDIR}/usr/lib/libkstream.a
10041.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
10051.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
10061.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
10071.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
10081.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
10091.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
10101.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
10111.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
10121.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
10131.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
10141.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
10151.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
10161.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
10171.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
10181.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
10191.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
10201.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
10211.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
10221.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
10231.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
10241.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
10251.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
10261.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
10271.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
10281.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
10291.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
10301.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
10311.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
10321.1Scgd
10331.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
10341.12Schristos		strings, using xstr(1). Note that this will not work with
10351.12Schristos		parallel makes.
10361.1Scgd
10371.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
10381.1Scgd		to be stripped.
10391.1Scgd
10401.1ScgdSUBDIR		A list of subdirectories that should be built as well.
10411.1Scgd		Each of the targets will execute the same target in the
10421.1Scgd		subdirectories.
10431.1Scgd
10441.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
10451.21Schristos		These are installed exactly like programs.
10461.21Schristos
10471.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
10481.21Schristos		different from ${SCRIPTS}. These can be further specialized
10491.21Schristos		by setting SCRIPTSNAME_<script>.
10501.21Schristos
10511.124SlukemFILES		See description of <bsd.files.mk>.
10521.21Schristos
10531.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
10541.106Sthorpej		<bsd.own.mk> for additional information about this variable.
10551.130Slukem
10561.130SlukemUSE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
10571.130Slukem		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
10581.130Slukem		Default: yes
10591.85Slukem
10601.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
10611.1Scgdif it exists, as well as the include file <bsd.man.mk>.
10621.1Scgd
10631.1ScgdSome simple examples:
10641.1Scgd
10651.1ScgdTo build foo from foo.c with a manual page foo.1, use:
10661.1Scgd
10671.1Scgd	PROG=	foo
10681.1Scgd
10691.1Scgd	.include <bsd.prog.mk>
10701.1Scgd
10711.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
10721.1Scgd
10731.9Scgd	MAN=	foo.2
10741.1Scgd
10751.1ScgdIf foo does not have a manual page at all, add the line:
10761.1Scgd
10771.75Sagc	MKMAN=	no
10781.1Scgd
10791.1ScgdIf foo has multiple source files, add the line:
10801.1Scgd
10811.1Scgd	SRCS=	a.c b.c c.c d.c
10821.1Scgd
10831.1Scgd
10841.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
10851.118Slukem
10861.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
10871.118Slukemconstruct source files built by rpcgen.
10881.72Ssommerfe
10891.118SlukemThe following macros may be defined in makefiles which include
10901.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
10911.118Slukemare to be built:
10921.21Schristos
10931.118SlukemRPC_INCS:	construct .h file from .x file
10941.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
10951.118Slukem		(for marshalling/unmarshalling data types)
10961.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
10971.118Slukem		(server-side stubs)
10981.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
10991.21Schristos
11001.118SlukemRPC_XDIR:	Directory containing .x/.h files
11011.23Schristos
11021.23Schristos
11031.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
11041.21Schristos
11051.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
11061.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
11071.134Slukemincluded before <bsd.shlib.mk>.
11081.21Schristos
11091.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
11101.118Slukem(defaults are in brackets):
11111.21Schristos
11121.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
11131.142Slukem		instead of ${LIBDIR} as the base path for shared library
11141.142Slukem		installation.  [/lib]
11151.21Schristos
11161.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
11171.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
11181.118Slukem		for all others.]
11191.81Swiz
11201.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
11211.118Slukem		otherwise set to ${LIBDIR}
11221.81Swiz
11231.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
11241.39Scgd
11251.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
11261.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
11271.118Slukem		all others.]
11281.39Scgd
11291.13Schristos
11301.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
11311.13Schristos
11321.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
11331.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
11341.118Slukemclean, cleandir, depend, includes, install, lint, and tags.  For all of
11351.142Slukemthe directories listed in ${SUBDIR}, the specified directory will be
11361.142Slukemvisited and the target made.  There is also a default target which allows
11371.142Slukemthe command "make subdir" where subdir is any directory listed in ${SUBDIR}.
11381.47Stv
11391.118SlukemAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
11401.118Slukemas a synchronization barrier when multiple make jobs are run; subdirs
11411.118Slukembefore the .WAIT must complete before any subdirs after .WAIT are
11421.118Slukemstarted.  See make(1) for some caveats on use of .WAIT and other
11431.118Slukemspecial sources.
11441.47Stv
11451.47Stv
11461.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
11471.47Stv
11481.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
11491.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
11501.133Slukemthe NetBSD source tree.
11511.133Slukem
11521.133SlukemThe following variables control how various files are compiled/built.
11531.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
11541.133Slukem
11551.133SlukemAR		Create, modify, and extract from archives.  [ar]
11561.133Slukem
11571.133SlukemARFLAGS		Options to ${AR}.  [rl]
11581.133Slukem
11591.151SlukemAS		Assembler.  [as]
11601.151Slukem
11611.151SlukemAFLAGS		Options to ${AS}.  []
11621.151Slukem
11631.133SlukemCC		C compiler.  [cc]
11641.133Slukem
11651.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
11661.133Slukem
11671.133SlukemCPP		C Pre-Processor.  [cpp]
11681.133Slukem
11691.133SlukemCPPFLAGS	Options to ${CPP}.  []
11701.133Slukem
11711.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
11721.133Slukem
11731.133SlukemCXX		C++ compiler.  [c++]
11741.133Slukem
11751.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
11761.133Slukem
11771.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
11781.133Slukem
11791.133SlukemFC		Fortran compiler.  [f77]
11801.133Slukem
11811.133SlukemFFLAGS		Options to {$FC}.  [-O]
11821.133Slukem
11831.133SlukemINSTALL		install(1) command.  [install]
11841.133Slukem
11851.133SlukemLEX		Lexical analyzer.  [lex]
11861.133Slukem
11871.133SlukemLFLAGS		Options to ${LEX}.  []
11881.133Slukem
11891.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
11901.145Sjwise
11911.133SlukemLD		Linker.  [ld]
11921.133Slukem
11931.133SlukemLDFLAGS		Options to ${LD}.  []
11941.133Slukem
11951.133SlukemLINT		C program verifier.  [lint]
11961.133Slukem
11971.133SlukemLINTFLAGS	Options to ${LINT}.  [-chapbxzF]
11981.133Slukem
11991.133SlukemLORDER		List dependencies for object files.  [lorder]
12001.133Slukem
12011.133SlukemMAKE		make(1).  [make]
12021.133Slukem
12031.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
12041.133Slukem
12051.133SlukemNM		List symbols from object files.  [nm]
12061.133Slukem
12071.133SlukemPC		Pascal compiler.  [pc]  (Not present)
12081.133Slukem
12091.133SlukemPFLAGS		Options to ${PC}.  []
12101.133Slukem
12111.133SlukemOBJC		Objective C compiler.  [${CC}]
12121.133Slukem
12131.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
12141.133Slukem
12151.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
12161.133Slukem
12171.133SlukemRANLIB		Generate index to archive.  [ranlib]
12181.133Slukem
12191.133SlukemSHELL		Shell.  [sh]
12201.133Slukem
12211.133SlukemSIZE		List section sizes and total size.  [size]
12221.133Slukem
12231.133SlukemSTRIP		Discard symbols from object files.  [strip]
12241.133Slukem
12251.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
12261.133Slukem
12271.133SlukemYACC		LALR(1) parser generator.  [yacc]
12281.133Slukem
12291.133SlukemYFLAGS		Options to ${YACC}.  []
12301.133Slukem
12311.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
12321.133Slukem		from <file>.y to <file>.h and <file>.c, and add
12331.133Slukem		<foo>.h to CLEANFILES.
12341.133Slukem
12351.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
12361.133Slukem
12371.116Slukem
12381.116SlukemThe following variables are defined to commands to perform the
12391.116Slukemappropriate operation, with the default in [brackets].
12401.142Slukem(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
12411.116Slukem
12421.116SlukemTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
12431.116Slukem
12441.116SlukemTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
12451.116Slukem
12461.116SlukemTOOL_CAT		Concatenate and print files.  [cat]
12471.116Slukem
12481.116SlukemTOOL_CKSUM		Display file checksums.  [cksum]
12491.116Slukem
12501.116SlukemTOOL_COMPILE_ET		Error table compiler.  [compile_et]
12511.116Slukem
12521.116SlukemTOOL_CONFIG		Build kernel compilation directories.  [config]
12531.116Slukem
12541.116SlukemTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
12551.116Slukem
12561.116SlukemTOOL_CTAGS		Create a tags file.  [ctags]
12571.116Slukem
12581.116SlukemTOOL_DB			Manipulate db(3) databases.  [db]
12591.116Slukem
12601.116SlukemTOOL_EQN		Format equations for groff.  [eqn]
12611.116Slukem
12621.116SlukemTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
12631.116Slukem
12641.116SlukemTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
12651.116Slukem
12661.116SlukemTOOL_GROFF		Front end for groff document formatting system.  [groff]
12671.116Slukem
12681.116SlukemTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
12691.116Slukem
12701.116SlukemTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
12711.116Slukem
12721.116SlukemTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
12731.116Slukem
12741.116SlukemTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
12751.116Slukem
12761.116SlukemTOOL_M4			M4 macro language processor.  [m4]
12771.116Slukem
12781.116SlukemTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
12791.116Slukem
12801.116SlukemTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
12811.116Slukem
12821.116SlukemTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
12831.116Slukem
12841.116SlukemTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
12851.116Slukem
12861.116SlukemTOOL_MENUC		Menu compiler.  [menuc]
12871.116Slukem
12881.116SlukemTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
12891.116Slukem
12901.116SlukemTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
12911.116Slukem
12921.116SlukemTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
12931.116Slukem
12941.116SlukemTOOL_MKMAGIC		Create database for file(1).  [file]
12951.116Slukem
12961.116SlukemTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
12971.116Slukem
12981.116SlukemTOOL_MSGC		Simple message list compiler.  [msgc]
12991.116Slukem
13001.116SlukemTOOL_MTREE		Map a directory hierarchy.  [mtree]
13011.116Slukem
13021.116SlukemTOOL_PAX		Manipulate file archives and copy directories.  [pax]
13031.116Slukem
13041.116SlukemTOOL_PIC		Compile pictures for groff.  [pic]
13051.116Slukem
13061.116SlukemTOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
13071.116Slukem
13081.116SlukemTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
13091.116Slukem
13101.116SlukemTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
13111.116Slukem
13121.116SlukemTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
13131.116Slukem
13141.116SlukemTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
13151.116Slukem
13161.116SlukemTOOL_ROFF_HTML		Generate HTML groff output.
13171.119Slukem			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
13181.116Slukem
13191.116SlukemTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
13201.116Slukem
13211.116SlukemTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
13221.116Slukem
13231.116SlukemTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
13241.116Slukem
13251.116SlukemTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
13261.123Slukem
13271.123SlukemTOOL_STAT		Display file status.  [stat]
13281.116Slukem
13291.116SlukemTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
13301.116Slukem
13311.116SlukemTOOL_TBL		Format tables for groff.  [tbl]
13321.116Slukem
13331.116SlukemTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
13341.116Slukem
13351.116SlukemTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
13361.116Slukem
13371.116SlukemTOOL_ZIC		Time zone compiler.  [zic]
13381.116Slukem
13391.69Ssommerfe
13401.69SsommerfeOther variables of note (incomplete list):
13411.69Ssommerfe
13421.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
13431.82Slukem			WARNS=1
13441.82Slukem			WARNS=2
13451.82Slukem			WARNS=3
13461.69Ssommerfe
13471.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
13481.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
13491.75Sagc		WFORMAT belongs in individual makefiles and/or
13501.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
13511.75Sagc		makefiles if a program is not security critical and is
13521.75Sagc		doing bizarre things with format strings which would
13531.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
13541.120Slukem		mk.conf if you're doing format-string auditing.
13551.69Ssommerfe		FORMAT_AUDIT may go away in time.
13561.30Sagc
13571.144Slukem
13581.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
13591.144Slukem
13601.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
13611.144Slukemcross-building X11R6 from ${X11SRCDIR.xc}.
13621.144SlukemIt should be included after the general Makefile contents but before
13631.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
13641.144Slukem
13651.144SlukemIt provides the following targets:
13661.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
13671.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
13681.144Slukem		these rules convert from X11R6's manual page source
13691.144Slukem		into an mdoc.old source file.
13701.144Slukem	cleanx11man:
13711.144Slukem		Clean up the mdoc.old files generated by the above.
13721.144Slukem
13731.144SlukemIt sets the following variables:
13741.144Slukem
13751.144SlukemBINDIR			Set to ${X11BINDIR}.
13761.144Slukem			To override, define after including <bsd.x11.mk>
13771.144Slukem
13781.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
13791.144Slukem			To override, define after including <bsd.x11.mk>
13801.144Slukem
13811.144SlukemMANDIR			Set to ${X11MANDIR}.
13821.144Slukem			To override, define after including <bsd.x11.mk>
13831.144Slukem
13841.144SlukemCPPFLAGS		Appended with definitions to include from
13851.144Slukem			${DESTDIR}${X11INCDIR}
13861.144Slukem
13871.144SlukemLDFLAGS			Appended with definitions to link from
13881.144Slukem			${DESTDIR}${X11USRLIBDIR}
13891.144Slukem
13901.144SlukemX11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
13911.144Slukem
13921.144SlukemX11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
13931.144Slukem
13941.144SlukemX11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
13951.144Slukem
13961.144SlukemX11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
13971.144Slukem
13981.144SlukemX11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
13991.144Slukem
14001.144SlukemX11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
14011.144Slukem
14021.144SlukemX11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
14031.144Slukem
14041.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
14051.144Slukem
14061.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
14071.144Slukem
14081.144SlukemIt uses the following variables:
14091.144Slukem
14101.144SlukemAPPDEFS			List of app-default files to install.
14111.144Slukem
14121.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
14131.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
14141.144Slukem			have a `.cpp' suffix, the generated files do not.
14151.144Slukem
14161.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
14171.144Slukem
14181.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
14191.144Slukem
14201.144Slukem
14211.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1422