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.cpu.mk - sets CPU/arch-related variables
20 bsd.dep.mk - handle Makefile dependencies
21 bsd.doc.mk - building troff system documents
22 bsd.files.mk - install of general purpose files
23 bsd.incs.mk - install of include files
24 bsd.info.mk - building GNU Info hypertext system
25 bsd.init.mk - initialization for the make include files
26 bsd.kmod.mk - building loadable kernel modules
27 bsd.lib.mk - support for building libraries
28 bsd.libnames.mk - define library names
29 bsd.links.mk - install of links (sym/hard)
30 bsd.man.mk - install of manual pages and their links
31 bsd.nls.mk - build and install of NLS catalogs
32 bsd.obj.mk - creating 'obj' directories and cleaning up
33 bsd.own.mk - define common variables
34 bsd.port.mk - building ports
35 bsd.port.post.mk - building ports
36 bsd.port.pre.mk - building ports
37 bsd.port.subdir.mk - targets for building subdirectories for ports
38 bsd.prog.mk - building programs from source files
39 bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd
40 bsd.subdir.mk - targets for building subdirectories
41 bsd.sys.mk - common settings used for building FreeBSD sources
42 bsd.test.mk - building test programs from source files
43 sys.mk - default rules for all makes
45 This file does not document bsd.port*.mk. They are documented in ports(7).
47 See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
48 Tutorial', located in /usr/share/doc/psd/12.make.
50 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
52 Random things worth knowing about this document:
54 If appropriate when documenting the variables the default value is
55 indicated using square brackets e.g. [gzip].
56 In some cases the default value depend on other values (e.g. system
57 architecture). In these cases the most common value is indicated.
59 This document contains some simple examples of the usage of the BSD make
60 include files. For more examples look at the makefiles in the FreeBSD
63 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
65 RANDOM THINGS WORTH KNOWING:
67 The files are like C-style #include files, and pretty much behave like
68 you'd expect. The syntax is slightly different in that a single '.' is
69 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
71 One difference that will save you lots of debugging time is that inclusion
72 of the file is normally done at the *end* of the Makefile. The reason for
73 this is because .mk files often modify variables and behavior based on the
74 values of variables set in the Makefile. To make this work, remember that
75 the FIRST target found is the target that is used, i.e. if the Makefile has:
82 the command "make a" will echo "a". To make things confusing, the SECOND
83 variable assignment is the overriding one, i.e. if the Makefile has:
91 the command "make b" will echo "bar". This is for compatibility with the
92 way the V7 make behaved.
94 It's fairly difficult to make the BSD .mk files work when you're building
95 multiple programs in a single directory. It's a lot easier to split up
96 the programs than to deal with the problem. Most of the agony comes from
97 making the "obj" directory stuff work right, not because we switch to a new
98 version of make. So, don't get mad at us, figure out a better way to handle
99 multiple architectures so we can quit using the symbolic link stuff.
100 (Imake doesn't count.)
102 The file .depend in the source directory is expected to contain dependencies
103 for the source files. This file is read automatically by make after reading
106 The variable DESTDIR works as before. It's not set anywhere but will change
107 the tree where the file gets installed.
109 The profiled libraries are no longer built in a different directory than
110 the regular libraries. A new suffix, ".po", is used to denote a profiled
113 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
115 The include file <sys.mk> has the default rules for all makes, in the BSD
116 environment or otherwise. You probably don't want to touch this file.
118 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
120 The include file <bsd.man.mk> handles installing manual pages and their
123 It has three targets:
128 install the manual pages and their links.
130 verify the validity of manual pages.
132 It sets/uses the following variables:
134 MANDIR Base path for manual installation.
142 MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
143 or "/tahoe" for machine specific manual pages.
145 MAN The manual pages to be installed (use a .1 - .9 suffix).
147 MLINKS List of manual page links (using a .1 - .9 suffix). The
148 linked-to file must come first, the linked file second,
149 and there may be multiple pairs. The files are soft-linked.
151 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
154 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
156 The include file <bsd.own.mk> contains the owners, groups, etc. for both
157 manual pages and binaries.
161 It sets/uses the following variables:
169 MANDIR Base path for manual installation.
177 This file is generally useful when building your own Makefiles so that
178 they use the same default owners etc. as the rest of the tree.
180 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
182 The include file <bsd.prog.mk> handles building programs from one or
183 more source files, along with their manual pages. It has a limited number
184 of suffixes, consistent with the current needs of the BSD tree.
186 It has seven targets:
189 build the program and its manual page
191 remove the program and any object files.
193 remove all of the files removed by the target clean, as
194 well as .depend, tags, and any manual pages.
196 make the dependencies for the source files, and store
197 them in the file .depend.
199 install the program and its manual pages; if the Makefile
200 does not itself define the target install, the targets
201 beforeinstall and afterinstall may also be used to cause
202 actions immediately before and after the install target
205 run lint on the source files
207 create a tags file for the source files.
209 It sets/uses the following variables:
217 CLEANFILES Additional files to remove and
218 CLEANDIRS additional directories to remove during clean and cleandir
219 targets. "rm -f" and "rm -rf" used respectively.
221 CFLAGS Flags to the compiler when creating C objects.
223 FILES A list of non-executable files.
224 The installation is controlled by the FILESNAME, FILESOWN,
225 FILESGRP, FILESMODE, FILESDIR variables that can be
226 further specialized by FILES<VAR>_<file>.
228 LDADD Additional loader objects. Usually used for libraries.
229 For example, to load with the compatibility and utility
232 LDADD=-lutil -lcompat
234 LDFLAGS Additional loader flags. Passed to the loader via CC,
235 since that's used to link programs as well, so loader
236 specific flags need to be prefixed with -Wl, to work.
238 LINKS The list of binary links; should be full pathnames, the
239 linked-to file coming first, followed by the linked
240 file. The files are hard-linked. For example, to link
241 /bin/test and /bin/[, use:
243 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
245 MAN Manual pages (should end in .1 - .9). If no MAN variable
246 is defined, "MAN=${PROG}.1" is assumed.
248 PROG The name of the program to build. If not supplied, nothing
251 PROG_CXX If defined, the name of the program to build. Also
252 causes <bsd.prog.mk> to link the program with the
253 standard C++ library. PROG_CXX overrides the value
254 of PROG if PROG is also set.
256 PROGNAME The name that the above program will be installed as, if
257 different from ${PROG}.
259 SRCS List of source files to build the program. If SRCS is not
260 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
261 defined, ${PROG_CXX}.cc.
263 DPADD Additional dependencies for the program. Usually used for
264 libraries. For example, to depend on the compatibility and
265 utility libraries use:
267 DPADD=${LIBCOMPAT} ${LIBUTIL}
269 There is a predefined identifier for each (non-profiled,
270 non-shared) library and object. Library file names are
271 transformed to identifiers by removing the extension and
272 converting to upper case.
274 There are no special identifiers for profiled or shared
275 libraries or objects. The identifiers for the standard
276 libraries are used in DPADD. This works correctly iff all
277 the libraries are built at the same time. Unfortunately,
278 it causes unnecessary relinks to shared libraries when
279 only the static libraries have changed. Dependencies on
280 shared libraries should be only on the library version
283 STRIP The flag passed to the install program to cause the binary
284 to be stripped. This is to be used when building your
285 own install script so that the entire system can be made
286 stripped/not-stripped using a single nob.
288 SUBDIR A list of subdirectories that should be built as well.
289 Each of the targets will execute the same target in the
292 SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
293 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
294 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
295 further specialized by SCRIPTS<VAR>_<script>.
297 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
298 if it exists, as well as the include file <bsd.man.mk>.
300 Some simple examples:
302 To build foo from foo.c with a manual page foo.1, use:
306 .include <bsd.prog.mk>
308 To build foo from foo.c with a manual page foo.2, add the line:
312 If foo does not have a manual page at all, add the line:
316 If foo has multiple source files, add the line:
318 SRCS= a.c b.c c.c d.c
320 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
322 The include file <bsd.subdir.mk> contains the default targets for building
323 subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
324 cleandir, depend, install, lint, and tags. For all of the directories
325 listed in the variable SUBDIRS, the specified directory will be visited
326 and the target made. There is also a default target which allows the
327 command "make subdir" where subdir is any directory listed in the variable
330 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
332 The include file <bsd.lib.mk> has support for building libraries. It has
333 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
334 install, lint, and tags. It has a limited number of suffixes, consistent
335 with the current needs of the BSD tree.
337 It sets/uses the following variables:
339 LIBDIR Target directory for libraries.
341 LINTLIBDIR Target directory for lint libraries.
343 LIBGRP Library group.
345 LIBOWN Library owner.
347 LIBMODE Library mode.
349 LDADD Additional loader objects.
351 MAN The manual pages to be installed (use a .1 - .9 suffix).
353 SRCS List of source files to build the library. Suffix types
354 .s, .c, and .f are supported. Note, .s files are preferred
355 to .c files of the same name. (This is not the default for
358 SHLIB_LDSCRIPT Template file to generate shared library linker script.
359 Unless used, a simple symlink is created to the real
362 LIBRARIES_ONLY Do not build or install files other than the library.
364 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
365 if it exists, as well as the include file <bsd.man.mk>.
367 It has rules for building profiled objects; profiled libraries are
370 Libraries are ranlib'd before installation.
372 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
374 The include file <bsd.test.mk> handles building one or more test programs
375 intended to be used in the FreeBSD Test Suite under /usr/tests/.
377 It has seven targets:
380 build the test programs.
382 remove the test programs and any object files.
384 remove all of the files removed by the target clean, as
385 well as .depend and tags.
387 make the dependencies for the source files, and store
388 them in the file .depend.
390 install the test programs and their data files; if the
391 Makefile does not itself define the target install, the
392 targets beforeinstall and afterinstall may also be used
393 to cause actions immediately before and after the
394 install target is executed.
396 run lint on the source files.
398 create a tags file for the source files.
400 runs the test programs from the object directory; if the
401 Makefile does not itself define the target test, the
402 targets beforetest and aftertest may also be used to
403 cause actions immediately before and after the test
406 It sets/uses the following variables, among many others:
408 TESTDIR Path to the installed tests. Must be a subdirectory of
409 TESTSBASE and the subpath should match the relative
410 location of the tests within the src tree.
412 KYUAFILE If 'auto' (the default), generate a Kyuafile out of the
413 test programs defined in the Makefile. If 'yes', then a
414 manually-crafted Kyuafile must be supplied with the
415 sources. If 'no', no Kyuafile is installed (useful for
416 subdirectories providing helper programs or data files
419 ATF_TESTS_C The names of the ATF C test programs to build.
421 ATF_TESTS_CXX The names of the ATF C++ test programs to build.
423 ATF_TESTS_SH The names of the ATF sh test programs to build.
425 PLAIN_TESTS_C The names of the plain (legacy) programs to build.
427 PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
429 PLAIN_TESTS_SH The names of the plain (legacy) test programs to build.
432 Path to the Perl interpreter to be used for
433 TAP-compliant test programs that are written in Perl.
434 Refer to TAP_TESTS_PERL for details.
436 TAP_TESTS_C The names of the TAP-compliant C test programs to build.
438 TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to
441 TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to
442 build. The corresponding source files should end with
443 the .pl extension; the test program is marked as
444 requiring Perl; and TAP_PERL_INTERPRETER is used in the
445 built scripts as the interpreter of choice.
447 TAP_TESTS_SH The names of the TAP-compliant sh test programs to
450 TESTS_SUBDIRS List of subdirectories containing tests into which to
451 recurse. Differs from SUBDIR in that these directories
452 get registered into the automatically-generated
456 If defined, none of the built test programs get
457 installed under /usr/tests/ and no Kyuafile is
458 automatically generated. Should not be used within the
459 FreeBSD source tree but is provided for the benefit of
462 The actual building of the test programs is performed by <bsd.prog.mk>.
463 Please see the documentation above for this other file for additional
464 details on the behavior of <bsd.test.mk>.