# $NetBSD: bsd.README,v 1.102 2002/09/08 03:59:02 thorpej 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. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 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 to 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 switched 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 various make variables used during the build. Basic rule for the variable naming scheme is as follows: MKxxx Can be set to `no' by a user to disable functionality. Defaults to `yes' (or usually does) NOxxx If defined, disables a feature. Not intended for users, it's to allow Makefiles to disable functionality that they don't support (such as missing man pages). NOxxx variables must be defined before is included. The following variables that control how things are made/installed that are not set by default. These should not be set by Makefiles; they're for the user to define in MAKECONF (see bsd.own.mk, below) or on the make(1) command line: BUILD If defined, '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-existent targets. UPDATE If defined, 'make install' only installs targets that are more recently modified in the source directories that their installed counterparts. UNPRIVED If defined, don't set the owner/group/mode when installing files or directories, and keep a metadata log of what the owner/group/mode should be. This allows a non-root "make install". MKBFD If "no", don't build libbfd, libiberty, or any of the things that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage). Only meaningful if USE_NEW_TOOLCHAIN is set. MKCATPAGES If "no", don't build or install the catman pages. MKDOC If "no", don't build or install the documentation. MKGDB If "no", don't build gdb. Only meaningful if USE_NEW_TOOLCHAIN is set. MKGCC If "no", don't build gcc or any of the gcc-related libraries (libg2c, libgcc, libobjc, libstdc++). Only meaningful if USE_NEW_TOOLCHAIN is set. MKIEEEFP If "no", don't add code for IEEE754/IEC60559 conformance. Has no effect on most platforms. MKINFO If "no", don't build or install Info documentation from Texinfo source files. MKLINT If "no", don't build or install the lint libraries. MKMAN If "no", don't build or install the man or catman pages. Also acts as "MKCATPAGES=no" MKNLS If "no", don't build or install the NLS files and locale definition files. MKOBJ If "no", don't enable the rule which creates objdirs. "yes" by default. MKOBJDIRS If "no", don't create objdirs during a "make build". "no" by default. MKPIC If "no", don't build or install shared libraries. MKPICINSTALL If "no", don't install the *_pic.a libraries. MKPROFILE If "no", don't build or install the profiling libraries. MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKINFO=no MKMAN=no MKNLS=no". I.e, don't build catman pages, documentation, Info documentation, man pages, NLS files, ... =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 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. If you intend to run a cross build, you will need to supply the following host tools, and configure the following variables properly: OBJCOPY objcopy - copy and translate object files STRIP strip - Discard symbols from object files CONFIG config - build kernel compilation directories RPCGEN rpcgen - Remote Procedure Call (RPC) protocol compiler MKLOCALE mklocale - make LC_CTYPE locale files MTREE mtree - build directory tree from a spec 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. To get system-specific configuration parameters, bsd.own.mk will try to include the file specified by the "MAKECONF" variable. If MAKECONF is not set, or no such file exists, the system make configuration file, /etc/mk.conf is included. These files may define any of the variables described below. bsd.own.mk sets the following variables, if they are not already defined (defaults are in brackets): NETBSDSRCDIR Top of the NetBSD source tree. If _SRC_TOP_ != "", that will be used as the default, otherwise BSDSRCDIR will be used as the default. Various makefiles within the NetBSD source tree will use this to reference the top level of the source tree. _SRC_TOP_ Top of the system source tree, as determined by based on the presence of tools/ and build.sh. This variable is "internal" to , although its value is only determined once and then propagated to all sub-makes. 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. [wheel] BINOWN Binary owner. [root] BINMODE Binary mode. [555] NONBINMODE Mode for non-executable files. [444] MANDIR Base path for manual installation. [/usr/share/man/cat] MANGRP Manual group. [wheel] MANOWN Manual owner. [root] MANMODE Manual mode. [${NONBINMODE}] MANINSTALL Manual installation type: maninstall, catinstall, or both LDSTATIC Control program linking; if set blank, link everything dynamically. If set to "-static", link everything statically. If not set, programs link according to their makefile. LIBDIR Base path for library installation. [/usr/lib] SHLIBDIR If ${USE_SHLIBDIR} is "yes", use ${SHLIBDIR} instead of ${LIBDIR} as the base path for shared library installation. [/usr/lib] _LIBSODIR Set to ${SHLIBDIR} if ${USE_SHLIBDIR} is "yes", otherwise set to ${LIBDIR} SHLINKDIR Base path for shared linker. [/usr/libexec] 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] HTMLDOCDIR Base path for html system documentation installation. [/usr/share/doc/html] DOCGRP Documentation group. [wheel] DOCOWN Documentation owner. [root] DOCMODE Documentation mode. [${NONBINMODE}] NLSDIR Base path for Native Language Support files installation. [/usr/share/nls] NLSGRP Native Language Support files group. [wheel] NLSOWN Native Language Support files owner. [root] NLSMODE Native Language Support files mode. [${NONBINMODE}] STRIPFLAG 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): MKCRYPTO If set to "no", no cryptography support will be built into the system. Defaults to "yes". MKCRYPTO_IDEA If set to "yes", IDEA support will be built into libcrypto_idea.a. Defaults to "no". MKCRYPTO_RC5 If set to "yes", RC5 support will be built into libcrypto_rc5.a. Defaults to "no". MKHESIOD If set to "no", disables building of Hesiod infrastructure (libraries and support programs). MKKERBEROS If set to "no", disables building of Kerberos (v4 or v5) infrastructure (libraries and support programs). MKSKEY If set to "no", disables building of S/key authentication infrastructure (libraries and support programs). MKYP If set to "no", disables building of YP (NIS) infrastructure (libraries and support programs). USE_HESIOD If set to "no", disables building Hesiod support into various system utilities/libraries that support it. If MKHESIOD is set to "no", USE_HESIOD will also be forced to "no". USE_KERBEROS If set to "no", disables building Kerberos (v4 or v5) support into various system utilities/libraries that support it. If MKKERBEROS is set to "no", USE_KERBEROS will also be forced to "no". USE_SKEY If set to "no", disables building S/key authentication support into various system utilities/libraries that support it. If MKSKEY is set to "no", USE_SKEY will also be forced to "no". USE_YP If set to "no", disables building YP (NIS) support into various system utilities/libraries that support it. If MKYP is set to "no", USE_YP will also be forced to "no". 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 "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.] NOLINT Do not build lint libraries. OBJECT_FMT Object file format. [set to "ELF" on architectures that use ELF -- currently if ${MACHINE_ARCH} is "alpha", "mipsel", "mipseb", "powerpc", "sparc", "sparc64", "i386" and some m68k machines, or set to "a.out" on other architectures]. MKSOFTFLOAT If "yes", build with options to enable the compiler to generate output containing library calls for floating point and possibly soft-float library support. Defaults to "no". 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. This also creates a GDB initialization file (.gdbinit) in the objdir. The .gdbinit file sets the shared library prefix to ${DESTDIR} to facilitate cross-debugging. 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. `distclean' is a synonym for `cleandir'. 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. CPPFLAGS Additional flags to the C pre-processor GDBINIT List of GDB initialization files to add to "source" directives in the .gdbinit file that is created in the objdir. 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. PROG_CXX If defined, the name of the program to build. Also causes to link the program with the C++ compiler rather than the C compiler. PROG_CXX overrides the value of PROG if PROG is also set. 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 SRCS 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 LIBBZ2?= ${DESTDIR}/usr/lib/libbz2.a LIBC?= ${DESTDIR}/usr/lib/libc.a LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a LIBCDK?= ${DESTDIR}/usr/lib/libcdk.a LIBCOM_ERR?= ${DESTDIR}/usr/lib/libcom_err.a LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a LIBCRYPTO?= ${DESTDIR}/usr/lib/libcrypto.a LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a LIBCRYPTO_RC5?= ${DESTDIR}/usr/lib/libcrypto_rc5.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 LIBFORM?= ${DESTDIR}/usr/lib/libform.a LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a LIBGSSAPI?= ${DESTDIR}/usr/lib/libgssapi.a LIBHDB?= ${DESTDIR}/usr/lib/libhdb.a LIBINTL?= ${DESTDIR}/usr/lib/libintl.a LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a LIBKADM?= ${DESTDIR}/usr/lib/libkadm.a LIBKADM5CLNT?= ${DESTDIR}/usr/lib/libkadm5clnt.a LIBKADM5SRV?= ${DESTDIR}/usr/lib/libkadm5srv.a LIBKAFS?= ${DESTDIR}/usr/lib/libkafs.a LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a LIBKRB5?= ${DESTDIR}/usr/lib/libkrb5.a LIBKSTREAM?= ${DESTDIR}/usr/lib/libkstream.a LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a LIBL?= ${DESTDIR}/usr/lib/libl.a LIBM?= ${DESTDIR}/usr/lib/libm.a LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a LIBMP?= ${DESTDIR}/usr/lib/libmp.a LIBNTP?= ${DESTDIR}/usr/lib/libntp.a LIBOBJC?= ${DESTDIR}/usr/lib/libobjc.a LIBOSSAUDIO?= ${DESTDIR}/usr/lib/libossaudio.a LIBPC?= ${DESTDIR}/usr/lib/libpc.a LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a LIBPCI?= ${DESTDIR}/usr/lib/libpci.a LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a LIBPMC?= ${DESTDIR}/usr/lib/libpmc.a LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a LIBRMT?= ${DESTDIR}/usr/lib/librmt.a LIBROKEN?= ${DESTDIR}/usr/lib/libroken.a LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a LIBSS?= ${DESTDIR}/usr/lib/libss.a LIBSSL?= ${DESTDIR}/usr/lib/libssl.a LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a LIBSL?= ${DESTDIR}/usr/lib/libsl.a LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a LIBUSBHID?= ${DESTDIR}/usr/lib/libusbhid.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. STRIPFLAG 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_