1# @(#)bsd.README 8.2 (Berkeley) 4/2/94 2# $FreeBSD$ 3 4This is the README file for the "include" files for the FreeBSD 5source tree. The files are installed in /usr/share/mk, and are by 6convention, named with the suffix ".mk". These files store several 7build options and should be handled with caution. 8 9Note, this file is not intended to replace reading through the .mk 10files for anything tricky. 11 12There are two main types of make include files. One type is the generally 13usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is 14the internal make include files, such as bsd.files.mk and bsd.man.mk, which 15can not/should not be used directly but are used by the other make include 16files. In most cases it is only interesting to include bsd.prog.mk or 17bsd.lib.mk. 18 19bsd.cpu.mk - sets CPU/arch-related variables 20bsd.dep.mk - handle Makefile dependencies 21bsd.doc.mk - building troff system documents 22bsd.files.mk - install of general purpose files 23bsd.incs.mk - install of include files 24bsd.info.mk - building GNU Info hypertext system 25bsd.init.mk - initialization for the make include files 26bsd.kmod.mk - building loadable kernel modules 27bsd.lib.mk - support for building libraries 28bsd.libnames.mk - define library names 29bsd.links.mk - install of links (sym/hard) 30bsd.man.mk - install of manual pages and their links 31bsd.nls.mk - build and install of NLS catalogs 32bsd.obj.mk - creating 'obj' directories and cleaning up 33bsd.own.mk - define common variables 34bsd.port.mk - building ports 35bsd.port.post.mk - building ports 36bsd.port.pre.mk - building ports 37bsd.port.subdir.mk - targets for building subdirectories for ports 38bsd.prog.mk - building programs from source files 39bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd 40bsd.subdir.mk - targets for building subdirectories 41bsd.sys.mk - common settings used for building FreeBSD sources 42bsd.test.mk - building test programs from source files 43sys.mk - default rules for all makes 44 45This file does not document bsd.port*.mk. They are documented in ports(7). 46 47See also make(1), mkdep(1), style.Makefile(5) and `PMake - A 48Tutorial', located in /usr/share/doc/psd/12.make. 49 50=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 51 52Random things worth knowing about this document: 53 54If appropriate when documenting the variables the default value is 55indicated using square brackets e.g. [gzip]. 56In some cases the default value depend on other values (e.g. system 57architecture). In these cases the most common value is indicated. 58 59This document contains some simple examples of the usage of the BSD make 60include files. For more examples look at the makefiles in the FreeBSD 61source tree. 62 63=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 64 65RANDOM THINGS WORTH KNOWING: 66 67The files are like C-style #include files, and pretty much behave like 68you'd expect. The syntax is slightly different in that a single '.' is 69used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 70 71One difference that will save you lots of debugging time is that inclusion 72of the file is normally done at the *end* of the Makefile. The reason for 73this is because .mk files often modify variables and behavior based on the 74values of variables set in the Makefile. To make this work, remember that 75the FIRST target found is the target that is used, i.e. if the Makefile has: 76 77 a: 78 echo a 79 a: 80 echo a number two 81 82the command "make a" will echo "a". To make things confusing, the SECOND 83variable assignment is the overriding one, i.e. if the Makefile has: 84 85 a= foo 86 a= bar 87 88 b: 89 echo ${a} 90 91the command "make b" will echo "bar". This is for compatibility with the 92way the V7 make behaved. 93 94It's fairly difficult to make the BSD .mk files work when you're building 95multiple programs in a single directory. It's a lot easier to split up 96the programs than to deal with the problem. Most of the agony comes from 97making the "obj" directory stuff work right, not because we switch to a new 98version of make. So, don't get mad at us, figure out a better way to handle 99multiple architectures so we can quit using the symbolic link stuff. 100(Imake doesn't count.) 101 102The file .depend in the source directory is expected to contain dependencies 103for the source files. This file is read automatically by make after reading 104the Makefile. 105 106The variable DESTDIR works as before. It's not set anywhere but will change 107the tree where the file gets installed. 108 109The profiled libraries are no longer built in a different directory than 110the regular libraries. A new suffix, ".po", is used to denote a profiled 111object. 112 113=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 114 115The include file <sys.mk> has the default rules for all makes, in the BSD 116environment or otherwise. You probably don't want to touch this file. 117 118=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 119 120The include file <bsd.man.mk> handles installing manual pages and their 121links. 122 123It has three targets: 124 125 all-man: 126 build manual pages. 127 maninstall: 128 install the manual pages and their links. 129 manlint: 130 verify the validity of manual pages. 131 132It sets/uses the following variables: 133 134MANDIR Base path for manual installation. 135 136MANGRP Manual group. 137 138MANOWN Manual owner. 139 140MANMODE Manual mode. 141 142MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 143 or "/tahoe" for machine specific manual pages. 144 145MAN The manual pages to be installed (use a .1 - .9 suffix). 146 147MLINKS 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 hard-linked. 150 151The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 152it exists. 153 154=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 155 156The include file <bsd.own.mk> contains the owners, groups, etc. for both 157manual pages and binaries. 158 159It has no targets. 160 161It sets/uses the following variables: 162 163BINGRP Binary group. 164 165BINOWN Binary owner. 166 167BINMODE Binary mode. 168 169MANDIR Base path for manual installation. 170 171MANGRP Manual group. 172 173MANOWN Manual owner. 174 175MANMODE Manual mode. 176 177This file is generally useful when building your own Makefiles so that 178they use the same default owners etc. as the rest of the tree. 179 180=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 181 182The include file <bsd.prog.mk> handles building programs from one or 183more source files, along with their manual pages. It has a limited number 184of suffixes, consistent with the current needs of the BSD tree. 185 186It has seven targets: 187 188 all: 189 build the program and its manual page 190 clean: 191 remove the program and any object files. 192 cleandir: 193 remove all of the files removed by the target clean, as 194 well as .depend, tags, and any manual pages. 195 depend: 196 make the dependencies for the source files, and store 197 them in the file .depend. 198 install: 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 203 is executed. 204 lint: 205 run lint on the source files 206 tags: 207 create a tags file for the source files. 208 209It sets/uses the following variables: 210 211BINGRP Binary group. 212 213BINOWN Binary owner. 214 215BINMODE Binary mode. 216 217CLEANFILES Additional files to remove and 218CLEANDIRS additional directories to remove during clean and cleandir 219 targets. "rm -f" and "rm -rf" used respectively. 220 221CFLAGS Flags to the compiler when creating C objects. 222 223FILES 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>. 227 228LDADD Additional loader objects. Usually used for libraries. 229 For example, to load with the compatibility and utility 230 libraries, use: 231 232 LDADD=-lutil -lcompat 233 234LDFLAGS 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. 237 238LINKS 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: 242 243 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 244 245MAN Manual pages (should end in .1 - .9). If no MAN variable 246 is defined, "MAN=${PROG}.1" is assumed. 247 248PROG The name of the program to build. If not supplied, nothing 249 is built. 250 251PROG_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. 255 256PROGNAME The name that the above program will be installed as, if 257 different from ${PROG}. 258 259SRCS 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. 262 263DPADD Additional dependencies for the program. Usually used for 264 libraries. For example, to depend on the compatibility and 265 utility libraries use: 266 267 DPADD=${LIBCOMPAT} ${LIBUTIL} 268 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. 273 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 281 numbers. 282 283STRIP 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. 287 288SUBDIR A list of subdirectories that should be built as well. 289 Each of the targets will execute the same target in the 290 subdirectories. 291 292SCRIPTS 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>. 296 297The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 298if it exists, as well as the include file <bsd.man.mk>. 299 300Some simple examples: 301 302To build foo from foo.c with a manual page foo.1, use: 303 304 PROG= foo 305 306 .include <bsd.prog.mk> 307 308To build foo from foo.c with a manual page foo.2, add the line: 309 310 MAN= foo.2 311 312If foo does not have a manual page at all, add the line: 313 314 MAN= 315 316If foo has multiple source files, add the line: 317 318 SRCS= a.c b.c c.c d.c 319 320=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 321 322The include file <bsd.subdir.mk> contains the default targets for building 323subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 324cleandir, depend, install, lint, and tags. For all of the directories 325listed in the variable SUBDIRS, the specified directory will be visited 326and the target made. There is also a default target which allows the 327command "make subdir" where subdir is any directory listed in the variable 328SUBDIRS. 329 330=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 331 332The include file <bsd.lib.mk> has support for building libraries. It has 333the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 334install, lint, and tags. It has a limited number of suffixes, consistent 335with the current needs of the BSD tree. 336 337It sets/uses the following variables: 338 339LIBDIR Target directory for libraries. 340 341LINTLIBDIR Target directory for lint libraries. 342 343LIBGRP Library group. 344 345LIBOWN Library owner. 346 347LIBMODE Library mode. 348 349LDADD Additional loader objects. 350 351MAN The manual pages to be installed (use a .1 - .9 suffix). 352 353SRCS 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 356 versions of make.) 357 358SHLIB_LDSCRIPT Template file to generate shared library linker script. 359 Unless used, a simple symlink is created to the real 360 shared object. 361 362LIBRARIES_ONLY Do not build or install files other than the library. 363 364The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 365if it exists, as well as the include file <bsd.man.mk>. 366 367It has rules for building profiled objects; profiled libraries are 368built by default. 369 370Libraries are ranlib'd before installation. 371 372=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 373 374The include file <bsd.test.mk> handles building one or more test programs 375intended to be used in the FreeBSD Test Suite under /usr/tests/. 376 377It has seven targets: 378 379 all: 380 build the test programs. 381 clean: 382 remove the test programs and any object files. 383 cleandir: 384 remove all of the files removed by the target clean, as 385 well as .depend and tags. 386 depend: 387 make the dependencies for the source files, and store 388 them in the file .depend. 389 install: 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. 395 lint: 396 run lint on the source files. 397 tags: 398 create a tags file for the source files. 399 test: 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 404 target is executed. 405 406It sets/uses the following variables, among many others: 407 408TESTDIR 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. 411 412KYUAFILE 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 417 only). 418 419ATF_TESTS_C The names of the ATF C test programs to build. 420 421ATF_TESTS_CXX The names of the ATF C++ test programs to build. 422 423ATF_TESTS_SH The names of the ATF sh test programs to build. 424 425PLAIN_TESTS_C The names of the plain (legacy) programs to build. 426 427PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build. 428 429PLAIN_TESTS_SH The names of the plain (legacy) test programs to build. 430 431TAP_PERL_INTERPRETER 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. 435 436TAP_TESTS_C The names of the TAP-compliant C test programs to build. 437 438TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to 439 build. 440 441TAP_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. 446 447TAP_TESTS_SH The names of the TAP-compliant sh test programs to 448 build. 449 450TESTS_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 453 Kyuafile (if any). 454 455NOT_FOR_TEST_SUITE 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 460 third-parties. 461 462The actual building of the test programs is performed by <bsd.prog.mk>. 463Please see the documentation above for this other file for additional 464details on the behavior of <bsd.test.mk>. 465