bsd.README revision 1.151
11.151Slukem#	$NetBSD: bsd.README,v 1.151 2004/04/18 13:07:00 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.76Sfair
3661.76SfairLDSTATIC	Control program linking; if set blank, link everything
3671.129Slukem		dynamically.  If set to "-static", link everything statically.
3681.76Sfair		If not set, programs link according to their makefile.
3691.21Schristos
3701.116SlukemLIBDIR		Base path for library installation.  [/usr/lib]
3711.15Scgd
3721.116SlukemLINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
3731.15Scgd
3741.116SlukemLIBGRP		Library group.  [${BINGRP}]
3751.15Scgd
3761.116SlukemLIBOWN		Library owner.  [${BINOWN}]
3771.15Scgd
3781.116SlukemLIBMODE		Library mode.  [${NONBINMODE}]
3791.15Scgd
3801.15ScgdDOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
3811.116Slukem	        installation.  [/usr/share/doc]
3821.62Ssimonb
3831.62SsimonbHTMLDOCDIR	Base path for html system documentation installation.
3841.62Ssimonb		[/usr/share/doc/html]
3851.15Scgd
3861.116SlukemDOCGRP		Documentation group.  [wheel]
3871.15Scgd
3881.116SlukemDOCOWN		Documentation owner.  [root]
3891.15Scgd
3901.116SlukemDOCMODE		Documentation mode.  [${NONBINMODE}]
3911.15Scgd
3921.84SkleinkNLSDIR		Base path for Native Language Support files installation.
3931.15Scgd		[/usr/share/nls]
3941.1Scgd
3951.116SlukemNLSGRP		Native Language Support files group.  [wheel]
3961.1Scgd
3971.116SlukemNLSOWN		Native Language Support files owner.  [root]
3981.1Scgd
3991.116SlukemNLSMODE		Native Language Support files mode.  [${NONBINMODE}]
4001.1Scgd
4011.144SlukemX11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
4021.144Slukem
4031.144SlukemX11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
4041.144Slukem
4051.144SlukemX11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
4061.144Slukem
4071.144SlukemX11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
4081.144Slukem
4091.144SlukemX11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
4101.144Slukem
4111.144SlukemX11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
4121.144Slukem
4131.144SlukemX11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
4141.144Slukem
4151.144SlukemX11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
4161.144Slukem
4171.144SlukemX11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
4181.144Slukem
4191.144SlukemX11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
4201.144Slukem
4211.32SmikelSTRIPFLAG	The flag passed to the install program to cause the binary
4221.1Scgd		to be stripped.  This is to be used when building your
4231.1Scgd		own install script so that the entire system can be made
4241.146Slukem		stripped/not-stripped using a single knob.  []
4251.1Scgd
4261.2ScgdCOPY		The flag passed to the install program to cause the binary
4271.2Scgd		to be copied rather than moved.  This is to be used when
4281.2Scgd		building our own install script so that the entire system
4291.2Scgd		can either be installed with copies, or with moves using
4301.116Slukem		a single knob.  [-c]
4311.15Scgd
4321.150SlukemMAKEDIRTARGET dir target [params]
4331.150Slukem		Runs "cd $${dir} && ${MAKE} [params] $${target}",
4341.150Slukem		displaying a "pretty" message whilst doing so.
4351.150Slukem
4361.150Slukem
4371.134SlukemAdditionally, the following variables may be set by <bsd.own.mk> or in a
4381.17Sthorpejmake configuration file to modify the behaviour of the system build
4391.17Sthorpejprocess (default values are in brackets along with comments, if set by
4401.134Slukem<bsd.own.mk>):
4411.33Sjonathan
4421.142SlukemUSETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
4431.142Slukem		be used as part of a build in progress.
4441.142Slukem		Supported values:
4451.142Slukem
4461.142Slukem		yes	Use the tools from TOOLDIR.
4471.142Slukem			Must be set to this if cross-compiling.
4481.142Slukem
4491.142Slukem		no	Do not use the tools from TOOLDIR, but refuse to
4501.142Slukem			build native compilation tool components that are
4511.142Slukem			version-specific for that tool.
4521.142Slukem
4531.142Slukem		never	Do not use the tools from TOOLDIR, even when
4541.142Slukem			building native tool components.  This is similar to
4551.142Slukem			the traditional NetBSD build method, but does not
4561.142Slukem			verify that the compilation tools in use are
4571.142Slukem			up-to-date enough in order to build the tree
4581.142Slukem			successfully.  This may cause build or runtime
4591.142Slukem			problems when building the whole NetBSD source tree.
4601.142Slukem
4611.142Slukem		Default: "yes" if building all or part of a whole NetBSD
4621.142Slukem		source tree (detected automatically); "no" otherwise
4631.142Slukem		(to preserve traditional semantics of the <bsd.*.mk>
4641.142Slukem		make(1) include files).
4651.142Slukem
4661.116SlukemOBJECT_FMT	Object file format.  [set to "ELF" on architectures that
4671.50Sthorpej		use ELF -- currently if ${MACHINE_ARCH} is "alpha",
4681.50Sthorpej		"mipsel", "mipseb", "powerpc", "sparc", "sparc64",
4691.77Ssimonb		"i386" and some m68k machines, or set to "a.out" on
4701.77Ssimonb		other architectures].
4711.33Sjonathan
4721.103SthorpejTOOLCHAIN_MISSING
4731.142Slukem		If not "no", this indicates that the platform being built
4741.103Sthorpej		does not have a working in-tree toolchain.  If the
4751.142Slukem		${MACHINE_ARCH} in question falls into this category,
4761.142Slukem		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
4771.103Sthorpej		Otherwise, the variable is unconditionally assigned the
4781.103Sthorpej		value "no".
4791.142Slukem		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
4801.142Slukem		unconditionally assigned the value "no".
4811.103Sthorpej
4821.103SthorpejEXTERNAL_TOOLCHAIN
4831.103Sthorpej		This variable is not directly set by <bsd.own.mk>, but
4841.103Sthorpej		including <bsd.own.mk> is the canonical way to gain
4851.103Sthorpej		access to this variable.  The variable should be defined
4861.103Sthorpej		either in the user's environment or in the user's mk.conf
4871.103Sthorpej		file.  If defined, this variable indicates the root of
4881.103Sthorpej		an external toolchain which will be used to build the
4891.142Slukem		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
4901.103Sthorpej		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
4911.103Sthorpej		cross-compile framework.
4921.103Sthorpej
4931.142Slukem		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
4941.142Slukem		assigned the value "no", since the external version of the
4951.142Slukem		compiler may not be able to build the library components of
4961.142Slukem		the in-tree compiler.
4971.103Sthorpej
4981.103Sthorpej		NOTE: This variable is not yet used in as many places as
4991.103Sthorpej		it should be.  Expect the exact semantics of this variable
5001.103Sthorpej		to change in the short term as parts of the cross-compile
5011.103Sthorpej		framework continue to be cleaned up.
5021.1Scgd
5031.134Slukem<bsd.own.mk> is generally useful when building your own Makefiles so that
5041.1Scgdthey use the same default owners etc. as the rest of the tree.
5051.131Slukem
5061.131Slukem
5071.131Slukem=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
5081.131Slukem
5091.131SlukemThe include file <bsd.dep.mk> contains the default targets for building
5101.133Slukem.depend files.  It creates .d files from entries in SRCS and DPSRCS
5111.133Slukemthat are C, C++, or Objective C source files, and builds .depend from the
5121.133Slukem.d files.  All other files in SRCS and all of DPSRCS will be used as
5131.133Slukemdependencies for the .d files.  In order for this to function correctly,
5141.132Slukemit should be .included after all other .mk files and directives that may
5151.132Slukemmodify SRCS or DPSRCS.  It uses the following variables:
5161.132Slukem
5171.132SlukemSRCS		List of source files to build the program.
5181.132Slukem
5191.132SlukemDPSRCS		List of source files which are needed for generating
5201.132Slukem		dependencies, but are not needed in ${SRCS}.
5211.1Scgd
5221.1Scgd
5231.118Slukem=-=-=-=-=   bsd.files.mk   =-=-=-=-=
5241.106Sthorpej
5251.118SlukemThe include file <bsd.files.mk> handles the FILES variables and is included
5261.134Slukemfrom <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
5271.124Slukem
5281.124SlukemFILES		The list of files to install.
5291.124Slukem
5301.124SlukemFILESOWN	File owner.  [${BINOWN}]
5311.124Slukem
5321.124SlukemFILESGRP	File group.  [${BINGRP}]
5331.124Slukem
5341.124SlukemFILESMODE	File mode.  [${BINMODE}]
5351.124Slukem
5361.124SlukemFILESDIR	The location to install the files.
5371.124Slukem
5381.124SlukemFILESNAME	Optional name to install each file as.
5391.124Slukem
5401.124SlukemFILESDIR.<fn>	The location to install the specific file <fn>.
5411.124Slukem
5421.124SlukemFILESNAME.<fn>	Optional name to install <fn> as.
5431.135Slukem
5441.139SlukemBUILDSYMLINKS	List of two word items:
5451.135Slukem			lnsrc lntgt
5461.135Slukem		For each lnsrc item, create a symlink named lntgt.
5471.135Slukem		The lntgt symlinks are removed by the cleandir target.
5481.106Sthorpej
5491.148SjmcUUDECODE_FILES	List of files which are stored as <file>.uue in the source
5501.148Sjmc		tree. Each one will be decoded with ${TOOL_UUDECODE}.
5511.148Sjmc		The source files have a `.uue' suffix, the generated files do 
5521.148Sjmc		not.
5531.149Sjmc
5541.149SjmcUUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
5551.148Sjmc		
5561.148Sjmc		*NOTE: These files are simply decoded, with no install or other
5571.148Sjmc		       rule applying implicitly except being added to the clean
5581.148Sjmc		       target.
5591.106Sthorpej
5601.118Slukem=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
5611.113Sthorpej
5621.113SthorpejThe include file <bsd.gcc.mk> computes various parameters related to GCC
5631.113Sthorpejsupport libraries.  It defines no targets.  <bsd.own.mk> MUST be included
5641.134Slukembefore <bsd.gcc.mk>.
5651.113Sthorpej
5661.134SlukemThe primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
5671.113Sthorpejof which need to know where to find certain GCC support libraries.
5681.113Sthorpej
5691.134SlukemThe behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
5701.113Sthorpejwhich is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
5711.113Sthorpejthe compiler is asked where to find the support libraries, otherwise the
5721.113Sthorpejsupport libraries are found in ${DESTDIR}/usr/lib.
5731.113Sthorpej
5741.134Slukem<bsd.gcc.mk> sets the following variables:
5751.113Sthorpej
5761.118Slukem_GCC_CRTBEGIN	The full path name to crtbegin.o.
5771.118Slukem
5781.118Slukem_GCC_CRTBEGINS	The full path name to crtbeginS.o.
5791.118Slukem
5801.118Slukem_GCC_CRTEND	The full path name to crtend.o.
5811.118Slukem
5821.118Slukem_GCC_CRTENDS	The full path name to crtendS.o.
5831.118Slukem
5841.118Slukem_GCC_LIBGCCDIR	The directory where libgcc.a is located.
5851.118Slukem
5861.118Slukem
5871.118Slukem=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
5881.118Slukem
5891.134SlukemThe include file <bsd.inc.mk> defines the includes target and uses the
5901.118Slukemvariables:
5911.118Slukem
5921.124SlukemINCS		The list of include files.
5931.118Slukem
5941.118SlukemINCSDIR		The location to install the include files.
5951.118Slukem
5961.118SlukemINCSNAME	Target name of the include file, if only one; same as
5971.118Slukem		FILESNAME, but for include files.
5981.118Slukem
5991.134SlukemINCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
6001.134Slukem		are installed in the 'includes' target and not the
6011.134Slukem		(much later) 'install' target.
6021.134Slukem
6031.118SlukemINCSNAME_<file>	The name file <file> should be installed as, if not <file>,
6041.118Slukem		same as FILESNAME_<file>, but for include files.
6051.118Slukem
6061.118Slukem
6071.118Slukem=-=-=-=-=   bsd.info.mk   =-=-=-=-=
6081.118Slukem
6091.118SlukemThe include file <bsd.info.mk> is used to generate and install GNU Info
6101.118Slukemdocumentation from respective Texinfo source files.  It defines three
6111.118Slukemimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
6121.118Slukemfollowing variables:
6131.118Slukem
6141.118SlukemTEXINFO		List of Texinfo source files.  Info documentation will
6151.118Slukem		consist of single files with the extension replaced by
6161.118Slukem		.info.
6171.118Slukem
6181.118SlukemINFOFLAGS	Flags to pass to makeinfo.  []
6191.118Slukem
6201.118Slukem
6211.118Slukem=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
6221.118Slukem
6231.118SlukemThe include file <bsd.kernobj.mk> defines variables related to the
6241.118Slukemlocation of kernel sources and object directories.
6251.118Slukem
6261.118SlukemKERNSRCDIR	Is the location of the top of the kernel src.
6271.124Slukem		[${_SRC_TOP_}/sys]
6281.118Slukem
6291.124SlukemKERNARCHDIR	Is the location of the machine dependent kernel sources.
6301.124Slukem		[arch/${MACHINE}]
6311.120Slukem
6321.124SlukemKERNCONFDIR	Is where the configuration files for kernels are found.
6331.124Slukem		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
6341.118Slukem
6351.118SlukemKERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
6361.118Slukem		instance will be compiled in ${KERNOBJDIR}/GENERIC.
6371.118Slukem		The default value is
6381.118Slukem		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
6391.118Slukem		if it exists or the target 'obj' is being made.
6401.118Slukem		Otherwise the default is
6411.118Slukem		${KERNSRCDIR}/${KERNARCHDIR}/compile.
6421.118Slukem
6431.118SlukemIt is important that Makefiles (such as those under src/distrib) that
6441.134Slukemwish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
6451.118Slukemrather than make assumptions about the location of the compiled kernel.
6461.118Slukem
6471.118Slukem
6481.118Slukem=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
6491.118Slukem
6501.118SlukemThe include file <bsd.kinc.mk> defines the many targets (includes,
6511.118Slukemsubdirectories, etc.), and is used by kernel makefiles to handle
6521.118Slukeminclude file installation.  It is intended to be included alone, by
6531.134Slukemkernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
6541.134SlukemPlease see <bsd.kinc.mk> for more details, and keep the documentation
6551.134Slukemin that file up to date.
6561.118Slukem
6571.118Slukem
6581.118Slukem=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
6591.118Slukem
6601.118SlukemThe include file <bsd.lib.mk> has support for building libraries.  It has
6611.118Slukemthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
6621.118Slukemincludes, install, lint, and tags.  Additionally, it has a checkver target
6631.118Slukemwhich checks for installed shared object libraries whose version is greater
6641.118Slukemthat the version of the source. It has a limited number of suffixes,
6651.134Slukemconsistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
6661.118Slukem<bsd.shlib.mk> to get shared library parameters.
6671.118Slukem
6681.118SlukemIt sets/uses the following variables:
6691.118Slukem
6701.118SlukemLIB		The name of the library to build.
6711.118Slukem
6721.118SlukemLIBDIR		Target directory for libraries.
6731.118Slukem
6741.118SlukemSHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
6751.142Slukem		is not "no".
6761.118Slukem
6771.142SlukemUSE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
6781.118Slukem		as the path to install shared libraries to.
6791.118Slukem		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
6801.130Slukem		Default: no
6811.118Slukem
6821.118SlukemLINTLIBDIR	Target directory for lint libraries.
6831.118Slukem
6841.118SlukemLIBGRP		Library group.
6851.118Slukem
6861.118SlukemLIBOWN		Library owner.
6871.118Slukem
6881.118SlukemLIBMODE		Library mode.
6891.118Slukem
6901.118SlukemLDADD		Additional loader objects.
6911.118Slukem
6921.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
6931.118Slukem
6941.118SlukemNOCHECKVER_<library>
6951.118SlukemNOCHECKVER	If set, disables checking for installed shared object
6961.118Slukem		libraries with versions greater than the source.  A
6971.118Slukem		particular library name, without the "lib" prefix, may
6981.118Slukem		be appended to the variable name to disable the check for
6991.118Slukem		only that library.
7001.118Slukem
7011.118SlukemSRCS		List of source files to build the library.  Suffix types
7021.118Slukem		.s, .c, and .f are supported.  Note, .s files are preferred
7031.118Slukem		to .c files of the same name.  (This is not the default for
7041.118Slukem		versions of make.)
7051.118Slukem
7061.118SlukemThe include file <bsd.lib.mk> includes the file named "../Makefile.inc"
7071.118Slukemif it exists, as well as the include file <bsd.man.mk>.
7081.118Slukem
7091.118SlukemIt has rules for building profiled objects; profiled libraries are
7101.118Slukembuilt by default.
7111.118Slukem
7121.118SlukemLibraries are ranlib'd when made.
7131.118Slukem
7141.118Slukem
7151.118Slukem=-=-=-=-=   bsd.links.mk   =-=-=-=-=
7161.118Slukem
7171.118SlukemThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
7181.134Slukemand is included from from <bsd.lib.mk> and <bsd.prog.mk>.
7191.134Slukem
7201.134SlukemLINKS		The list of hard links, consisting of pairs of paths:
7211.134Slukem			source-file target-file
7221.134Slukem		${DESTDIR} is prepended to both paths before linking.
7231.134Slukem		For example, to link /bin/test and /bin/[, use:
7241.134Slukem			LINKS=/bin/test /bin/[
7251.134Slukem
7261.134SlukemSYMLINKS	The list of symbolic links, consisting of pairs of paths:
7271.134Slukem			source-file target-file
7281.134Slukem		${DESTDIR} is only prepended to target-file before linking.
7291.134Slukem		For example, to symlink /usr/bin/tar to /bin/tar resulting
7301.134Slukem		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
7311.134Slukem			SYMLINKS=/bin/tar /usr/bin/tar
7321.118Slukem
7331.118Slukem
7341.118Slukem=-=-=-=-=   bsd.man.mk   =-=-=-=-=
7351.118Slukem
7361.118SlukemThe include file <bsd.man.mk> handles installing manual pages and their
7371.118Slukemlinks.
7381.118Slukem
7391.118SlukemIt has a two targets:
7401.118Slukem
7411.118Slukem	maninstall:
7421.118Slukem		Install the manual page sources and their links.
7431.118Slukem	catinstall:
7441.118Slukem		Install the preformatted manual pages and their links.
7451.118Slukem
7461.118SlukemIt sets/uses the following variables:
7471.118Slukem
7481.118SlukemMANDIR		Base path for manual installation.
7491.118Slukem
7501.118SlukemMANGRP		Manual group.
7511.118Slukem
7521.118SlukemMANOWN		Manual owner.
7531.118Slukem
7541.118SlukemMANMODE		Manual mode.
7551.118Slukem
7561.118SlukemMANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
7571.118Slukem		or "/tahoe" for machine specific manual pages.
7581.118Slukem
7591.118SlukemMAN		The manual pages to be installed (use a .1 - .9 suffix).
7601.118Slukem
7611.118SlukemMLINKS		List of manual page links (using a .1 - .9 suffix).  The
7621.118Slukem		linked-to file must come first, the linked file second,
7631.118Slukem		and there may be multiple pairs.  The files are soft-linked.
7641.118Slukem
7651.118SlukemThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if
7661.118Slukemit exists.
7671.118Slukem
7681.118Slukem
7691.118Slukem=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
7701.118Slukem
7711.118SlukemThe include file <bsd.obj.mk> defines targets related to the creation
7721.118Slukemand use of separated object and source directories.
7731.118Slukem
7741.118SlukemIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
7751.118Slukem${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
7761.118Slukemit exists.  Otherwise make(1) looks for the existence of a
7771.118Slukemsubdirectory (or a symlink to a directory) of the source directory
7781.118Slukeminto which built targets should be placed.  If an environment variable
7791.118Slukemnamed MAKEOBJDIR is set, make(1) uses its value as the name of the
7801.118Slukemobject directory; failing that, make first looks for a subdirectory
7811.118Slukemnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
7821.118Slukem
7831.118SlukemObject directories are not created automatically by make(1) if they
7841.118Slukemdon't exist; you need to run a separate "make obj".  (This will happen
7851.118Slukemduring a top-level build if "MKOBJDIRS" is set to a value other than
7861.118Slukem"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
7871.118Slukemand this is determined by a simple string prefix comparison -- object
7881.118Slukemdirectories are created in a separate object directory tree, and a
7891.118Slukemsymlink to the object directory in that tree is created in the source
7901.118Slukemdirectory; otherwise, "make obj" assumes that you're not in the main
7911.118Slukemsource tree and that it's not safe to use a separate object tree.
7921.118Slukem
7931.118SlukemSeveral variables used by <bsd.obj.mk> control exactly what
7941.118Slukemdirectories and links get created during a "make obj":
7951.118Slukem
7961.118SlukemMAKEOBJDIR	If set, this is the component name of the object
7971.118Slukem		directory.
7981.118Slukem
7991.118SlukemOBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
8001.118Slukem		object directories or links named "obj.${MACHINE}";
8011.118Slukem		otherwise, just creates ones named "obj".
8021.118Slukem
8031.118SlukemUSR_OBJMACHINE  If set, and the current directory is a subdirectory of
8041.118Slukem		${BSDSRCDIR}, create object directory in the
8051.118Slukem		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
8061.118Slukem		otherwise, create it in the corresponding subdirectory
8071.118Slukem		of ${BSDOBJDIR}
8081.113Sthorpej
8091.118SlukemBUILDID		If set, the contents of this variable are appended
8101.118Slukem		to the object directory name.  If OBJMACHINE is also
8111.118Slukem		set, ".${BUILDID}" is added after ".${MACHINE}".
8121.113Sthorpej
8131.106Sthorpej
8141.118Slukem=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
8151.106Sthorpej
8161.1ScgdThe include file <bsd.prog.mk> handles building programs from one or
8171.1Scgdmore source files, along with their manual pages.  It has a limited number
8181.134Slukemof suffixes, consistent with the current needs of the BSD tree. 
8191.134Slukem<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
8201.1Scgd
8211.16SjtcIt has eight targets:
8221.1Scgd
8231.1Scgd	all:
8241.102Sthorpej		build the program and its manual page.  This also
8251.102Sthorpej		creates a GDB initialization file (.gdbinit) in
8261.102Sthorpej		the objdir.  The .gdbinit file sets the shared library
8271.102Sthorpej		prefix to ${DESTDIR} to facilitate cross-debugging.
8281.1Scgd	clean:
8291.1Scgd		remove the program, any object files and the files a.out,
8301.24Smikel		Errs, errs, mklog, and ${PROG}.core.
8311.1Scgd	cleandir:
8321.1Scgd		remove all of the files removed by the target clean, as
8331.1Scgd		well as .depend, tags, and any manual pages.
8341.42Slukem		`distclean' is a synonym for `cleandir'.
8351.1Scgd	depend:
8361.1Scgd		make the dependencies for the source files, and store
8371.1Scgd		them in the file .depend.
8381.16Sjtc	includes:
8391.16Sjtc		install any header files.
8401.1Scgd	install:
8411.1Scgd		install the program and its manual pages; if the Makefile
8421.1Scgd		does not itself define the target install, the targets
8431.1Scgd		beforeinstall and afterinstall may also be used to cause
8441.1Scgd		actions immediately before and after the install target
8451.1Scgd		is executed.
8461.1Scgd	lint:
8471.1Scgd		run lint on the source files
8481.1Scgd	tags:
8491.1Scgd		create a tags file for the source files.
8501.1Scgd
8511.1ScgdIt sets/uses the following variables:
8521.1Scgd
8531.1ScgdBINGRP		Binary group.
8541.1Scgd
8551.1ScgdBINOWN		Binary owner.
8561.1Scgd
8571.1ScgdBINMODE		Binary mode.
8581.1Scgd
8591.1ScgdCLEANFILES	Additional files to remove for the clean and cleandir targets.
8601.1Scgd
8611.1ScgdCOPTS		Additional flags to the compiler when creating C objects.
8621.112Sthorpej
8631.125SlukemCOPTS.<fn>	Additional flags to the compiler when creating the
8641.125Slukem		C objects for <fn>.
8651.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
8661.125Slukem
8671.112SthorpejCPUFLAGS	Additional flags to the compiler/assembler to select
8681.112Sthorpej		CPU instruction set options, CPU tuning options, etc.
8691.35Slukem
8701.125SlukemCPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
8711.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
8721.125Slukem
8731.124SlukemCPPFLAGS	Additional flags to the C pre-processor.
8741.125Slukem
8751.125SlukemCPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
8761.125Slukem		For <fn>.[ly], "<fn>.c" must be used.
8771.102Sthorpej
8781.102SthorpejGDBINIT		List of GDB initialization files to add to "source"
8791.102Sthorpej		directives in the .gdbinit file that is created in the
8801.102Sthorpej		objdir.
8811.1Scgd
8821.1ScgdLDADD		Additional loader objects.  Usually used for libraries.
8831.1Scgd		For example, to load with the compatibility and utility
8841.1Scgd		libraries, use:
8851.1Scgd
8861.5Sjtc			LDADD+=-lutil -lcompat
8871.1Scgd
8881.1ScgdLDFLAGS		Additional loader flags.
8891.1Scgd
8901.134SlukemLINKS		See <bsd.links.mk>
8911.134Slukem
8921.134SlukemSYMLINKS	See <bsd.links.mk>
8931.1Scgd
8941.15ScgdMAN		Manual pages (should end in .1 - .9).  If no MAN variable is
8951.8Scgd		defined, "MAN=${PROG}.1" is assumed.
8961.1Scgd
8971.1ScgdPROG		The name of the program to build.  If not supplied, nothing
8981.1Scgd		is built.
8991.1Scgd
9001.88SthorpejPROG_CXX	If defined, the name of the program to build.  Also
9011.88Sthorpej		causes <bsd.prog.mk> to link the program with the C++
9021.88Sthorpej		compiler rather than the C compiler.  PROG_CXX overrides
9031.88Sthorpej		the value of PROG if PROG is also set.
9041.87Sthorpej
9051.21SchristosPROGNAME	The name that the above program will be installed as, if
9061.21Schristos		different from ${PROG}.
9071.21Schristos
9081.37StvSRCS		List of source files to build the program.  If SRCS is not
9091.1Scgd		defined, it's assumed to be ${PROG}.c.
9101.108Sjwise
9111.108SjwiseDPSRCS		List of source files which are needed for generating
9121.108Sjwise		dependencies, but are not needed in ${SRCS}.
9131.1Scgd
9141.1ScgdDPADD		Additional dependencies for the program.  Usually used for
9151.1Scgd		libraries.  For example, to depend on the compatibility and
9161.1Scgd		utility libraries use:
9171.1Scgd
9181.5Sjtc			DPADD+=${LIBCOMPAT} ${LIBUTIL}
9191.1Scgd
9201.1Scgd		The following libraries are predefined for DPADD:
9211.1Scgd
9221.21Schristos		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
9231.99Sitojun		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
9241.21Schristos		LIBC?=		${DESTDIR}/usr/lib/libc.a
9251.21Schristos		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
9261.99Sitojun		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
9271.99Sitojun		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
9281.21Schristos		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
9291.21Schristos		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
9301.99Sitojun		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
9311.99Sitojun		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
9321.105Sitojun		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
9331.99Sitojun		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
9341.21Schristos		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
9351.21Schristos		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
9361.21Schristos		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
9371.21Schristos		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
9381.114Sprovos		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
9391.73Sblymn		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
9401.21Schristos		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
9411.21Schristos		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
9421.99Sitojun		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
9431.99Sitojun		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
9441.70Sitojun		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
9451.49Sitojun		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
9461.99Sitojun		LIBKADM?=	${DESTDIR}/usr/lib/libkadm.a
9471.99Sitojun		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
9481.99Sitojun		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
9491.99Sitojun		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
9501.21Schristos		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
9511.21Schristos		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
9521.99Sitojun		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
9531.99Sitojun		LIBKSTREAM?=	${DESTDIR}/usr/lib/libkstream.a
9541.21Schristos		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
9551.21Schristos		LIBL?=		${DESTDIR}/usr/lib/libl.a
9561.21Schristos		LIBM?=		${DESTDIR}/usr/lib/libm.a
9571.53Sblymn		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
9581.99Sitojun		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
9591.99Sitojun		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
9601.21Schristos		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
9611.99Sitojun		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
9621.100Sthorpej		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
9631.26Skleink		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
9641.110Sthorpej		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
9651.110Sthorpej		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
9661.21Schristos		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
9671.99Sitojun		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
9681.99Sitojun		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
9691.21Schristos		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
9701.110Sthorpej		LIBRT?=		${DESTDIR}/usr/lib/librt.a
9711.21Schristos		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
9721.140Slukem		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
9731.99Sitojun		LIBSS?=		${DESTDIR}/usr/lib/libss.a
9741.99Sitojun		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
9751.140Slukem		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
9761.21Schristos		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
9771.99Sitojun		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
9781.21Schristos		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
9791.21Schristos		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
9801.21Schristos		LIBY?=		${DESTDIR}/usr/lib/liby.a
9811.21Schristos		LIBZ?=		${DESTDIR}/usr/lib/libz.a
9821.1Scgd
9831.1ScgdSHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
9841.12Schristos		strings, using xstr(1). Note that this will not work with
9851.12Schristos		parallel makes.
9861.1Scgd
9871.59SjlamSTRIPFLAG	The flag passed to the install program to cause the binary
9881.1Scgd		to be stripped.
9891.1Scgd
9901.1ScgdSUBDIR		A list of subdirectories that should be built as well.
9911.1Scgd		Each of the targets will execute the same target in the
9921.1Scgd		subdirectories.
9931.1Scgd
9941.21SchristosSCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
9951.21Schristos		These are installed exactly like programs.
9961.21Schristos
9971.21SchristosSCRIPTSNAME	The name that the above program will be installed as, if
9981.21Schristos		different from ${SCRIPTS}. These can be further specialized
9991.21Schristos		by setting SCRIPTSNAME_<script>.
10001.21Schristos
10011.124SlukemFILES		See description of <bsd.files.mk>.
10021.21Schristos
10031.106SthorpejSHLINKDIR	Target directory for shared linker.  See description of
10041.106Sthorpej		<bsd.own.mk> for additional information about this variable.
10051.130Slukem
10061.130SlukemUSE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
10071.130Slukem		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
10081.130Slukem		Default: yes
10091.85Slukem
10101.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc"
10111.1Scgdif it exists, as well as the include file <bsd.man.mk>.
10121.1Scgd
10131.1ScgdSome simple examples:
10141.1Scgd
10151.1ScgdTo build foo from foo.c with a manual page foo.1, use:
10161.1Scgd
10171.1Scgd	PROG=	foo
10181.1Scgd
10191.1Scgd	.include <bsd.prog.mk>
10201.1Scgd
10211.1ScgdTo build foo from foo.c with a manual page foo.2, add the line:
10221.1Scgd
10231.9Scgd	MAN=	foo.2
10241.1Scgd
10251.1ScgdIf foo does not have a manual page at all, add the line:
10261.1Scgd
10271.75Sagc	MKMAN=	no
10281.1Scgd
10291.1ScgdIf foo has multiple source files, add the line:
10301.1Scgd
10311.1Scgd	SRCS=	a.c b.c c.c d.c
10321.1Scgd
10331.1Scgd
10341.118Slukem=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
10351.118Slukem
10361.118SlukemThe include file <bsd.rpc.mk> contains a makefile fragment used to
10371.118Slukemconstruct source files built by rpcgen.
10381.72Ssommerfe
10391.118SlukemThe following macros may be defined in makefiles which include
10401.118Slukem<bsd.rpc.mk> in order to control which files get built and how they
10411.118Slukemare to be built:
10421.21Schristos
10431.118SlukemRPC_INCS:	construct .h file from .x file
10441.120SlukemRPC_XDRFILES:	construct _xdr.c from .x file
10451.118Slukem		(for marshalling/unmarshalling data types)
10461.118SlukemRPC_SVCFILES:	construct _svc.c from .x file
10471.118Slukem		(server-side stubs)
10481.118SlukemRPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
10491.21Schristos
10501.118SlukemRPC_XDIR:	Directory containing .x/.h files
10511.23Schristos
10521.23Schristos
10531.118Slukem=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
10541.21Schristos
10551.118SlukemThe include file <bsd.shlib.mk> computes parameters for shared library
10561.118Slukeminstallation and use.  It defines no targets.  <bsd.own.mk> MUST be
10571.134Slukemincluded before <bsd.shlib.mk>.
10581.21Schristos
10591.134Slukem<bsd.own.mk> sets the following variables, if they are not already defined
10601.118Slukem(defaults are in brackets):
10611.21Schristos
10621.142SlukemSHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
10631.142Slukem		instead of ${LIBDIR} as the base path for shared library
10641.142Slukem		installation.  [/lib]
10651.21Schristos
10661.118SlukemSHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
10671.118Slukem		a program.  [/lib for programs in /bin and /sbin, /usr/lib
10681.118Slukem		for all others.]
10691.81Swiz
10701.142Slukem_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
10711.118Slukem		otherwise set to ${LIBDIR}
10721.81Swiz
10731.118SlukemSHLINKINSTALLDIR Base path for shared linker.  [/libexec]
10741.39Scgd
10751.118SlukemSHLINKDIR	Path to use for shared linker when building a program.
10761.118Slukem		[/libexec for programs in /bin and /sbin, /usr/libexec for
10771.118Slukem		all others.]
10781.39Scgd
10791.13Schristos
10801.118Slukem=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
10811.13Schristos
10821.118SlukemThe include file <bsd.subdir.mk> contains the default targets for building
10831.120Slukemsubdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
10841.118Slukemclean, cleandir, depend, includes, install, lint, and tags.  For all of
10851.142Slukemthe directories listed in ${SUBDIR}, the specified directory will be
10861.142Slukemvisited and the target made.  There is also a default target which allows
10871.142Slukemthe command "make subdir" where subdir is any directory listed in ${SUBDIR}.
10881.47Stv
10891.118SlukemAs a special case, the use of a token .WAIT as an entry in SUBDIR acts
10901.118Slukemas a synchronization barrier when multiple make jobs are run; subdirs
10911.118Slukembefore the .WAIT must complete before any subdirs after .WAIT are
10921.118Slukemstarted.  See make(1) for some caveats on use of .WAIT and other
10931.118Slukemspecial sources.
10941.47Stv
10951.47Stv
10961.118Slukem=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
10971.47Stv
10981.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and
10991.14Scgd<bsd.lib.mk>.  It contains overrides that are used when building
11001.133Slukemthe NetBSD source tree.
11011.133Slukem
11021.133SlukemThe following variables control how various files are compiled/built.
11031.142Slukem(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
11041.133Slukem
11051.133SlukemAR		Create, modify, and extract from archives.  [ar]
11061.133Slukem
11071.133SlukemARFLAGS		Options to ${AR}.  [rl]
11081.133Slukem
11091.151SlukemAS		Assembler.  [as]
11101.151Slukem
11111.151SlukemAFLAGS		Options to ${AS}.  []
11121.151Slukem
11131.133SlukemCC		C compiler.  [cc]
11141.133Slukem
11151.133SlukemCFLAGS		Options to ${CC}.  [Usually -O or -O2]
11161.133Slukem
11171.133SlukemCPP		C Pre-Processor.  [cpp]
11181.133Slukem
11191.133SlukemCPPFLAGS	Options to ${CPP}.  []
11201.133Slukem
11211.151SlukemCPUFLAGS	Optimization flags for ${CC}.  []
11221.133Slukem
11231.133SlukemCXX		C++ compiler.  [c++]
11241.133Slukem
11251.133SlukemCXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
11261.133Slukem
11271.133SlukemELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
11281.133Slukem
11291.133SlukemFC		Fortran compiler.  [f77]
11301.133Slukem
11311.133SlukemFFLAGS		Options to {$FC}.  [-O]
11321.133Slukem
11331.133SlukemINSTALL		install(1) command.  [install]
11341.133Slukem
11351.133SlukemLEX		Lexical analyzer.  [lex]
11361.133Slukem
11371.133SlukemLFLAGS		Options to ${LEX}.  []
11381.133Slukem
11391.145SjwiseLPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
11401.145Sjwise
11411.133SlukemLD		Linker.  [ld]
11421.133Slukem
11431.133SlukemLDFLAGS		Options to ${LD}.  []
11441.133Slukem
11451.133SlukemLINT		C program verifier.  [lint]
11461.133Slukem
11471.133SlukemLINTFLAGS	Options to ${LINT}.  [-chapbxzF]
11481.133Slukem
11491.133SlukemLORDER		List dependencies for object files.  [lorder]
11501.133Slukem
11511.133SlukemMAKE		make(1).  [make]
11521.133Slukem
11531.133SlukemMKDEP		Construct Makefile dependency list.  [mkdep]
11541.133Slukem
11551.133SlukemNM		List symbols from object files.  [nm]
11561.133Slukem
11571.133SlukemPC		Pascal compiler.  [pc]  (Not present)
11581.133Slukem
11591.133SlukemPFLAGS		Options to ${PC}.  []
11601.133Slukem
11611.133SlukemOBJC		Objective C compiler.  [${CC}]
11621.133Slukem
11631.133SlukemOBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
11641.133Slukem
11651.133SlukemOBJCOPY		Copy and translate object files.  [objcopy]
11661.133Slukem
11671.133SlukemRANLIB		Generate index to archive.  [ranlib]
11681.133Slukem
11691.133SlukemSHELL		Shell.  [sh]
11701.133Slukem
11711.133SlukemSIZE		List section sizes and total size.  [size]
11721.133Slukem
11731.133SlukemSTRIP		Discard symbols from object files.  [strip]
11741.133Slukem
11751.133SlukemTSORT		Topological sort of a directed graph.  [tsort -q]
11761.133Slukem
11771.133SlukemYACC		LALR(1) parser generator.  [yacc]
11781.133Slukem
11791.133SlukemYFLAGS		Options to ${YACC}.  []
11801.133Slukem
11811.133SlukemYHEADER		If defined, add "-d" to YFLAGS, and add dependencies
11821.133Slukem		from <file>.y to <file>.h and <file>.c, and add
11831.133Slukem		<foo>.h to CLEANFILES.
11841.133Slukem
11851.133SlukemYPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
11861.133Slukem
11871.116Slukem
11881.116SlukemThe following variables are defined to commands to perform the
11891.116Slukemappropriate operation, with the default in [brackets].
11901.142Slukem(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
11911.116Slukem
11921.116SlukemTOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
11931.116Slukem
11941.116SlukemTOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
11951.116Slukem
11961.116SlukemTOOL_CAT		Concatenate and print files.  [cat]
11971.116Slukem
11981.116SlukemTOOL_CKSUM		Display file checksums.  [cksum]
11991.116Slukem
12001.116SlukemTOOL_COMPILE_ET		Error table compiler.  [compile_et]
12011.116Slukem
12021.116SlukemTOOL_CONFIG		Build kernel compilation directories.  [config]
12031.116Slukem
12041.116SlukemTOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
12051.116Slukem
12061.116SlukemTOOL_CTAGS		Create a tags file.  [ctags]
12071.116Slukem
12081.116SlukemTOOL_DB			Manipulate db(3) databases.  [db]
12091.116Slukem
12101.116SlukemTOOL_EQN		Format equations for groff.  [eqn]
12111.116Slukem
12121.116SlukemTOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
12131.116Slukem
12141.116SlukemTOOL_GENCAT		Generate NLS message catalogs.  [gencat]
12151.116Slukem
12161.116SlukemTOOL_GROFF		Front end for groff document formatting system.  [groff]
12171.116Slukem
12181.116SlukemTOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
12191.116Slukem
12201.116SlukemTOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
12211.116Slukem
12221.116SlukemTOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
12231.116Slukem
12241.116SlukemTOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
12251.116Slukem
12261.116SlukemTOOL_M4			M4 macro language processor.  [m4]
12271.116Slukem
12281.116SlukemTOOL_MAKEFS		Create file system image from directory tree.  [makefs]
12291.116Slukem
12301.116SlukemTOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
12311.116Slukem
12321.116SlukemTOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
12331.116Slukem
12341.116SlukemTOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
12351.116Slukem
12361.116SlukemTOOL_MENUC		Menu compiler.  [menuc]
12371.116Slukem
12381.116SlukemTOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
12391.116Slukem
12401.116SlukemTOOL_MKESDB		Make encoding scheme database.  [mkesdb]
12411.116Slukem
12421.116SlukemTOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
12431.116Slukem
12441.116SlukemTOOL_MKMAGIC		Create database for file(1).  [file]
12451.116Slukem
12461.116SlukemTOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
12471.116Slukem
12481.116SlukemTOOL_MSGC		Simple message list compiler.  [msgc]
12491.116Slukem
12501.116SlukemTOOL_MTREE		Map a directory hierarchy.  [mtree]
12511.116Slukem
12521.116SlukemTOOL_PAX		Manipulate file archives and copy directories.  [pax]
12531.116Slukem
12541.116SlukemTOOL_PIC		Compile pictures for groff.  [pic]
12551.116Slukem
12561.116SlukemTOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
12571.116Slukem
12581.116SlukemTOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
12591.116Slukem
12601.116SlukemTOOL_REFER		Preprocess bibliographic references for groff.  [refer]
12611.116Slukem
12621.116SlukemTOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
12631.116Slukem
12641.116SlukemTOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
12651.116Slukem
12661.116SlukemTOOL_ROFF_HTML		Generate HTML groff output.
12671.119Slukem			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
12681.116Slukem
12691.116SlukemTOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
12701.116Slukem
12711.116SlukemTOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
12721.116Slukem
12731.116SlukemTOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
12741.116Slukem
12751.116SlukemTOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
12761.123Slukem
12771.123SlukemTOOL_STAT		Display file status.  [stat]
12781.116Slukem
12791.116SlukemTOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
12801.116Slukem
12811.116SlukemTOOL_TBL		Format tables for groff.  [tbl]
12821.116Slukem
12831.116SlukemTOOL_UUDECODE		Uudecode a binary file.  [uudecode]
12841.116Slukem
12851.116SlukemTOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
12861.116Slukem
12871.116SlukemTOOL_ZIC		Time zone compiler.  [zic]
12881.116Slukem
12891.69Ssommerfe
12901.69SsommerfeOther variables of note (incomplete list):
12911.69Ssommerfe
12921.82SlukemWARNS		Crank up gcc warning options; the distinct levels are:
12931.82Slukem			WARNS=1
12941.82Slukem			WARNS=2
12951.82Slukem			WARNS=3
12961.69Ssommerfe
12971.69SsommerfeFORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
12981.69SsommerfeWFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
12991.75Sagc		WFORMAT belongs in individual makefiles and/or
13001.75Sagc		Makefile.inc files.  (set WFORMAT=1 in individual
13011.75Sagc		makefiles if a program is not security critical and is
13021.75Sagc		doing bizarre things with format strings which would
13031.75Sagc		be even uglier if rewritten) FORMAT_AUDIT should go in
13041.120Slukem		mk.conf if you're doing format-string auditing.
13051.69Ssommerfe		FORMAT_AUDIT may go away in time.
13061.30Sagc
13071.144Slukem
13081.144Slukem=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
13091.144Slukem
13101.144SlukemThe include file <bsd.x11.mk> contains parameters and targets for
13111.144Slukemcross-building X11R6 from ${X11SRCDIR.xc}.
13121.144SlukemIt should be included after the general Makefile contents but before
13131.144Slukemthe include files such as <bsd.prog.mk> and <bsd.lib.mk>.
13141.144Slukem
13151.144SlukemIt provides the following targets:
13161.144Slukem	.man.1 .man.3 .man.4 .man.5 .man.7:
13171.144Slukem		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
13181.144Slukem		these rules convert from X11R6's manual page source
13191.144Slukem		into an mdoc.old source file.
13201.144Slukem	cleanx11man:
13211.144Slukem		Clean up the mdoc.old files generated by the above.
13221.144Slukem
13231.144SlukemIt sets the following variables:
13241.144Slukem
13251.144SlukemBINDIR			Set to ${X11BINDIR}.
13261.144Slukem			To override, define after including <bsd.x11.mk>
13271.144Slukem
13281.144SlukemLIBDIR			Set to ${X11USRLIBDIR}.
13291.144Slukem			To override, define after including <bsd.x11.mk>
13301.144Slukem
13311.144SlukemMANDIR			Set to ${X11MANDIR}.
13321.144Slukem			To override, define after including <bsd.x11.mk>
13331.144Slukem
13341.144SlukemCPPFLAGS		Appended with definitions to include from
13351.144Slukem			${DESTDIR}${X11INCDIR}
13361.144Slukem
13371.144SlukemLDFLAGS			Appended with definitions to link from
13381.144Slukem			${DESTDIR}${X11USRLIBDIR}
13391.144Slukem
13401.144SlukemX11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
13411.144Slukem
13421.144SlukemX11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
13431.144Slukem
13441.144SlukemX11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
13451.144Slukem
13461.144SlukemX11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
13471.144Slukem
13481.144SlukemX11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
13491.144Slukem
13501.144SlukemX11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
13511.144Slukem
13521.144SlukemX11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
13531.144Slukem
13541.144SlukemX11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
13551.144Slukem
13561.144SlukemX11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
13571.144Slukem
13581.144SlukemIt uses the following variables:
13591.144Slukem
13601.144SlukemAPPDEFS			List of app-default files to install.
13611.144Slukem
13621.144SlukemCPPSCRIPTS		List of files/scripts to run through cpp(1)
13631.144Slukem			and then ${X11TOOL_UNXCOMM}.  The source files
13641.144Slukem			have a `.cpp' suffix, the generated files do not.
13651.144Slukem
13661.144SlukemCPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
13671.144Slukem
13681.144SlukemCPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
13691.144Slukem
13701.144Slukem
13711.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1372