bsd.README revision 1.56
11.56Ssommerfe# $NetBSD: bsd.README,v 1.56 1999/12/01 03:33:52 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.15Scgd 2001.34SlukemDOCGRP Documentation group. [wheel] 2011.15Scgd 2021.34SlukemDOCOWN Documentation owner. [root] 2031.15Scgd 2041.15ScgdDOCMODE Documentation mode. [${NONBINMODE}] 2051.15Scgd 2061.15ScgdNLSDIR Base path for National Language Support files installation. 2071.15Scgd [/usr/share/nls] 2081.1Scgd 2091.34SlukemNLSGRP National Language Support files group. [wheel] 2101.1Scgd 2111.34SlukemNLSOWN National Language Support files owner. [root] 2121.1Scgd 2131.15ScgdNLSMODE National Language Support files mode. [${NONBINMODE}] 2141.1Scgd 2151.32SmikelSTRIPFLAG The flag passed to the install program to cause the binary 2161.1Scgd to be stripped. This is to be used when building your 2171.1Scgd own install script so that the entire system can be made 2181.15Scgd stripped/not-stripped using a single knob. [-s] 2191.1Scgd 2201.2ScgdCOPY The flag passed to the install program to cause the binary 2211.2Scgd to be copied rather than moved. This is to be used when 2221.2Scgd building our own install script so that the entire system 2231.2Scgd can either be installed with copies, or with moves using 2241.15Scgd a single knob. [-c] 2251.15Scgd 2261.17SthorpejAdditionally, the following variables may be set by bsd.own.mk or in a 2271.17Sthorpejmake configuration file to modify the behaviour of the system build 2281.17Sthorpejprocess (default values are in brackets along with comments, if set by 2291.17Sthorpejbsd.own.mk): 2301.15Scgd 2311.50SthorpejCRYPTOBASE Select which cryptography code base to use when building 2321.50Sthorpej cryptography support into the system. See the 2331.50Sthorpej bsd.crypto.mk section for more information. 2341.50Sthorpej 2351.15ScgdEXPORTABLE_SYSTEM 2361.50Sthorpej Forces CRYPTOBASE to the value "none" for compatibility 2371.50Sthorpej with older NetBSD build environments. See the bsd.crypto.mk 2381.50Sthorpej section for more information. 2391.2Scgd 2401.15ScgdSKEY Compile in support for S/key authentication. [yes, set 2411.15Scgd unconditionally] 2421.15Scgd 2431.15ScgdKERBEROS Compile in support for Kerberos 4 authentication. 2441.15Scgd 2451.15ScgdKERBEROS5 Compile in support for Kerberos 5 authentication. 2461.15Scgd 2471.15ScgdMANZ Compress manual pages at installation time. 2481.15Scgd 2491.15ScgdSYS_INCLUDE Copy or symlink kernel include files into /usr/include. 2501.15Scgd Possible values are "symlinks" or "copies" (which is 2511.15Scgd the same as the variable being unset). 2521.1Scgd 2531.15ScgdNOPROFILE Do not build profiled versions of system libraries 2541.1Scgd 2551.15ScgdNOPIC Do not build PIC versions of system libraries, and 2561.15Scgd do not build shared libraries. [set if ${MACHINE_ARCH} 2571.45Slukem is "sparc64", unset otherwise.] 2581.1Scgd 2591.40SperryNOLINT Do not build lint libraries. 2601.33Sjonathan 2611.50SthorpejOBJECT_FMT Object file format. [set to "ELF" on architectures that 2621.50Sthorpej use ELF -- currently if ${MACHINE_ARCH} is "alpha", 2631.50Sthorpej "mipsel", "mipseb", "powerpc", "sparc", "sparc64", 2641.50Sthorpej and "i386", or set to "a.out" on other architectures]. 2651.33Sjonathan 2661.1Scgd 2671.17Sthorpejbsd.own.mk is generally useful when building your own Makefiles so that 2681.1Scgdthey use the same default owners etc. as the rest of the tree. 2691.1Scgd 2701.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 2711.1Scgd 2721.1ScgdThe include file <bsd.prog.mk> handles building programs from one or 2731.1Scgdmore source files, along with their manual pages. It has a limited number 2741.1Scgdof suffixes, consistent with the current needs of the BSD tree. 2751.1Scgd 2761.16SjtcIt has eight targets: 2771.1Scgd 2781.1Scgd all: 2791.1Scgd build the program and its manual page 2801.1Scgd clean: 2811.1Scgd remove the program, any object files and the files a.out, 2821.24Smikel Errs, errs, mklog, and ${PROG}.core. 2831.1Scgd cleandir: 2841.1Scgd remove all of the files removed by the target clean, as 2851.1Scgd well as .depend, tags, and any manual pages. 2861.42Slukem `distclean' is a synonym for `cleandir'. 2871.1Scgd depend: 2881.1Scgd make the dependencies for the source files, and store 2891.1Scgd them in the file .depend. 2901.16Sjtc includes: 2911.16Sjtc install any header files. 2921.1Scgd install: 2931.1Scgd install the program and its manual pages; if the Makefile 2941.1Scgd does not itself define the target install, the targets 2951.1Scgd beforeinstall and afterinstall may also be used to cause 2961.1Scgd actions immediately before and after the install target 2971.1Scgd is executed. 2981.1Scgd lint: 2991.1Scgd run lint on the source files 3001.1Scgd tags: 3011.1Scgd create a tags file for the source files. 3021.1Scgd 3031.1ScgdIt sets/uses the following variables: 3041.1Scgd 3051.1ScgdBINGRP Binary group. 3061.1Scgd 3071.1ScgdBINOWN Binary owner. 3081.1Scgd 3091.1ScgdBINMODE Binary mode. 3101.1Scgd 3111.1ScgdCLEANFILES Additional files to remove for the clean and cleandir targets. 3121.1Scgd 3131.1ScgdCOPTS Additional flags to the compiler when creating C objects. 3141.35Slukem 3151.35SlukemCPPFLAGS Additional flags to the C pre-processor 3161.1Scgd 3171.1ScgdLDADD Additional loader objects. Usually used for libraries. 3181.1Scgd For example, to load with the compatibility and utility 3191.1Scgd libraries, use: 3201.1Scgd 3211.5Sjtc LDADD+=-lutil -lcompat 3221.1Scgd 3231.1ScgdLDFLAGS Additional loader flags. 3241.1Scgd 3251.1ScgdLINKS The list of binary links; should be full pathnames, the 3261.1Scgd linked-to file coming first, followed by the linked 3271.1Scgd file. The files are hard-linked. For example, to link 3281.1Scgd /bin/test and /bin/[, use: 3291.1Scgd 3301.1Scgd LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 3311.19Sperry 3321.19SperrySYMLINKS The list of symbolic links; should be full pathnames. 3331.20Sperry Syntax is identical to LINKS. Note that DESTDIR is not 3341.20Sperry automatically included in the link. 3351.1Scgd 3361.15ScgdMAN Manual pages (should end in .1 - .9). If no MAN variable is 3371.8Scgd defined, "MAN=${PROG}.1" is assumed. 3381.1Scgd 3391.1ScgdPROG The name of the program to build. If not supplied, nothing 3401.1Scgd is built. 3411.1Scgd 3421.21SchristosPROGNAME The name that the above program will be installed as, if 3431.21Schristos different from ${PROG}. 3441.21Schristos 3451.37StvSRCS List of source files to build the program. If SRCS is not 3461.1Scgd defined, it's assumed to be ${PROG}.c. 3471.1Scgd 3481.1ScgdDPADD Additional dependencies for the program. Usually used for 3491.1Scgd libraries. For example, to depend on the compatibility and 3501.1Scgd utility libraries use: 3511.1Scgd 3521.5Sjtc DPADD+=${LIBCOMPAT} ${LIBUTIL} 3531.1Scgd 3541.1Scgd The following libraries are predefined for DPADD: 3551.1Scgd 3561.21Schristos LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 3571.21Schristos LIBC?= ${DESTDIR}/usr/lib/libc.a 3581.21Schristos LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 3591.21Schristos LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 3601.21Schristos LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 3611.21Schristos LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 3621.21Schristos LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 3631.21Schristos LIBDES?= ${DESTDIR}/usr/lib/libdes.a 3641.21Schristos LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 3651.21Schristos LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 3661.21Schristos LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 3671.49Sitojun LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a 3681.21Schristos LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a 3691.21Schristos LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a 3701.21Schristos LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 3711.21Schristos LIBL?= ${DESTDIR}/usr/lib/libl.a 3721.21Schristos LIBM?= ${DESTDIR}/usr/lib/libm.a 3731.53Sblymn LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a 3741.21Schristos LIBMP?= ${DESTDIR}/usr/lib/libmp.a 3751.25Schristos LIBNTP?= ${DESTDIR}/usr/lib/libntp.a 3761.21Schristos LIBPC?= ${DESTDIR}/usr/lib/libpc.a 3771.21Schristos LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 3781.21Schristos LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a 3791.26Skleink LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a 3801.21Schristos LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 3811.21Schristos LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 3821.21Schristos LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 3831.21Schristos LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a 3841.21Schristos LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a 3851.21Schristos LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 3861.21Schristos LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 3871.21Schristos LIBY?= ${DESTDIR}/usr/lib/liby.a 3881.21Schristos LIBZ?= ${DESTDIR}/usr/lib/libz.a 3891.21Schristos 3901.1Scgd 3911.1ScgdSHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 3921.12Schristos strings, using xstr(1). Note that this will not work with 3931.12Schristos parallel makes. 3941.1Scgd 3951.1ScgdSTRIP The flag passed to the install program to cause the binary 3961.1Scgd to be stripped. 3971.1Scgd 3981.1ScgdSUBDIR A list of subdirectories that should be built as well. 3991.1Scgd Each of the targets will execute the same target in the 4001.1Scgd subdirectories. 4011.1Scgd 4021.21SchristosSCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 4031.21Schristos These are installed exactly like programs. 4041.21Schristos 4051.21SchristosSCRIPTSNAME The name that the above program will be installed as, if 4061.21Schristos different from ${SCRIPTS}. These can be further specialized 4071.21Schristos by setting SCRIPTSNAME_<script>. 4081.21Schristos 4091.21SchristosFILES A list of files to install. The installation is controlled 4101.21Schristos by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR 4111.21Schristos variables that can be further specialized by FILES<VAR>_<file> 4121.21Schristos 4131.1ScgdThe include file <bsd.prog.mk> includes the file named "../Makefile.inc" 4141.1Scgdif it exists, as well as the include file <bsd.man.mk>. 4151.1Scgd 4161.1ScgdSome simple examples: 4171.1Scgd 4181.1ScgdTo build foo from foo.c with a manual page foo.1, use: 4191.1Scgd 4201.1Scgd PROG= foo 4211.1Scgd 4221.1Scgd .include <bsd.prog.mk> 4231.1Scgd 4241.1ScgdTo build foo from foo.c with a manual page foo.2, add the line: 4251.1Scgd 4261.9Scgd MAN= foo.2 4271.1Scgd 4281.1ScgdIf foo does not have a manual page at all, add the line: 4291.1Scgd 4301.1Scgd NOMAN= noman 4311.1Scgd 4321.1ScgdIf foo has multiple source files, add the line: 4331.1Scgd 4341.1Scgd SRCS= a.c b.c c.c d.c 4351.1Scgd 4361.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4371.1Scgd 4381.1ScgdThe include file <bsd.subdir.mk> contains the default targets for building 4391.16Sjtcsubdirectories. It has the same eight targets as <bsd.prog.mk>: all, 4401.16Sjtcclean, cleandir, depend, includes, install, lint, and tags. For all of 4411.16Sjtcthe directories listed in the variable SUBDIRS, the specified directory 4421.16Sjtcwill be visited and the target made. There is also a default target which 4431.16Sjtcallows the command "make subdir" where subdir is any directory listed in 4441.16Sjtcthe variable SUBDIRS. 4451.21Schristos 4461.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4471.21Schristos 4481.23SchristosThe include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 4491.23Schristosand is included from from bsd.lib.mk and bsd.prog.mk. 4501.23Schristos 4511.23Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4521.23Schristos 4531.23SchristosThe include file <bsd.files.mk> handles the FILES variables and is included 4541.23Schristosfrom bsd.lib.mk and bsd.prog.mk. 4551.21Schristos 4561.21Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4571.21Schristos 4581.29ScjsThe include file <bsd.inc.mk> defines the includes target and uses two 4591.29Scjsvariables: 4601.21Schristos 4611.29ScjsINCS The list of include files 4621.21Schristos 4631.29ScjsINCSDIR The location to install the include files. 4641.39Scgd 4651.39Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4661.39Scgd 4671.39ScgdThe include file <bsd.kinc.mk> defines the many targets (includes, 4681.39Scgdsubdirectories, etc.), and is used by kernel makefiles to handle 4691.39Scgdinclude file installation. It is intended to be included alone, by 4701.39Scgdkernel Makefiles. Please see bsd.kinc.mk for more details, and keep 4711.39Scgdthe documentation in that file up to date. 4721.13Schristos 4731.13Schristos=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4741.13Schristos 4751.47StvThe include file <bsd.info.mk> is used to generate and install GNU Info 4761.47Stvdocumentation from respective Texinfo source files. It defines three 4771.47Stvimplicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the 4781.47Stvfollowing variables: 4791.47Stv 4801.47StvTEXINFO List of Texinfo source files. Info documentation will 4811.47Stv consist of single files with the extension replaced by 4821.47Stv .info. 4831.47Stv 4841.47StvINFOFLAGS Flags to pass to makeinfo. [] 4851.47Stv 4861.47StvINSTALL_INFO Name of install-info program. [install-info] 4871.47Stv 4881.47StvMAKEINFO Name of makeinfo program. [makeinfo] 4891.47Stv 4901.47Stv=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4911.47Stv 4921.13SchristosThe include file <bsd.sys.mk> is used by <bsd.prog.mk> and 4931.14Scgd<bsd.lib.mk>. It contains overrides that are used when building 4941.14Scgdthe NetBSD source tree. For instance, if "PARALLEL" is defined by 4951.14Scgdthe program/library Makefile, it includes a set of rules for lex and 4961.14Scgdyacc that allow multiple lex and yacc targets to be built in parallel. 4971.1Scgd 4981.1Scgd=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4991.1Scgd 5001.1ScgdThe include file <bsd.lib.mk> has support for building libraries. It has 5011.16Sjtcthe same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 5021.44Serhincludes, install, lint, and tags. Additionally, it has a checkver target 5031.44Serhwhich checks for installed shared object libraries whose version is greater 5041.44Serhthat the version of the source. It has a limited number of suffixes, 5051.16Sjtcconsistent with the current needs of the BSD tree. 5061.1Scgd 5071.1ScgdIt sets/uses the following variables: 5081.10Scgd 5091.10ScgdLIB The name of the library to build. 5101.1Scgd 5111.1ScgdLIBDIR Target directory for libraries. 5121.1Scgd 5131.1ScgdLINTLIBDIR Target directory for lint libraries. 5141.1Scgd 5151.1ScgdLIBGRP Library group. 5161.1Scgd 5171.1ScgdLIBOWN Library owner. 5181.1Scgd 5191.1ScgdLIBMODE Library mode. 5201.1Scgd 5211.1ScgdLDADD Additional loader objects. 5221.1Scgd 5231.15ScgdMAN The manual pages to be installed (use a .1 - .9 suffix). 5241.47Stv 5251.47StvMKLINKLIB If "no", act as "MKPICINSTALL=no MKPROFILE=no". 5261.47Stv Also: 5271.47Stv - don't install the .a libraries 5281.47Stv - don't install _pic.a libraries on PIC systems 5291.47Stv - don't build .a libraries on PIC systems 5301.47Stv - don't install the .so symlink on ELF systems 5311.47Stv I.e, only install the shared library (and the .so.major 5321.47Stv symlink on ELF). 5331.54Ssimonb 5341.54SsimonbMKPICLIB If "no", don't build _pic.a libraries, and build the 5351.54Ssimonb shared object libraries from the .a libraries. A 5361.54Ssimonb symlink is installed in ${DESTDIR}/usr/lib for the 5371.54Ssimonb _pic.a library pointing to the .a library. 5381.44Serh 5391.44SerhNOCHECKVER_<library> 5401.44SerhNOCHECKVER If set, disables checking for installed shared object 5411.44Serh libraries with versions greater than the source. A 5421.44Serh particular library name, without the "lib" prefix, may 5431.44Serh be appended to the variable name to disable the check for 5441.44Serh only that library. 5451.1Scgd 5461.1ScgdSRCS List of source files to build the library. Suffix types 5471.1Scgd .s, .c, and .f are supported. Note, .s files are preferred 5481.1Scgd to .c files of the same name. (This is not the default for 5491.1Scgd versions of make.) 5501.1Scgd 5511.1ScgdThe include file <bsd.lib.mk> includes the file named "../Makefile.inc" 5521.1Scgdif it exists, as well as the include file <bsd.man.mk>. 5531.1Scgd 5541.1ScgdIt has rules for building profiled objects; profiled libraries are 5551.1Scgdbuilt by default. 5561.1Scgd 5571.4ScgdLibraries are ranlib'd when made. 5581.50Sthorpej 5591.50Sthorpej=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 5601.50Sthorpej 5611.50SthorpejThe include file <bsd.crypto.mk> contains variables related to building 5621.50Sthorpejcryptography support into the system. 5631.50Sthorpej 5641.50SthorpejIt has no targets. 5651.50Sthorpej 5661.50SthorpejIn order to get system-specific crypto configuration parameters, 5671.50Sthorpejbsd.crypto.mk will include <bsd.own.mk>, which in turn will include 5681.50Sthorpejthe configuration file specified by the "MAKECONF" variable. See 5691.50Sthorpejthe <bsd.own.mk> section for more information. 5701.50Sthorpej 5711.50Sthorpejbsd.crypto.mk requires the "SRCTOP" variable to be defined before 5721.50Sthorpejinclusion. This variable contains the relative path to the top of 5731.50Sthorpejthe source tree, with no trailing '/'. 5741.50Sthorpej 5751.50SthorpejThe variable "CRYPTOBASE" may be set by the user to select which 5761.50Sthorpejcryptography code base will be used when building the system. If 5771.50SthorpejCRYPTOBASE is set to "none", no cryptography support will be built 5781.50Sthorpejinto the system. CRYPTOBASE should be set to the name of the crypto 5791.50Sthorpejsub-tree in the SRCTOP directory. If CRYPTOBASE is not set, 5801.50Sthorpejbsd.crypto.mk will use the following algorithm to set the variable: 5811.50Sthorpej 5821.50Sthorpej .if exists(${SRCTOP}/crypto-us) 5831.50Sthorpej CRYPTOBASE=crypto-us 5841.50Sthorpej .elif exists(${SRCTOP}/crypto-intl) 5851.50Sthorpej CRYPTOBASE=crypto-intl 5861.50Sthorpej .else 5871.50Sthorpej undef CRYPTOBASE 5881.50Sthorpej .endif 5891.50Sthorpej 5901.50SthorpejNote that it is legal for the user to set CRYPTOBASE to a relative 5911.50Sthorpejpath outside of the source directory. For example: 5921.50Sthorpej 5931.50Sthorpej CRYPTOPATH= ../cryptosrc-intl/crypto-intl 5941.50Sthorpej 5951.50SthorpejIf CRYPTOBASE is set and not set to "none", bsd.crypto.mk will use 5961.50SthorpejCRYPTOBASE to set the "CRYPTOPATH" variable. CRYPTOPATH is set to 5971.50Sthorpejthe value "${SRCTOP}/${CRYPTOBASE}". 5981.50Sthorpej 5991.50SthorpejOnce CRYPTOPATH is set by bsd.crypto.mk, it checks to see if the 6001.50Sthorpejpath actually exists. If it does not exist, the variable is undefined. 6011.50SthorpejProgram and library Makefiles may key off the definition of CRYPTOPATH 6021.50Sthorpejto determine if cryptography support is to be included in that program. 6031.50SthorpejFor example, a typical program Makefile should do the following: 6041.50Sthorpej 6051.50Sthorpej SRCTOP= ../.. 6061.50Sthorpej .include <bsd.crypto.mk> 6071.50Sthorpej 6081.50Sthorpej PROG= login 6091.50Sthorpej SRCS= login.c 6101.50Sthorpej . 6111.50Sthorpej . 6121.50Sthorpej . 6131.50Sthorpej .if defined(CRYPTOPATH) 6141.51Smrg .sinclude "${CRYPTOPATH}/usr.bin/login/Makefile.frag" 6151.50Sthorpej .endif 6161.50Sthorpej 6171.51SmrgThe Makefile.frag included (if it exists) will now influence the build 6181.51Smrgof the login(1) program, specifying additional source files, libraries, 6191.51Smrgand CPP flags. 6201.50Sthorpej 6211.50SthorpejThe "EXPORTABLE_SYSTEM" variable, if set, causes CRYPTOBASE to be set 6221.50Sthorpejto "none". This is for compatibilty with older NetBSD build environments. 6231.56Ssommerfe 6241.56Ssommerfe=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 6251.56Ssommerfe 6261.56SsommerfeThe include file <bsd.obj.mk> defines targets related to the creation 6271.56Ssommerfeand use of separated object and source directories. 6281.56Ssommerfe 6291.56Ssommerfemake(1) looks for the existance of a subdirectory (or a symlink to a 6301.56Ssommerfedirectory) of the source directory into which built targets should be 6311.56Ssommerfeplaced. If an environment variable named MAKEOBJDIR is set, make(1) 6321.56Ssommerfeuses its value as the name of the object directory; failing that, make 6331.56Ssommerfefirst looks for a subdirectory named "obj.${MACHINE}", and if that 6341.56Ssommerfedoesn't exist, it looks for "obj". 6351.56Ssommerfe 6361.56SsommerfeObject directories are not created automatically by make(1) if they 6371.56Ssommerfedon't exist; you need to run a separate "make obj". (This will happen 6381.56Ssommerfeduring a top-level build if "MKOBJDIRS" is set to a value other than 6391.56Ssommerfe"no"). When the source directory is a subdirectory of ${BSDSRCDIR}, 6401.56Ssommerfeobject directories are created in a separate object directory tree, 6411.56Ssommerfeand a symlink to the object directory in that tree is created in the 6421.56Ssommerfesource directory. 6431.56Ssommerfe 6441.56SsommerfeSeveral variables used by <bsd.obj.mk> control exactly what 6451.56Ssommerfedirectories and links get created during a "make obj": 6461.56Ssommerfe 6471.56SsommerfeMAKEOBJDIR If set, this is the component name of the object 6481.56Ssommerfe directory. 6491.56Ssommerfe 6501.56SsommerfeOBJMACHINE If this is set but MAKEOBJDIR is not set, creates 6511.56Ssommerfe object directories or links named "obj.${MACHINE}"; 6521.56Ssommerfe otherwise, just creates ones named "obj". 6531.56Ssommerfe 6541.56SsommerfeUSR_OBJMACHINE If set, and the current directory is a subdirectory of 6551.56Ssommerfe ${BSDSRCDIR}, create object directory in the 6561.56Ssommerfe corresponding subdirectory of ${BSDOBJDIR}.${MACHINE}; 6571.56Ssommerfe otherwise, create it in the corresponding subdirectory 6581.56Ssommerfe of ${BSDOBJDIR} 6591.30Sagc 6601.30Sagc=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 661