# $NetBSD: bsd.README,v 1.28 1997/05/29 06:26:35 mikel Exp $ # @(#)bsd.README 8.2 (Berkeley) 4/2/94 This is the README file for the new make "include" files for the BSD source tree. The files are installed in /usr/share/mk, and are, by convention, named with the suffix ".mk". Note, this file is not intended to replace reading through the .mk files for anything tricky. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= CONFIGURATION: `Global' configuration variables you wish to use for all builds may be placed in the file pointed to by the MAKECONF variable, or /etc/mk.conf if MAKECONF is unset. Configuration for a certain directory tree may be placed in Build.conf at the root of that tree. The first instance of make will search from the source directory upwards for a Build.conf file; when it finds one, it will include it and remember the location in the BUILDCONF variable, which will be passed on to any further instances of make in MAKEFLAGS. If you wish to use a specific Build.conf file, you can just specify it (using a full path) in the BUILDCONF variable when you run make. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= BUILD DIRECTORIES: These makefiles use the concept of a `build directory,' which holds include files and libraries that the programs are built against. This allows you to build an entire new system, including new libraries, without having to install its include files or libraries into the currently running system. When you start make it will check for the existence of the directory named in BSDOBJDIR, with your architecture name appended if USR_OBJMACHINE is defined. If that directory exists, it assumes that you are compiling your object files to it and it will create a subdirectory under it called `build' to be your build directory. `make includes' will install include files to that, rather than to DESTDIR, and when the libraries are compiled links to them will be placed in the build directory as well. Please note that for this to work BSDOBJDIR must be set while you are doing your compile, not just while you're doing the `make obj' (as previously). The actual location of the object files will still be wherever the symbolic links for `obj' or `obj.machine' in your source tree point. If you are not using a separate object tree (you are putting the object files in the source directories or in obj directories under the source directories), DESTDIR will be used as the build directory, and you will need to install include files and libraries there by hand before you can compile other programs. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= RANDOM THINGS WORTH KNOWING: The files are simply C-style #include files, and pretty much behave like you'd expect. The syntax is slightly different in that a single '.' is used instead of the hash mark, i.e. ".include ". One difference that will save you lots of debugging time is that inclusion of the file is normally done at the *end* of the Makefile. The reason for this is because .mk files often modify variables and behavior based on the values of variables set in the Makefile. To make this work, remember that the FIRST target found is the target that is used, i.e. if the Makefile has: a: echo a a: echo a number two the command "make a" will echo "a". To make things confusing, the SECOND variable assignment is the overriding one, i.e. if the Makefile has: a= foo a= bar b: echo ${a} the command "make b" will echo "bar". This is for compatibility with the way the V7 make behaved. It's fairly difficult to make the BSD .mk files work when you're building multiple programs in a single directory. It's a lot easier split up the programs than to deal with the problem. Most of the agony comes from making the "obj" directory stuff work right, not because we switch to a new version of make. So, don't get mad at us, figure out a better way to handle multiple architectures so we can quit using the symbolic link stuff. (Imake doesn't count.) The file .depend in the source directory is expected to contain dependencies for the source files. This file is read automatically by make after reading the Makefile. The variable DESTDIR works as before. It's not set anywhere but will change the tree where the file gets installed. The profiled libraries are no longer built in a different directory than the regular libraries. A new suffix, ".po", is used to denote a profiled object, and ".so" denotes a shared (position-independent) object. There are two variables that control how things are made/installed that are not set by default: BUILD If set 'make install' checks that the targets in the source directories are up-to-date and remakes them if they are out of date, instead of blindly trying to install out of date or non-existant targets. UPDATE 'make install' only installs targets that are more recently modified in the source directories that their installed counterparts. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= The include file has the default rules for all makes, in the BSD environment or otherwise. You probably don't want to touch this file. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= The include file handles installing manual pages and their links. It has a two targets: maninstall: Install the manual page sources and their links. catinstall: Install the preformatted manual pages and their links. It sets/uses the following variables: MANDIR Base path for manual installation. MANGRP Manual group. MANOWN Manual owner. MANMODE Manual mode. MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" or "/tahoe" for machine specific manual pages. MAN The manual pages to be installed (use a .1 - .9 suffix). MLINKS List of manual page links (using a .1 - .9 suffix). The linked-to file must come first, the linked file second, and there may be multiple pairs. The files are soft-linked. The include file includes a file named "../Makefile.inc" if it exists. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= The include file contains source tree configuration parameters, such as the owners, groups, etc. for both manual pages and binaries, and a few global "feature configuration" parameters. It has no targets. This file is safe to include more than once, and may be included at the top of your makefile, rather than the bottom, if your makefile needs any of the information it defines. To get system- and build-specific configuration parameters, bsd.own.mk will look for the MAKECONF and BUILDCONF files as described under the `Configuration' section above. bsd.own.mk sets the following variables, if they are not already defined (defaults are in brackets): BSDSRCDIR The real path to the system sources, so that 'make obj' will work correctly. [/usr/src] BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' will work correctly. [/usr/obj] BINGRP Binary group. [bin] BINOWN Binary owner. [bin] BINMODE Binary mode. [555] NONBINMODE Mode for non-executable files. [444] MANDIR Base path for manual installation. [/usr/share/man/cat] MANGRP Manual group. [bin] MANOWN Manual owner. [bin] MANMODE Manual mode. [${NONBINMODE}] MANINSTALL Manual installation type: maninstall, catinstall, or both LIBDIR Base path for library installation. [/usr/lib] LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] LIBGRP Library group. [${BINGRP}] LIBOWN Library owner. [${BINOWN}] LIBMODE Library mode. [${NONBINMODE}] DOCDIR Base path for system documentation (e.g. PSD, USD, etc.) installation. [/usr/share/doc] DOCGRP Documentation group. [bin] DOCOWN Documentation owner. [bin] DOCMODE Documentation mode. [${NONBINMODE}] NLSDIR Base path for National Language Support files installation. [/usr/share/nls] NLSGRP National Language Support files group. [bin] NLSOWN National Language Support files owner. [bin] NLSMODE National Language Support files mode. [${NONBINMODE}] STRIP The flag passed to the install program to cause the binary to be stripped. This is to be used when building your own install script so that the entire system can be made stripped/not-stripped using a single knob. [-s] COPY The flag passed to the install program to cause the binary to be copied rather than moved. This is to be used when building our own install script so that the entire system can either be installed with copies, or with moves using a single knob. [-c] Additionally, the following variables may be set by bsd.own.mk or in a make configuration file to modify the behaviour of the system build process (default values are in brackets along with comments, if set by bsd.own.mk): EXPORTABLE_SYSTEM Do not build /usr/src/domestic, even if it is present. SKEY Compile in support for S/key authentication. [yes, set unconditionally] KERBEROS Compile in support for Kerberos 4 authentication. KERBEROS5 Compile in support for Kerberos 5 authentication. MANZ Compress manual pages at installation time. SYS_INCLUDE Copy or symlink kernel include files into /usr/include. Possible values are "symlinks" or "copies" (which is the same as the variable being unset). NOPROFILE Do not build profiled versions of system libraries NOPIC Do not build PIC versions of system libraries, and do not build shared libraries. [set if ${MACHINE_ARCH} is "mips", "vax", "alpha" or "arm32", unset otherwise.] NOLINT Do not build lint libraries. [set, set unconditionally] bsd.own.mk is generally useful when building your own Makefiles so that they use the same default owners etc. as the rest of the tree. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= The include file handles building programs from one or more source files, along with their manual pages. It has a limited number of suffixes, consistent with the current needs of the BSD tree. It has eight targets: all: build the program and its manual page clean: remove the program, any object files and the files a.out, Errs, errs, mklog, and ${PROG}.core. cleandir: remove all of the files removed by the target clean, as well as .depend, tags, and any manual pages. depend: make the dependencies for the source files, and store them in the file .depend. includes: install any header files. install: install the program and its manual pages; if the Makefile does not itself define the target install, the targets beforeinstall and afterinstall may also be used to cause actions immediately before and after the install target is executed. lint: run lint on the source files tags: create a tags file for the source files. It sets/uses the following variables: BINGRP Binary group. BINOWN Binary owner. BINMODE Binary mode. CLEANFILES Additional files to remove for the clean and cleandir targets. COPTS Additional flags to the compiler when creating C objects. LDADD Additional loader objects. Usually used for libraries. For example, to load with the compatibility and utility libraries, use: LDADD+=-lutil -lcompat LDFLAGS Additional loader flags. LINKS The list of binary links; should be full pathnames, the linked-to file coming first, followed by the linked file. The files are hard-linked. For example, to link /bin/test and /bin/[, use: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ SYMLINKS The list of symbolic links; should be full pathnames. Syntax is identical to LINKS. Note that DESTDIR is not automatically included in the link. MAN Manual pages (should end in .1 - .9). If no MAN variable is defined, "MAN=${PROG}.1" is assumed. PROG The name of the program to build. If not supplied, nothing is built. PROGNAME The name that the above program will be installed as, if different from ${PROG}. SRCS List of source files to build the program. If PROG is not defined, it's assumed to be ${PROG}.c. DPADD Additional dependencies for the program. Usually used for libraries. For example, to depend on the compatibility and utility libraries use: DPADD+=${LIBCOMPAT} ${LIBUTIL} The following libraries are predefined for DPADD: LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o LIBC?= ${DESTDIR}/usr/lib/libc.a LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a LIBDES?= ${DESTDIR}/usr/lib/libdes.a LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a LIBL?= ${DESTDIR}/usr/lib/libl.a LIBM?= ${DESTDIR}/usr/lib/libm.a LIBMP?= ${DESTDIR}/usr/lib/libmp.a LIBNTP?= ${DESTDIR}/usr/lib/libntp.a LIBPC?= ${DESTDIR}/usr/lib/libpc.a LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a LIBY?= ${DESTDIR}/usr/lib/liby.a LIBZ?= ${DESTDIR}/usr/lib/libz.a SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared strings, using xstr(1). Note that this will not work with parallel makes. STRIP The flag passed to the install program to cause the binary to be stripped. SUBDIR A list of subdirectories that should be built as well. Each of the targets will execute the same target in the subdirectories. SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. These are installed exactly like programs. SCRIPTSNAME The name that the above program will be installed as, if different from ${SCRIPTS}. These can be further specialized by setting SCRIPTSNAME_