bsd.README revision 1.69
11.69Ssommerfe# $NetBSD: bsd.README,v 1.69 2000/10/04 19:27:45 sommerfeld 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.1Scgdmultiple programs in a single directory. It's a lot easier 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.21Schristos 611.45SlukemThe following variables that control how things are made/installed that 621.47Stvare not set by default. These should not be set by Makefiles; they're for 631.47Stvthe user to define in MAKECONF (see bsd.own.mk, below) or on the make(1) 641.47Stvcommand line: 651.21Schristos 661.45SlukemBUILD If defined, 'make install' checks that the targets in the 671.45Slukem source directories are up-to-date and remakes them if they 681.21Schristos are out of date, instead of blindly trying to install 691.21Schristos out of date or non-existant targets. 701.21Schristos 711.45SlukemUPDATE If defined, 'make install' only installs targets that are 721.45Slukem more recently modified in the source directories that their 731.45Slukem installed counterparts. 741.52Ssimonb 751.52SsimonbUNPRIVILEGED If defined, don't set the owner/group/mode when installing 761.52Ssimonb files or directories. This allows a non-root "make install". 771.45Slukem 781.45SlukemMKCATPAGES If "no", don't build or install the catman pages. 791.45Slukem 801.45SlukemMKDOC If "no", don't build or install the documentation. 811.45Slukem 821.47StvMKINFO If "no", don't build or install Info documentation from 831.47Stv Texinfo source files. 841.45Slukem 851.45SlukemMKLINT If "no", don't build or install the lint libraries. 861.45Slukem 871.45SlukemMKMAN If "no", don't build or install the man or catman pages. 881.46Slukem Also acts as "MKCATPAGES=no" 891.45Slukem 901.45SlukemMKNLS If "no", don't build or install the NLS files. 911.45Slukem 921.55SsommerfeMKOBJ If "no", don't enable the rule which creates objdirs. 931.55Ssommerfe "yes" by default. 941.55Ssommerfe 951.55SsommerfeMKOBJDIRS If "no", don't create objdirs during a "make build". 961.55Ssommerfe "no" by default. 971.45Slukem 981.45SlukemMKPIC If "no", don't build or install shared libraries. 991.45Slukem 1001.45SlukemMKPICINSTALL If "no", don't install the *_pic.a libraries. 1011.45Slukem 1021.45SlukemMKPROFILE If "no", don't build or install the profiling libraries. 1031.45Slukem 1041.48SlukemMKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKINFO=no MKMAN=no 1051.48Slukem MKNLS=no". I.e, don't build catman pages, documentation, 1061.48Slukem Info documentation, man pages, NLS files, ... 1071.1Scgd 1081.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1091.1Scgd 1101.1ScgdThe include file <sys.mk> has the default rules for all makes, in the BSD 1111.1Scgdenvironment or otherwise. You probably don't want to touch this file. 1121.1Scgd 1131.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1141.1Scgd 1151.1ScgdThe include file <bsd.man.mk> handles installing manual pages and their 1161.1Scgdlinks. 1171.1Scgd 1181.21SchristosIt has a two targets: 1191.1Scgd 1201.1Scgd maninstall: 1211.21Schristos Install the manual page sources and their links. 1221.21Schristos catinstall: 1231.21Schristos Install the preformatted manual pages and their links. 1241.1Scgd 1251.1ScgdIt sets/uses the following variables: 1261.1Scgd 1271.1ScgdMANDIR Base path for manual installation. 1281.1Scgd 1291.1ScgdMANGRP Manual group. 1301.1Scgd 1311.1ScgdMANOWN Manual owner. 1321.1Scgd 1331.1ScgdMANMODE Manual mode. 1341.1Scgd 1351.1ScgdMANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 1361.1Scgd or "/tahoe" for machine specific manual pages. 1371.1Scgd 1381.15ScgdMAN The manual pages to be installed (use a .1 - .9 suffix). 1391.1Scgd 1401.15ScgdMLINKS List of manual page links (using a .1 - .9 suffix). The 1411.1Scgd linked-to file must come first, the linked file second, 1421.1Scgd and there may be multiple pairs. The files are soft-linked. 1431.1Scgd 1441.1ScgdThe include file <bsd.man.mk> includes a file named "../Makefile.inc" if 1451.1Scgdit exists. 1461.1Scgd 1471.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1481.1Scgd 1491.17SthorpejThe include file <bsd.own.mk> contains source tree configuration parameters, 1501.17Sthorpejsuch as the owners, groups, etc. for both manual pages and binaries, and 1511.17Sthorpeja few global "feature configuration" parameters. 1521.1Scgd 1531.1ScgdIt has no targets. 1541.1Scgd 1551.29ScjsTo get system-specific configuration parameters, bsd.own.mk will try to 1561.29Scjsinclude the file specified by the "MAKECONF" variable. If MAKECONF is not 1571.29Scjsset, or no such file exists, the system make configuration file, /etc/mk.conf 1581.29Scjsis included. These files may define any of the variables described below. 1591.17Sthorpej 1601.17Sthorpejbsd.own.mk sets the following variables, if they are not already defined 1611.17Sthorpej(defaults are in brackets): 1621.15Scgd 1631.15ScgdBSDSRCDIR The real path to the system sources, so that 'make obj' 1641.15Scgd will work correctly. [/usr/src] 1651.15Scgd 1661.15ScgdBSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' 1671.15Scgd will work correctly. [/usr/obj] 1681.15Scgd 1691.34SlukemBINGRP Binary group. [wheel] 1701.15Scgd 1711.34SlukemBINOWN Binary owner. [root] 1721.15Scgd 1731.15ScgdBINMODE Binary mode. [555] 1741.15Scgd 1751.15ScgdNONBINMODE Mode for non-executable files. [444] 1761.15Scgd 1771.15ScgdMANDIR Base path for manual installation. [/usr/share/man/cat] 1781.15Scgd 1791.34SlukemMANGRP Manual group. [wheel] 1801.15Scgd 1811.34SlukemMANOWN Manual owner. [root] 1821.15Scgd 1831.15ScgdMANMODE Manual mode. [${NONBINMODE}] 1841.15Scgd 1851.21SchristosMANINSTALL Manual installation type: maninstall, catinstall, or both 1861.21Schristos 1871.15ScgdLIBDIR Base path for library installation. [/usr/lib] 1881.15Scgd 1891.15ScgdLINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] 1901.15Scgd 1911.15ScgdLIBGRP Library group. [${BINGRP}] 1921.15Scgd 1931.15ScgdLIBOWN Library owner. [${BINOWN}] 1941.15Scgd 1951.15ScgdLIBMODE Library mode. [${NONBINMODE}] 1961.15Scgd 1971.15ScgdDOCDIR Base path for system documentation (e.g. PSD, USD, etc.) 1981.15Scgd installation. [/usr/share/doc] 1991.62Ssimonb 2001.62SsimonbHTMLDOCDIR Base path for html system documentation installation. 2011.62Ssimonb [/usr/share/doc/html] 2021.15Scgd 2031.34SlukemDOCGRP Documentation group. [wheel] 2041.15Scgd 2051.34SlukemDOCOWN Documentation owner. [root] 2061.15Scgd 2071.15ScgdDOCMODE Documentation mode. [${NONBINMODE}] 2081.15Scgd 2091.15ScgdNLSDIR Base path for National Language Support files installation. 2101.15Scgd [/usr/share/nls] 2111.1Scgd 2121.34SlukemNLSGRP National Language Support files group. [wheel] 2131.1Scgd 2141.34SlukemNLSOWN National Language Support files owner. [root] 2151.1Scgd 2161.15ScgdNLSMODE National Language Support files mode. [${NONBINMODE}] 2171.1Scgd 2181.32SmikelSTRIPFLAG The flag passed to the install program to cause the binary 2191.1Scgd to be stripped. This is to be used when building your 2201.1Scgd own install script so that the entire system can be made 2211.15Scgd stripped/not-stripped using a single knob. [-s] 2221.1Scgd 2231.2ScgdCOPY The flag passed to the install program to cause the binary 2241.2Scgd to be copied rather than moved. This is to be used when 2251.2Scgd building our own install script so that the entire system 2261.2Scgd can either be installed with copies, or with moves using 2271.15Scgd a single knob. [-c] 2281.15Scgd 2291.17SthorpejAdditionally, the following variables may be set by bsd.own.mk or in a 2301.17Sthorpejmake configuration file to modify the behaviour of the system build 2311.17Sthorpejprocess (default values are in brackets along with comments, if set by 2321.17Sthorpejbsd.own.mk): 2331.15Scgd 2341.64SthorpejMKCRYPTO If set to "no", no cryptography support will be built 2351.64Sthorpej into the system. Defaults to "yes". 2361.64Sthorpej 2371.64SthorpejNOCRYPTO If set, it is equivalent to setting MKCRYPTO to "no". 2381.64Sthorpej 2391.66SitojunMKCRYPTO_IDEA If set to "yes", IDEA support will be built into 2401.66Sitojun libcrypto_idea.a. Defaults to "no". 2411.64Sthorpej 2421.66SitojunMKCRYPTO_RC5 If set to "yes", RC5 support will be built into 2431.66Sitojun libcrypto_rc5.a. Defaults to "no". 2441.64Sthorpej 2451.64SthorpejMKKERBEROS If set to "no", disables building Kerberos (v4 or v5) 2461.64Sthorpej support into various system utilities that support it. 2471.64Sthorpej Defaults to "yes". NOTE: This does not affect the 2481.64Sthorpej building of the Kerberos libraries or infrastructure 2491.64Sthorpej programs themselves. To completely disable Kerberos, 2501.64Sthorpej set MKCRYPTO to "no". 2511.64Sthorpej 2521.64SthorpejNOKERBEROS If set, it is equivalent to setting MKKERBEROS to "no". 2531.2Scgd 2541.15ScgdSKEY Compile in support for S/key authentication. [yes, set 2551.15Scgd unconditionally] 2561.15Scgd 2571.15ScgdMANZ Compress manual pages at installation time. 2581.15Scgd 2591.15ScgdSYS_INCLUDE Copy or symlink kernel include files into /usr/include. 2601.15Scgd Possible values are "symlinks" or "copies" (which is 2611.15Scgd the same as the variable being unset). 2621.1Scgd 2631.15ScgdNOPROFILE Do not build profiled versions of system libraries 2641.1Scgd 2651.15ScgdNOPIC Do not build PIC versions of system libraries, and 2661.15Scgd do not build shared libraries. [set if ${MACHINE_ARCH} 2671.65Sjlam is "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.] 2681.1Scgd 2691.40SperryNOLINT Do not build lint libraries. 2701.33Sjonathan 2711.50SthorpejOBJECT_FMT Object file format. [set to "ELF" on architectures that 2721.50Sthorpej use ELF -- currently if ${MACHINE_ARCH} is "alpha", 2731.50Sthorpej "mipsel", "mipseb", "powerpc", "sparc", "sparc64", 2741.50Sthorpej and "i386", or set to "a.out" on other architectures]. 2751.33Sjonathan 2761.1Scgd 2771.17Sthorpejbsd.own.mk is generally useful when building your own Makefiles so that 2781.1Scgdthey use the same default owners etc. as the rest of the tree. 2791.1Scgd 2801.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 2811.1Scgd 2821.1ScgdThe include file <bsd.prog.mk> handles building programs from one or 2831.1Scgdmore source files, along with their manual pages. It has a limited number 2841.1Scgdof suffixes, consistent with the current needs of the BSD tree. 2851.1Scgd 2861.16SjtcIt has eight targets: 2871.1Scgd 2881.1Scgd all: 2891.1Scgd build the program and its manual page 2901.1Scgd clean: 2911.1Scgd remove the program, any object files and the files a.out, 2921.24Smikel Errs, errs, mklog, and ${PROG}.core. 2931.1Scgd cleandir: 2941.1Scgd remove all of the files removed by the target clean, as 2951.1Scgd well as .depend, tags, and any manual pages. 2961.42Slukem `distclean' is a synonym for `cleandir'. 2971.1Scgd depend: 2981.1Scgd make the dependencies for the source files, and store 2991.1Scgd them in the file .depend. 3001.16Sjtc includes: 3011.16Sjtc install any header files. 3021.1Scgd install: 3031.1Scgd install the program and its manual pages; if the Makefile 3041.1Scgd does not itself define the target install, the targets 3051.1Scgd beforeinstall and afterinstall may also be used to cause 3061.1Scgd actions immediately before and after the install target 3071.1Scgd is executed. 3081.1Scgd lint: 3091.1Scgd run lint on the source files 3101.1Scgd tags: 3111.1Scgd create a tags file for the source files. 3121.1Scgd 3131.1ScgdIt sets/uses the following variables: 3141.1Scgd 3151.1ScgdBINGRP Binary group. 3161.1Scgd 3171.1ScgdBINOWN Binary owner. 3181.1Scgd 3191.1ScgdBINMODE Binary mode. 3201.1Scgd 3211.1ScgdCLEANFILES Additional files to remove for the clean and cleandir targets. 3221.1Scgd 3231.1ScgdCOPTS Additional flags to the compiler when creating C objects. 3241.35Slukem 3251.35SlukemCPPFLAGS Additional flags to the C pre-processor 3261.1Scgd 3271.1ScgdLDADD Additional loader objects. Usually used for libraries. 3281.1Scgd For example, to load with the compatibility and utility 3291.1Scgd libraries, use: 3301.1Scgd 3311.5Sjtc LDADD+=-lutil -lcompat 3321.1Scgd 3331.1ScgdLDFLAGS Additional loader flags. 3341.1Scgd 3351.1ScgdLINKS The list of binary links; should be full pathnames, the 3361.1Scgd linked-to file coming first, followed by the linked 3371.1Scgd file. The files are hard-linked. For example, to link 3381.1Scgd /bin/test and /bin/[, use: 3391.1Scgd 3401.1Scgd LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 3411.19Sperry 3421.19SperrySYMLINKS The list of symbolic links; should be full pathnames. 3431.20Sperry Syntax is identical to LINKS. Note that DESTDIR is not 3441.20Sperry automatically included in the link. 3451.1Scgd 3461.15ScgdMAN Manual pages (should end in .1 - .9). If no MAN variable is 3471.8Scgd defined, "MAN=${PROG}.1" is assumed. 3481.1Scgd 3491.1ScgdPROG The name of the program to build. If not supplied, nothing 3501.1Scgd is built. 3511.1Scgd 3521.21SchristosPROGNAME The name that the above program will be installed as, if 3531.21Schristos different from ${PROG}. 3541.21Schristos 3551.37StvSRCS List of source files to build the program. If SRCS is not 3561.1Scgd defined, it's assumed to be ${PROG}.c. 3571.1Scgd 3581.1ScgdDPADD Additional dependencies for the program. Usually used for 3591.1Scgd libraries. For example, to depend on the compatibility and 3601.1Scgd utility libraries use: 3611.1Scgd 3621.5Sjtc DPADD+=${LIBCOMPAT} ${LIBUTIL} 3631.1Scgd 3641.1Scgd The following libraries are predefined for DPADD: 3651.1Scgd 3661.21Schristos LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 3671.21Schristos LIBC?= ${DESTDIR}/usr/lib/libc.a 3681.21Schristos LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 3691.21Schristos LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 3701.21Schristos LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 3711.21Schristos LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 3721.21Schristos LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 3731.21Schristos LIBDES?= ${DESTDIR}/usr/lib/libdes.a 3741.21Schristos LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 3751.21Schristos LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 3761.21Schristos LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 3771.49Sitojun LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a 3781.21Schristos LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a 3791.21Schristos LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a 3801.21Schristos LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 3811.21Schristos LIBL?= ${DESTDIR}/usr/lib/libl.a 3821.21Schristos LIBM?= ${DESTDIR}/usr/lib/libm.a 3831.53Sblymn LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a 3841.21Schristos LIBMP?= ${DESTDIR}/usr/lib/libmp.a 3851.25Schristos LIBNTP?= ${DESTDIR}/usr/lib/libntp.a 3861.21Schristos LIBPC?= ${DESTDIR}/usr/lib/libpc.a 3871.21Schristos LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 3881.21Schristos LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a 3891.26Skleink LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a 3901.21Schristos LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 3911.21Schristos LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 3921.21Schristos LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 3931.21Schristos LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a 3941.21Schristos LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a 3951.21Schristos LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 3961.21Schristos LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 3971.21Schristos LIBY?= ${DESTDIR}/usr/lib/liby.a 3981.21Schristos LIBZ?= ${DESTDIR}/usr/lib/libz.a 3991.21Schristos 4001.1Scgd 4011.1ScgdSHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 4021.12Schristos strings, using xstr(1). Note that this will not work with 4031.12Schristos parallel makes. 4041.1Scgd 4051.59SjlamSTRIPFLAG The flag passed to the install program to cause the binary 4061.1Scgd to be stripped. 4071.1Scgd 4081.1ScgdSUBDIR A list of subdirectories that should be built as well. 4091.1Scgd Each of the targets will execute the same target in the 4101.1Scgd subdirectories. 4111.1Scgd 4121.21SchristosSCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 4131.21Schristos These are installed exactly like programs. 4141.21Schristos 4151.21SchristosSCRIPTSNAME The name that the above program will be installed as, if 4161.21Schristos different from ${SCRIPTS}. These can be further specialized 4171.21Schristos by setting SCRIPTSNAME_<script>. 4181.21Schristos 4191.21SchristosFILES A list of files to install. The installation is controlled 4201.21Schristos by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR 4211.21Schristos variables that can be further specialized by FILES<VAR>_<file> 4221.21Schristos 4231.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc" 4241.1Scgdif it exists, as well as the include file <bsd.man.mk>. 4251.1Scgd 4261.1ScgdSome simple examples: 4271.1Scgd 4281.1ScgdTo build foo from foo.c with a manual page foo.1, use: 4291.1Scgd 4301.1Scgd PROG= foo 4311.1Scgd 4321.1Scgd .include <bsd.prog.mk> 4331.1Scgd 4341.1ScgdTo build foo from foo.c with a manual page foo.2, add the line: 4351.1Scgd 4361.9Scgd MAN= foo.2 4371.1Scgd 4381.1ScgdIf foo does not have a manual page at all, add the line: 4391.1Scgd 4401.1Scgd NOMAN= noman 4411.1Scgd 4421.1ScgdIf foo has multiple source files, add the line: 4431.1Scgd 4441.1Scgd SRCS= a.c b.c c.c d.c 4451.1Scgd 4461.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4471.1Scgd 4481.1ScgdThe include file <bsd.subdir.mk> contains the default targets for building 4491.16Sjtcsubdirectories. It has the same eight targets as <bsd.prog.mk>: all, 4501.16Sjtcclean, cleandir, depend, includes, install, lint, and tags. For all of 4511.16Sjtcthe directories listed in the variable SUBDIRS, the specified directory 4521.16Sjtcwill be visited and the target made. There is also a default target which 4531.16Sjtcallows the command "make subdir" where subdir is any directory listed in 4541.16Sjtcthe variable SUBDIRS. 4551.21Schristos 4561.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4571.21Schristos 4581.23SchristosThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 4591.23Schristosand is included from from bsd.lib.mk and bsd.prog.mk. 4601.23Schristos 4611.23Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4621.23Schristos 4631.23SchristosThe include file <bsd.files.mk> handles the FILES variables and is included 4641.23Schristosfrom bsd.lib.mk and bsd.prog.mk. 4651.21Schristos 4661.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4671.21Schristos 4681.29ScjsThe include file <bsd.inc.mk> defines the includes target and uses two 4691.29Scjsvariables: 4701.21Schristos 4711.29ScjsINCS The list of include files 4721.21Schristos 4731.29ScjsINCSDIR The location to install the include files. 4741.39Scgd 4751.39Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4761.39Scgd 4771.39ScgdThe include file <bsd.kinc.mk> defines the many targets (includes, 4781.39Scgdsubdirectories, etc.), and is used by kernel makefiles to handle 4791.39Scgdinclude file installation. It is intended to be included alone, by 4801.39Scgdkernel Makefiles. Please see bsd.kinc.mk for more details, and keep 4811.39Scgdthe documentation in that file up to date. 4821.13Schristos 4831.13Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4841.13Schristos 4851.47StvThe include file <bsd.info.mk> is used to generate and install GNU Info 4861.47Stvdocumentation from respective Texinfo source files. It defines three 4871.47Stvimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the 4881.47Stvfollowing variables: 4891.47Stv 4901.47StvTEXINFO List of Texinfo source files. Info documentation will 4911.47Stv consist of single files with the extension replaced by 4921.47Stv .info. 4931.47Stv 4941.47StvINFOFLAGS Flags to pass to makeinfo. [] 4951.47Stv 4961.47StvINSTALL_INFO Name of install-info program. [install-info] 4971.47Stv 4981.47StvMAKEINFO Name of makeinfo program. [makeinfo] 4991.47Stv 5001.47Stv=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 5011.47Stv 5021.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and 5031.14Scgd<bsd.lib.mk>. It contains overrides that are used when building 5041.14Scgdthe NetBSD source tree. For instance, if "PARALLEL" is defined by 5051.14Scgdthe program/library Makefile, it includes a set of rules for lex and 5061.14Scgdyacc that allow multiple lex and yacc targets to be built in parallel. 5071.69Ssommerfe 5081.69SsommerfeOther variables of note (incomplete list): 5091.69Ssommerfe 5101.69SsommerfeWARNS Crank up gcc warning options; WARNS=1 and WARNS=2 are the two 5111.69Ssommerfe distinct levels. 5121.69Ssommerfe 5131.69SsommerfeFORMAT_AUDIT If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on 5141.69SsommerfeWFORMAT -Wnetbsd-format-audit for extra-stringent format checking. 5151.69Ssommerfe WFORMAT belongs in individual makefiles and/or Makefile.inc files. 5161.69Ssommerfe (set WFORMAT=1 in individual makefiles if a program is 5171.69Ssommerfe not security critical and is doing bizarre things with 5181.69Ssommerfe format strings which would be even uglier if rewritten) 5191.69Ssommerfe FORMAT_AUDIT should go in mk.conf if you're doing format-string auditing. 5201.69Ssommerfe FORMAT_AUDIT may go away in time. 5211.1Scgd 5221.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 5231.1Scgd 5241.1ScgdThe include file <bsd.lib.mk> has support for building libraries. It has 5251.16Sjtcthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 5261.44Serhincludes, install, lint, and tags. Additionally, it has a checkver target 5271.44Serhwhich checks for installed shared object libraries whose version is greater 5281.44Serhthat the version of the source. It has a limited number of suffixes, 5291.16Sjtcconsistent with the current needs of the BSD tree. 5301.1Scgd 5311.1ScgdIt sets/uses the following variables: 5321.10Scgd 5331.10ScgdLIB The name of the library to build. 5341.1Scgd 5351.1ScgdLIBDIR Target directory for libraries. 5361.1Scgd 5371.1ScgdLINTLIBDIR Target directory for lint libraries. 5381.1Scgd 5391.1ScgdLIBGRP Library group. 5401.1Scgd 5411.1ScgdLIBOWN Library owner. 5421.1Scgd 5431.1ScgdLIBMODE Library mode. 5441.1Scgd 5451.1ScgdLDADD Additional loader objects. 5461.1Scgd 5471.15ScgdMAN The manual pages to be installed (use a .1 - .9 suffix). 5481.47Stv 5491.47StvMKLINKLIB If "no", act as "MKPICINSTALL=no MKPROFILE=no". 5501.47Stv Also: 5511.47Stv - don't install the .a libraries 5521.47Stv - don't install _pic.a libraries on PIC systems 5531.47Stv - don't build .a libraries on PIC systems 5541.47Stv - don't install the .so symlink on ELF systems 5551.47Stv I.e, only install the shared library (and the .so.major 5561.47Stv symlink on ELF). 5571.54Ssimonb 5581.54SsimonbMKPICLIB If "no", don't build _pic.a libraries, and build the 5591.54Ssimonb shared object libraries from the .a libraries. A 5601.54Ssimonb symlink is installed in ${DESTDIR}/usr/lib for the 5611.54Ssimonb _pic.a library pointing to the .a library. 5621.44Serh 5631.44SerhNOCHECKVER_<library> 5641.44SerhNOCHECKVER If set, disables checking for installed shared object 5651.44Serh libraries with versions greater than the source. A 5661.44Serh particular library name, without the "lib" prefix, may 5671.44Serh be appended to the variable name to disable the check for 5681.44Serh only that library. 5691.1Scgd 5701.1ScgdSRCS List of source files to build the library. Suffix types 5711.1Scgd .s, .c, and .f are supported. Note, .s files are preferred 5721.1Scgd to .c files of the same name. (This is not the default for 5731.1Scgd versions of make.) 5741.1Scgd 5751.1ScgdThe include file <bsd.lib.mk> includes the file named "../Makefile.inc" 5761.1Scgdif it exists, as well as the include file <bsd.man.mk>. 5771.1Scgd 5781.1ScgdIt has rules for building profiled objects; profiled libraries are 5791.1Scgdbuilt by default. 5801.1Scgd 5811.4ScgdLibraries are ranlib'd when made. 5821.56Ssommerfe 5831.56Ssommerfe=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 5841.56Ssommerfe 5851.56SsommerfeThe include file <bsd.obj.mk> defines targets related to the creation 5861.56Ssommerfeand use of separated object and source directories. 5871.56Ssommerfe 5881.63SsjgIf an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses 5891.63Ssjg${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if 5901.63Ssjgit exists. Otherwise make(1) looks for the existance of a 5911.63Ssjgsubdirectory (or a symlink to a directory) of the source directory 5921.63Ssjginto which built targets should be placed. If an environment variable 5931.63Ssjgnamed MAKEOBJDIR is set, make(1) uses its value as the name of the 5941.63Ssjgobject directory; failing that, make first looks for a subdirectory 5951.63Ssjgnamed "obj.${MACHINE}", and if that doesn't exist, it looks for "obj". 5961.56Ssommerfe 5971.56SsommerfeObject directories are not created automatically by make(1) if they 5981.56Ssommerfedon't exist; you need to run a separate "make obj". (This will happen 5991.56Ssommerfeduring a top-level build if "MKOBJDIRS" is set to a value other than 6001.58Ssommerfe"no"). When the source directory is a subdirectory of ${BSDSRCDIR} -- 6011.58Ssommerfeand this is determined by a simple string prefix comparison -- object 6021.58Ssommerfedirectories are created in a separate object directory tree, and a 6031.58Ssommerfesymlink to the object directory in that tree is created in the source 6041.58Ssommerfedirectory; otherwise, "make obj" assumes that you're not in the main 6051.58Ssommerfesource tree and that it's not safe to use a separate object tree. 6061.56Ssommerfe 6071.56SsommerfeSeveral variables used by <bsd.obj.mk> control exactly what 6081.56Ssommerfedirectories and links get created during a "make obj": 6091.56Ssommerfe 6101.56SsommerfeMAKEOBJDIR If set, this is the component name of the object 6111.56Ssommerfe directory. 6121.56Ssommerfe 6131.56SsommerfeOBJMACHINE If this is set but MAKEOBJDIR is not set, creates 6141.56Ssommerfe object directories or links named "obj.${MACHINE}"; 6151.56Ssommerfe otherwise, just creates ones named "obj". 6161.56Ssommerfe 6171.56SsommerfeUSR_OBJMACHINE If set, and the current directory is a subdirectory of 6181.56Ssommerfe ${BSDSRCDIR}, create object directory in the 6191.56Ssommerfe corresponding subdirectory of ${BSDOBJDIR}.${MACHINE}; 6201.56Ssommerfe otherwise, create it in the corresponding subdirectory 6211.56Ssommerfe of ${BSDOBJDIR} 6221.63Ssjg 6231.63Ssjg=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 6241.63Ssjg 6251.63SsjgThe include file <bsd.kernobj.mk> defines variables related to the 6261.63Ssjglocation of kernel sources and object directories. 6271.63Ssjg 6281.63SsjgKERNSRCDIR Is the location of the top of the kernel src. 6291.63Ssjg It defaults to ${BSDSRCDIR}/sys, but the top-level 6301.63Ssjg Makefile.inc sets it to ${ABSTOP}/sys (ABSTOP is the 6311.63Ssjg absolute path to the directory where the top-level 6321.63Ssjg Makefile.inc was found. 6331.63Ssjg 6341.63SsjgKERNARCHDIR Is the location of the machine dependent kernel 6351.63Ssjg sources. It defaults to arch/${MACHINE} 6361.63Ssjg 6371.63SsjgKERNCONFDIR Is where the configuration files for kernels are 6381.63Ssjg found; default is ${KERNSRCDIR}/${KERNARCHDIR}/conf. 6391.63Ssjg 6401.63SsjgKERNOBJDIR Is the kernel build directory. The kernel GENERIC for 6411.63Ssjg instance will be compiled in ${KERNOBJDIR}/GENERIC. 6421.63Ssjg The default value is 6431.63Ssjg ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile 6441.63Ssjg if it exists or the target 'obj' is being made. 6451.63Ssjg Otherwise the default is 6461.63Ssjg ${KERNSRCDIR}/${KERNARCHDIR}/compile. 6471.63Ssjg 6481.63SsjgIt is important that Makefiles (such as those under src/distrib) that 6491.63Ssjgwish to find compiled kernels use bsd.kernobj.mk and ${KERNOBJDIR} 6501.63Ssjgrather than make assumptions about the location of the compiled kernel. 6511.30Sagc 6521.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 653