1 # @(#)bsd.README 8.2 (Berkeley) 4/2/94
4 This is the README file for the "include" files for the FreeBSD
5 source tree. The files are installed in /usr/share/mk, and are by
6 convention, named with the suffix ".mk". These files store several
7 build options and should be handled with caution.
9 Note, this file is not intended to replace reading through the .mk
10 files for anything tricky.
12 There are two main types of make include files. One type is the generally
13 usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is
14 the internal make include files, such as bsd.files.mk and bsd.man.mk, which
15 can not/should not be used directly but are used by the other make include
16 files. In most cases it is only interesting to include bsd.prog.mk or
19 bsd.arch.inc.mk - includes arch-specific Makefile.$arch
20 bsd.compiler.mk - defined based on current compiler
21 bsd.confs.mk - install of configuration files
22 bsd.cpu.mk - sets CPU/arch-related variables (included from sys.mk)
23 bsd.crunchgen.mk - building crunched binaries using crunchgen(1)
24 bsd.dep.mk - handle Makefile dependencies
25 bsd.dirs.mk - handle directory creation
26 bsd.doc.mk - building troff system documents
27 bsd.endian.mk - TARGET_ENDIAN=1234(little) or 4321 (big) for target
28 bsd.files.mk - install of general purpose files
29 bsd.incs.mk - install of include files
30 bsd.info.mk - building GNU Info hypertext system (deprecated)
31 bsd.init.mk - initialization for the make include files
32 bsd.kmod.mk - building loadable kernel modules
33 bsd.lib.mk - support for building libraries
34 bsd.libnames.mk - define library names
35 bsd.links.mk - install of links (sym/hard)
36 bsd.man.mk - install of manual pages and their links
37 bsd.nls.mk - build and install of NLS catalogs
38 bsd.obj.mk - creating 'obj' directories and cleaning up
39 bsd.own.mk - define common variables
40 bsd.port.mk - building ports
41 bsd.port.post.mk - building ports
42 bsd.port.pre.mk - building ports
43 bsd.port.subdir.mk - targets for building subdirectories for ports
44 bsd.prog.mk - building programs from source files
45 bsd.progs.mk - build multiple programs from sources
46 bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd
47 bsd.subdir.mk - targets for building subdirectories
48 bsd.sys.mk - common settings used for building FreeBSD sources
49 bsd.test.mk - building test programs from source files
50 sys.mk - default rules for all makes
52 This file does not document bsd.port*.mk. They are documented in ports(7).
54 See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
55 Tutorial', located in /usr/share/doc/psd/12.make.
57 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
59 Random things worth knowing about this document:
61 If appropriate when documenting the variables the default value is
62 indicated using square brackets e.g. [gzip].
63 In some cases the default value depend on other values (e.g. system
64 architecture). In these cases the most common value is indicated.
66 This document contains some simple examples of the usage of the BSD make
67 include files. For more examples look at the makefiles in the FreeBSD
70 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
72 RANDOM THINGS WORTH KNOWING:
74 The files are like C-style #include files, and pretty much behave like
75 you'd expect. The syntax is slightly different in that a single '.' is
76 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
78 One difference that will save you lots of debugging time is that inclusion
79 of the file is normally done at the *end* of the Makefile. The reason for
80 this is because .mk files often modify variables and behavior based on the
81 values of variables set in the Makefile. To make this work, remember that
82 the FIRST target found is the target that is used, i.e. if the Makefile has:
89 the command "make a" will echo "a". To make things confusing, the SECOND
90 variable assignment is the overriding one, i.e. if the Makefile has:
98 the command "make b" will echo "bar". This is for compatibility with the
99 way the V7 make behaved.
101 It's fairly difficult to make the BSD .mk files work when you're building
102 multiple programs in a single directory. It's a lot easier to split up
103 the programs than to deal with the problem. Most of the agony comes from
104 making the "obj" directory stuff work right, not because we switch to a new
105 version of make. So, don't get mad at us, figure out a better way to handle
106 multiple architectures so we can quit using the symbolic link stuff.
107 (Imake doesn't count.)
109 The file .depend in the source directory is expected to contain dependencies
110 for the source files. This file is read automatically by make after reading
113 The variable DESTDIR works as before. It's not set anywhere but will change
114 the tree where the file gets installed.
116 The profiled libraries are no longer built in a different directory than
117 the regular libraries. A new suffix, ".po", is used to denote a profiled
118 object, and ".pico" denotes a position-independent relocatable object.
119 ".nossppico" denotes a position-independent relocatable object without
120 stack smashing protection.
122 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
124 The following variables are common:
127 Flags dependent on source file name.
129 Flags dependent on source file name.
131 Flags dependent on source file name.
132 CFLAGS.${COMPILER_TYPE}
133 Flags dependent on compiler added to CFLAGS.
134 CFLAGS.${MACHINE_ARCH}
135 Architectural flags added to CFLAGS.
136 CFLAGS_NO_SIMD Add this to CFLAGS for programs that don't want any SIMD
137 instructions generated. It is setup in bsd.cpu.mk to an
138 appropriate value for the compiler and target.
139 CXXFLAGS.${COMPILER_TYPE}
140 Flags dependent on compiler added to CXXFLAGS.
141 CXXFLAGS.${MACHINE_ARCH}
142 Architectural flags added to CXXFLAGS.
144 Flags dependent on source file name.
146 A list of features that the compiler supports. Zero or
148 c++11 Supports full C++ 11 standard.
150 COMPILER_TYPE Type of compiler, either clang or gcc, though other
151 values are possible. Don't assume != clang == gcc.
154 A numeric constant equal to:
155 major * 10000 + minor * 100 + tiny
156 for the compiler's self-reported version.
158 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
160 The include file <sys.mk> has the default rules for all makes, in the BSD
161 environment or otherwise. You probably don't want to touch this file.
163 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
165 The include file <bsd.arch.inc.mk> includes other Makefiles for specific
166 architectures, if they exist. It will include the first of the following
167 files that it finds: Makefile.${MACHINE}, Makefile.${MACHINE_ARCH},
168 Makefile.${MACHINE_CPUARCH}
170 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
172 The include file <bsd.man.mk> handles installing manual pages and their
175 It has three targets:
180 install the manual pages and their links.
182 verify the validity of manual pages.
184 It sets/uses the following variables:
186 MAN The manual pages to be installed (use a .1 - .9 suffix).
188 MANDIR Base path for manual installation.
196 MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
197 or "/tahoe" for machine specific manual pages.
199 MLINKS List of manual page links (using a .1 - .9 suffix). The
200 linked-to file must come first, the linked file second,
201 and there may be multiple pairs. The files are hard-linked.
203 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
206 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
208 The include file <bsd.own.mk> contains the owners, groups, etc. for both
209 manual pages and binaries.
213 It sets/uses the following variables:
221 MANDIR Base path for manual installation.
229 INSTALL_LINK Command to install a hard link.
231 INSTALL_SYMLINK Command to install a symbolic link.
233 INSTALL_RSYMLINK Command to install a relative symbolic link.
235 LINKOWN Owner of hard links created by INSTALL_LINK.
237 LINKGRP Group of hard links created by INSTALL_LINK.
239 LINKMODE Mode of hard links created by INSTALL_LINK.
241 SYMLINKOWN Owner of hard links created by INSTALL_[R]SYMLINK.
243 SYMLINKGRP Group of hard links created by INSTALL_[R]SYMLINK.
245 SYMLINKMODE Mode of hard links created by INSTALL_[R]SYMLINK.
247 This file is generally useful when building your own Makefiles so that
248 they use the same default owners etc. as the rest of the tree.
250 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
252 The include file <bsd.prog.mk> handles building programs from one or
253 more source files, along with their manual pages. It has a limited number
254 of suffixes, consistent with the current needs of the BSD tree.
256 It has seven targets:
259 build the program and its manual page
261 remove the program and any object files.
263 remove all of the files removed by the target clean, as
264 well as .depend, tags, and any manual pages.
266 make the dependencies for the source files, and store
267 them in the file .depend.
269 install the program and its manual pages; if the Makefile
270 does not itself define the target install, the targets
271 beforeinstall and afterinstall may also be used to cause
272 actions immediately before and after the install target
275 create a tags file for the source files.
277 It sets/uses the following variables:
279 ACFLAGS Flags to the compiler when preprocessing and
282 AFLAGS Flags to the assembler when assembling .s files.
290 CFLAGS Flags to the compiler when creating C objects.
292 CLEANDIRS Additional files (CLEANFILES) and directories (CLEANDIRS) to
293 CLEANFILES remove during clean and cleandir targets. "rm -rf" and
294 "rm -f" are used, respectively.
296 DIRS A list of variables referring to directories. For example:
301 Owner, Group, Mode and Flags are handled by FOO_OWN,
302 FOO_GRP, FOO_MODE and FOO_FLAGS, respectively.
304 This allows FILESDIR to be set to FOO, and the directory
305 will be created before the files are installed and the
306 dependencies will be set correctly.
308 DPADD Additional dependencies for the program. Usually used for
309 libraries. For example, to depend on the compatibility and
310 utility libraries use:
312 DPADD=${LIBCOMPAT} ${LIBUTIL}
314 There is a predefined identifier for each (non-profiled,
315 non-shared) library and object. Library file names are
316 transformed to identifiers by removing the extension and
317 converting to upper case.
319 There are no special identifiers for profiled or shared
320 libraries or objects. The identifiers for the standard
321 libraries are used in DPADD. This works correctly iff all
322 the libraries are built at the same time. Unfortunately,
323 it causes unnecessary relinks to shared libraries when
324 only the static libraries have changed. Dependencies on
325 shared libraries should be only on the library version
328 FILES A list of non-executable files.
329 The installation is controlled by the FILESNAME, FILESOWN,
330 FILESGRP, FILESMODE, FILESDIR variables that can be
331 further specialized by FILES<VAR>_<file>.
333 LDADD Additional loader objects. Usually used for libraries.
334 For example, to load with the compatibility and utility
337 LDADD=-lutil -lcompat
339 LDFLAGS Additional loader flags. Passed to the loader via CC,
340 since that's used to link programs as well, so loader
341 specific flags need to be prefixed with -Wl, to work.
343 LIBADD Additional libraries. This is for base system libraries
344 and is only valid inside of the /usr/src tree.
345 Use LIBADD=name instead of LDADD=-lname.
347 LINKS The list of binary links; should be full pathnames, the
348 linked-to file coming first, followed by the linked
349 file. The files are hard-linked. For example, to link
350 /bin/test and /bin/[, use:
352 LINKS= /bin/test /bin/[
354 LINKOWN Owner of links created with LINKS [${BINOWN}].
356 LINKGRP Group of links created with LINKS [${BINGRP}].
358 LINKMODE Mode of links created with LINKS [${BINMODE}].
361 MAN Manual pages. If no MAN variable is defined,
362 "MAN=${PROG}.1" is assumed. See bsd.man.mk for more details.
364 PROG The name of the program to build. If not supplied, nothing
367 PROGNAME The name that the above program will be installed as, if
368 different from ${PROG}.
370 PROG_CXX If defined, the name of the program to build. Also
371 causes <bsd.prog.mk> to link the program with the
372 standard C++ library. PROG_CXX overrides the value
373 of PROG if PROG is also set.
375 PROGS When used with <bsd.progs.mk>, allow building multiple
376 PROGS_CXX PROG and PROG_CXX in one Makefile. To define
377 individual variables for each program the VAR.prog
378 syntax should be used. For example:
385 The supported variables are:
395 - INTERNALPROG (no installation)
408 SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
409 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
410 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
411 further specialized by SCRIPTS<VAR>_<script>.
413 SRCS List of source files to build the program. If SRCS is not
414 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
415 defined, ${PROG_CXX}.cc.
417 STRIP The flag passed to the install program to cause the binary
418 to be stripped. This is to be used when building your
419 own install script so that the entire system can be made
420 stripped/not-stripped using a single nob.
422 SUBDIR A list of subdirectories that should be built as well.
423 Each of the targets will execute the same target in the
426 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
427 if it exists, as well as the include file <bsd.man.mk>.
429 Some simple examples:
431 To build foo from foo.c with a manual page foo.1, use:
435 .include <bsd.prog.mk>
437 To build foo from foo.c with a manual page foo.2, add the line:
441 If foo does not have a manual page at all, add the line:
445 If foo has multiple source files, add the line:
447 SRCS= a.c b.c c.c d.c
449 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
451 The include file, <bsd.snmpmod.mk>, handles building MIB modules for bsnmpd
452 from one or more source files, along with their manual pages. It has a
453 limited number of suffixes, consistent with the current needs of the BSD
456 bsd.snmpmod.mk leverages bsd.lib.mk for building MIB modules and
457 bsd.files.mk for installing MIB description and definition files.
459 It implements the following additional targets:
462 execute smilint on the MIBs defined by BMIBS.
464 The net-mgmt/libsmi package must be installed before
465 executing this target. The net-mgmt/net-snmp package
466 should be installed as well to reduce false positives
469 It sets/uses the following variables:
471 BMIBS The MIB definitions to install.
473 BMIBSDIR The directory where the MIB definitions are installed.
474 This defaults to `${SHAREDIR}/snmp/mibs`.
476 DEFS The MIB description files to install.
478 DEFSDIR The directory where MIB description files are installed.
479 This defaults to `${SHAREDIR}/snmp/defs`.
481 EXTRAMIBDEFS Extra MIB description files to use as input when
482 generating ${MOD}_oid.h and ${MOD}_tree.[ch].
484 EXTRAMIBSYMS Extra MIB definition files used only for extracting
487 EXTRAMIBSYMS are useful when resolving inter-module
488 dependencies and are useful with files containing only
491 See ${MOD}_oid.h for more details.
493 LOCALBASE The package root where smilint and the net-snmp
494 definitions can be found
496 MOD The bsnmpd module name.
498 SMILINT smilint binary to use with the smilint make target.
500 SMILINT_FLAGS flags to pass to smilint.
502 SMIPATH A colon-separated directory path where MIBs definitions
503 can be found. See "SMIPATH" in smi_config for more
506 XSYM MIB names to extract symbols for. See ${MOD}_oid.h for
509 It generates the following files:
511 ${MOD}_tree.c A source file and header which programmatically describes
512 ${MOD}_tree.h the MIB (type, OID name, ACCESS attributes, etc).
514 The files are generated via "gensnmptree -p".
516 See gensnmptree(1) for more details.
518 ${MOD}_oid.h A header which programmatically describes the MIB root and
521 The files are generated via "gensnmptree -e".
523 See gensnmptree(1) for more details.
525 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
527 The include file <bsd.subdir.mk> contains the default targets for building
528 subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
529 cleandir, depend, install, and tags. For all of the directories listed in the
530 variable SUBDIRS, the specified directory will be visited and the target made.
531 There is also a default target which allows the command "make subdir" where
532 subdir is any directory listed in the variable SUBDIRS.
534 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
536 The include file <bsd.lib.mk> has support for building libraries. It has the
537 same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, install, and
538 tags. It has a limited number of suffixes, consistent with the current needs of
541 It sets/uses the following variables:
543 LDADD Additional loader objects.
545 LIB The name of the library to build. Both a shared and static
546 library will be built. NO_PIC can be set to only build a
549 LIBADD Additional libraries. This is for base system libraries
550 and is only valid inside of the /usr/src tree.
551 Use LIBADD=name instead of LDADD=-lname.
553 LIBDIR Target directory for libraries.
555 LIBGRP Library group.
557 LIBMODE Library mode.
559 LIBOWN Library owner.
561 LIBRARIES_ONLY Do not build or install files other than the library.
563 LIB_CXX The name of the library to build. It also causes
564 <bsd.lib.mk> to link the library with the
565 standard C++ library. LIB_CXX overrides the value
566 of LIB if LIB is also set. Both a shared and static library
567 will be built. NO_PIC can be set to only build a static
570 LINKS The list of binary links; should be full pathnames, the
571 linked-to file coming first, followed by the linked
572 file. The files are hard-linked. For example, to link
573 /bin/test and /bin/[, use:
575 LINKS= /bin/test /bin/[
577 LINKOWN Owner of links created with LINKS [${LIBOWN}].
579 LINKGRP Group of links created with LINKS [${LIBGRP}].
581 LINKMODE Mode of links created with LINKS [${LIBMODE}].
583 LINTLIBDIR Target directory for lint libraries.
585 MAN The manual pages to be installed. See bsd.man.mk for more
588 SHLIB Like LIB but only builds a shared library.
590 SHLIB_CXX Like LIB_CXX but only builds a shared library.
592 SHLIB_LDSCRIPT Template file to generate shared library linker script.
593 If not defined, a simple symlink is created to the real
596 SRCS List of source files to build the library. Suffix types
597 .s, .c, and .f are supported. Note, .s files are preferred
598 to .c files of the same name. (This is not the default for
601 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
602 if it exists, as well as the include file <bsd.man.mk>.
604 It has rules for building profiled objects; profiled libraries are
607 Libraries are ranlib'd before installation.
609 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
611 The include file <bsd.test.mk> handles building one or more test programs
612 intended to be used in the FreeBSD Test Suite under /usr/tests/.
614 It has seven targets:
617 build the test programs.
619 runs the test programs with kyua test.
621 The beforecheck and aftercheck targets will be invoked, if
622 defined, to execute commands before and after the realcheck
623 target has been executed, respectively.
625 The devel/kyua package must be installed before invoking this
628 remove the test programs and any object files.
630 remove all of the files removed by the target clean, as
631 well as .depend and tags.
633 make the dependencies for the source files, and store
634 them in the file .depend.
636 install the test programs and their data files; if the
637 Makefile does not itself define the target install, the
638 targets beforeinstall and afterinstall may also be used
639 to cause actions immediately before and after the
640 install target is executed.
642 create a tags file for the source files.
644 It sets/uses the following variables, among many others:
646 ATF_TESTS_C The names of the ATF C test programs to build.
648 ATF_TESTS_CXX The names of the ATF C++ test programs to build.
650 ATF_TESTS_SH The names of the ATF sh test programs to build.
652 GTESTS The names of the GoogleTest test programs to build.
654 KYUAFILE If 'auto' (the default), generate a Kyuafile out of the
655 test programs defined in the Makefile. If 'yes', then a
656 manually-crafted Kyuafile must be supplied with the
657 sources. If 'no', no Kyuafile is installed (useful for
658 subdirectories providing helper programs or data files
661 LOCALBASE The --prefix for the kyua package.
663 The value of LOCALBASE defaults to /usr/local .
666 If defined, none of the built test programs get
667 installed under /usr/tests/ and no Kyuafile is
668 automatically generated. Should not be used within the
669 FreeBSD source tree but is provided for the benefit of
672 PLAIN_TESTS_C The names of the plain (legacy) programs to build.
674 PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
676 PLAIN_TESTS_SH The names of the plain (legacy) test programs to build.
679 Path to the Perl interpreter to be used for
680 TAP-compliant test programs that are written in Perl.
681 Refer to TAP_TESTS_PERL for details.
683 TAP_TESTS_C The names of the TAP-compliant C test programs to build.
685 TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to
688 TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to
689 build. The corresponding source files should end with
690 the .pl extension; the test program is marked as
691 requiring Perl; and TAP_PERL_INTERPRETER is used in the
692 built scripts as the interpreter of choice.
694 TAP_TESTS_SH The names of the TAP-compliant sh test programs to
697 TESTSBASE Installation prefix for tests. Defaults to /usr/tests
699 TESTSDIR Path to the installed tests. Must be a subdirectory of
700 TESTSBASE and the subpath should match the relative
701 location of the tests within the src tree.
703 The value of TESTSDIR defaults to
704 ${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when
705 included from bin/ls/tests .
707 TESTS_SUBDIRS List of subdirectories containing tests into which to
708 recurse. Differs from SUBDIR in that these directories
709 get registered into the automatically-generated
712 The actual building of the test programs is performed by <bsd.prog.mk>.
713 Please see the documentation above for this other file for additional
714 details on the behavior of <bsd.test.mk>.