bsd.README revision 1.371
1# $NetBSD: bsd.README,v 1.371 2018/05/09 22:24:01 joerg Exp $ 2# @(#)bsd.README 8.2 (Berkeley) 4/2/94 3 4This is the README file for the make "include" files for the NetBSD 5source tree. The files are installed in /usr/share/mk, and are, 6by convention, named with the suffix ".mk". 7 8Note, this file is not intended to replace reading through the .mk 9files for anything tricky. 10 11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 12 13RANDOM THINGS WORTH KNOWING: 14 15The files are simply C-style #include files, and pretty much behave like 16you'd expect. The syntax is slightly different in that a single '.' is 17used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 18 19One difference that will save you lots of debugging time is that inclusion 20of the file is normally done at the *end* of the Makefile. The reason for 21this is because .mk files often modify variables and behavior based on the 22values of variables set in the Makefile. To make this work, remember that 23the FIRST target found is the target that is used, i.e. if the Makefile has: 24 25 a: 26 echo a 27 a: 28 echo a number two 29 30the command "make a" will echo "a". To make things confusing, the SECOND 31variable assignment is the overriding one, i.e. if the Makefile has: 32 33 a= foo 34 a= bar 35 36 b: 37 echo ${a} 38 39the command "make b" will echo "bar". This is for compatibility with the 40way the V7 make behaved. 41 42It's fairly difficult to make the BSD .mk files work when you're building 43multiple programs in a single directory. It's a lot easier to split up the 44programs than to deal with the problem. Most of the agony comes from making 45the "obj" directory stuff work right, not because we switched to a new version 46of make. So, don't get mad at us, figure out a better way to handle multiple 47architectures so we can quit using the symbolic link stuff. (Imake doesn't 48count.) 49 50The file .depend in the source directory is expected to contain dependencies 51for the source files. This file is read automatically by make after reading 52the Makefile. 53 54The variable DESTDIR works as before. It's not set anywhere but will change 55the tree where the file gets installed. 56 57The profiled libraries are no longer built in a different directory than 58the regular libraries. A new suffix, ".po", is used to denote a profiled 59object, and ".pico" denotes a shared (position-independent) object. 60 61There are various make variables used during the build. 62 63Many variables support a (case sensitive) value of "no" or "yes", 64and are tested with ${VAR} == "no" and ${VAR} != "no" . 65 66 67The basic rule for the variable naming scheme is as follows: 68 69HOST_xxx A command that runs on the host machine regardless of 70 whether or not the system is being cross compiled, or 71 flags for such a command. 72 73MKxxx Can be set to "no" to disable functionality, or 74 "yes" to enable it. 75 Usually defaults to "yes", although some variables 76 default to "no". 77 Due to make(1) implementation issues, if a temporary 78 command-line override of a mk.conf(5) or <bsd.own.mk> 79 setting is required whilst still honoring a particular 80 Makefile's setting of MKxxx, use 81 env MKxxx=value make 82 instead of 83 make MKxxx=value 84 85NOxxx If defined, disables a feature. 86 Not intended for users. 87 This is to allow Makefiles to disable functionality 88 that they don't support (such as missing man pages). 89 NOxxx variables must be defined before <bsd.own.mk> 90 is included. 91 92TOOL_xxx A tool that is provided as part of the USETOOLS 93 framework. When not using the USETOOLS framework, 94 TOOL_xxx variables should refer to tools that are 95 already installed on the host system. 96 97The following variables that control how things are made/installed that 98are not set by default. These should not be set by Makefiles; they're for 99the user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5)) 100or on the make(1) command line: 101 102BUILD If defined, 'make install' checks that the targets in the 103 source directories are up-to-date and remakes them if they 104 are out of date, instead of blindly trying to install 105 out of date or non-existent targets. 106 107MAKEVERBOSE Control how "verbose" the standard make(1) rules are. 108 Default: 2 109 Supported values: 110 0 Minimal output ("quiet") 111 1 Describe what is occurring 112 2 Describe what is occurring and echo the actual command 113 3 Ignore the effect of the "@" prefix in make commands 114 4 Trace shell commands using the shell's -x flag 115 116MKATF If "no", don't build the Automated Testing Framework (ATF), 117 which includes the libatf-c, libatf-c++ and libatf-sh libraries 118 and the various command line tools. Also, because the build of 119 the libraries is disabled, don't build the NetBSD test suite 120 either. 121 Default: yes 122 123MKBFD Obsolete, use MKBINUTILS 124 125MKBINUTILS If "no", don't build binutils (gas, ld, etc and libbfd, 126 libopcodes) 127 Default: yes 128 129MKBSDTAR If "yes", use the libarchive based cpio and tar instead of 130 the pax frontends. 131 Default: no 132 133MKCATPAGES If "no", don't build or install the catman pages. 134 Default: no 135 136MKCOMPAT If "no", don't build or install the src/compat. 137 Default: yes on amd64/mips64/sparc64, no elsewhere. 138 139MKCOMPATTESTS If "yes", build and install the NetBSD test suite when 140 building and installing src/compat. 141 Default: no 142 143MKCOMPATX11 If "yes", build and install the X11 libraries when 144 building and installing src/compat. 145 Default: no 146 147MKCOMPLEX If "no", don't build libm support for <complex.h> 148 Default: yes 149 150MKCTF If "no", do not build and install CTF tools, and also 151 don't generate and manipulate CTF data of ELF binaries 152 during build. 153 Default: no 154 155NOCTF Don't generate and manipulate CTF data of ELF binaries 156 during build. It is set internally for standalone programs. 157 158MKCVS If "no", don't build or install cvs(1). 159 Default: yes 160 161MKDEBUG If "no", don't build and install separate debugging symbols 162 into /usr/libdata/debug. 163 Default: no 164 165NODEBUG Don't compile with debugging symbols during build. 166 It is set internally for standalone programs. 167 168MKDEBUGLIB Build *_g.a debugging libraries, which are compiled 169 with -DDEBUG. 170 Default: no 171 172MKDEPINCLUDES If "yes" issue .include statements in the .depend file 173 instead of inlining the contents of the .d files. Useful 174 when stale dependencies are present, to list the exact 175 files that need refreshing. It is off by default because 176 it is possibly slower. 177 Default "no" 178 179MKDOC If "no", don't build or install the documentation. 180 Default: yes 181 182MKDTRACE If "no", do not build and install the kernel modules, 183 utilities and libraries used to implement the dtrace(1) 184 facility. 185 Default: no 186 187MKDYNAMICROOT If "no", build programs in /bin and /sbin statically, 188 don't install certain libraries in /lib, and don't 189 install the shared linker into /libexec. 190 Default: yes 191 192MKEXTSRC If not "no", 'make build' also descends into either src/extsrc 193 to cross-build programs and libraries externally added by 194 users, and automatically enables creation of those sets. 195 Default: no 196 197MKGCC If "no", don't build gcc(1) or any of the GCC-related 198 libraries (libgcc, libobjc, libstdc++). 199 Default: yes 200 201MKGCCCMDS If "no", don't build gcc(1), but do build the GCC-related 202 libraries (libgcc, libobjc, libstdc++). 203 Default: yes 204 205MKGDB If "no", don't build gdb(1). 206 Default: yes 207 208MKGROFFHTMLDOC If "no", avoid trying to use groff to generate html for 209 miscellaneous articles, as this seems to sometimes want 210 to run software not in base. Does not affect html man 211 pages. 212 Default: no 213 214MKHESIOD If "no", disables building of Hesiod infrastructure 215 (libraries and support programs). 216 Default: yes 217 218MKHOSTOBJ If not "no", for programs intended to be run on the compile 219 host, the name, release, and architecture of the host 220 operating system will be suffixed to the name of the object 221 directory created by "make obj". 222 Default: no 223 224MKHTML If "no", don't build or install the HTML man pages. 225 Default: yes 226 227MKIEEEFP If "no", don't add code for IEEE754/IEC60559 conformance. 228 Has no effect on most platforms. 229 Default: yes 230 231MKSTRIPIDENT Strip the RCS IDs from program binaries and shared libraries. 232 Default: no 233 234MKINET6 If "no", disables building of INET6 (IPv6) infrastructure 235 (libraries and support programs). This option must not be 236 set to "no" if MKX11 is not "no". 237 Default: yes 238 239MKINFO If "no", don't build or install Info documentation from 240 Texinfo source files. 241 Default: yes 242 243MKIPFILTER If "no", don't build or install the IP Filter programs and LKM. 244 Default: yes 245 246MKISCSI If "no", don't build or install iSCSI library or applications 247 (depends on libpthread.) 248 Default: yes 249 250MKKDEBUG If "yes", force building of kernel symbol info and creation 251 of netbsd.gdb in all kernel builds, independently of the 252 settings for "makeoptions DEBUG" in the kernel config file. 253 254MKKERBEROS If "no", disables building of Kerberos v5 255 infrastructure (libraries and support programs). 256 Default: yes 257 258MKKMOD If "no", disables building of kernel modules. 259 Default: yes 260 261MKKYUA If "no", don't build Kyua nor its dependent library Lutok. 262 Note that setting this to "no" does not disable the build of 263 the NetBSD test suite itself; the build of the tests is 264 controlled by the MKATF knob. 265 Default: no (until the import is done and validated) 266 267MKLDAP If "no", disables building of LDAP infrastructure 268 (libraries and support programs). 269 Default: yes 270 271MKLIBCXX If not "no", build and install libc++. 272 Default: no 273 274MKLIBSTDCXX If not "no", build and install libstdc++. 275 Default: yes 276 277MKLINKLIB If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no". 278 Also: 279 - don't install the .a libraries 280 - don't install _pic.a libraries on PIC systems 281 - don't build .a libraries on PIC systems 282 - don't install the .so symlink on ELF systems 283 I.e, only install the shared library (and the .so.major 284 symlink on ELF). 285 Default: yes 286 287MKLINT If "no", don't build or install the lint libraries. 288 Default: yes 289 290MKLVM If "no", don't build or install the logical volume manager 291 and device mapper tools and libraries 292 Default: yes 293 294MKMAN If "no", don't build or install the man or catman pages, 295 and also acts as "MKCATPAGES=no MKHTML=no". 296 Default: yes 297 298MKMANDOC If "yes", mandoc is built as tool and used to compile 299 catman or html pages. A directory can be exempted by 300 defining NOMANDOC. Individual man pages are exempted 301 if NOMANDOC.${target} is set to "yes". 302 Default: yes 303 304MKMANZ If not "no", compress manual pages at installation time. 305 Default: no 306 307MKMDNS If "no", disables building of mDNS infrastructure 308 (libraries and support programs). 309 Default: yes 310 311MKNLS If "no", don't build or install the NLS files and locale 312 definition files. 313 Default: yes 314 315MKNPF If "no", don't build or install the NPF and its modules. 316 Default: yes 317 318MKNSD If "no", don't build or install the "nsd" DNS authoritative 319 server. 320 Default: no 321 322MKOBJ If "no", don't enable the rule which creates objdirs, 323 and also acts as "MKOBJDIRS=no". 324 Default: yes 325 326MKOBJDIRS If "no", don't create objdirs during a "make build". 327 Default: no 328 329MKPAM If "no", disables building of PAM authentication 330 infrastructure (libraries and support programs). 331 Default: yes 332 333MKPCC If "no", don't build pcc(1) or any of the PCC-related 334 libraries (libpcc, libpccsoftfloat). 335 Default: no 336 337MKPF If "no", don't build or install the pf programs and LKM. 338 Default: yes 339 340MKPIC If "no", don't build or install shared libraries, and 341 also acts as "MKPICLIB=no" 342 Default: yes (for MACHINE_ARCHs that support it) 343 344MKPICINSTALL If "no", don't install the *_pic.a libraries. 345 Default: yes 346 347MKPICLIB If "no", don't build *_pic.a libraries, and build the 348 shared object libraries from the .a libraries. 349 A symlink is installed in ${DESTDIR}/usr/lib for the 350 _pic.a library pointing to the .a library. 351 Default: yes 352 353MKPIE If "no", create regular executables. Otherwise create 354 PIE (Position Independent Executables). 355 Default: no 356 357NOPIE Don't create PIE (Position Independent Executables) 358 It is set internally for standalone programs. 359 360MKPIGZGZIP If "no", only install pigz as pigz, not gzip. 361 Default: no 362 363MKPOSTFIX If "no", don't build or install postfix(1). 364 Default: yes 365 366MKPROFILE If "no", don't build or install the profiling (*_p.a) libraries. 367 Default: yes 368 369MKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory, 370 which is necessary for the radeon DRM driver. 371 Default: yes on i386 and amd64, no elsewhere. 372 373MKRELRO If "partial", set the non-PLT GOT to read-only. If "full" 374 also force immediate symbol binding. 375 Default: no 376 377MKREPRO If "yes", create reproducible builds. This enables 378 different switches to make two builds from the same source tree 379 result in the same build results. 380 Default: no 381 382MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no 383 MKMAN=no MKNLS=no". 384 I.e, don't build catman pages, documentation, Info 385 documentation, man pages, NLS files, ... 386 Default: yes 387 388MKSKEY If "no", disables building of S/key authentication 389 infrastructure (libraries and support programs). 390 Default: yes 391 392MKSLJIT If "no", disables building of sljit (stack-less platform 393 independent JIT compiler) private library and tests. 394 Default: yes on amd64, i386 and sparc, no elsewhere. 395 396MKSOFTFLOAT If not "no", build with options to enable the compiler to 397 generate output containing library calls for floating 398 point and possibly soft-float library support. 399 Default: no 400 401MKSTATICLIB If "no", don't build or install the normal static (*.a) 402 libraries. 403 Default: yes 404 405MKSTATICPIE Compile in support for static pie binaries. These binaries 406 use a special rcrt0.o/mcrt0.o that do the necessary relocations 407 Default: yes on platforms that support it. 408 409MKSTRIPSYM If "yes", strip all local symbols from shared libraries; 410 the affect is equivalent to -x option of ld(1). If "no", 411 strip only temporary local symbols; the affect is equivalent 412 to -X option of ld(1). Keeping non-temporary local symbols 413 such as static function names is useful on using DTrace for 414 userland libraries and getting a backtrace from a rump kernel 415 loading shared libraries. 416 Default: yes 417 418MKTEGRAFIRMWARE If "no", install the /libdata/firmware/nvidia directory, 419 which is necessary for the NVIDIA Tegra XHCI driver. 420 Default: yes on evbarm, no elsewhere. 421 422MKTOOLSDEBUG If "yes" build the tools with debugging symbols. 423 Default: no 424 425MKTPM If "no" then don't build the Trusted Platform Module 426 infrastructure. 427 Default: no 428 429MKUNBOUND If not "no", build and install the "unbound" DNS resolver. 430 Default: yes 431 432MKUNPRIVED If not "no", don't set the owner/group/mode when installing 433 files or directories, and keep a metadata log of what 434 the owner/group/mode should be. This allows a 435 non-root "make install". 436 Default: no 437 438MKUPDATE If not "no", 'make install' only installs targets that are 439 more recently modified in the source directories that their 440 installed counterparts. 441 Default: no 442 443MKX11 If not "no", 'make build' also descends into 444 src/external/mit/xorg to cross-build X11 and automatically 445 enables creation of X sets. 446 Default: no 447 448MKX11FONTS If not "no", do not build or install the X fonts. The xfont 449 set is still created but will be empty. 450 Default: yes 451 452MKX11MOTIF: If "yes", build the native X11 libGLw with Motif stubs. If 453 Motif is not installed in the default location /usr/pkg, the 454 location can be specified using the X11MOTIFPATH variable. 455 Default: no 456 457MKYP If "no", disables building of YP (NIS) 458 infrastructure (libraries and support programs). 459 Default: yes 460 461MKZFS If "no", do not build and install utilities and libraries 462 used to manage ZFS file system. Do not build zfs and solaris 463 compatibility kernel modules. Note: ZFS requires 64bit 464 atomic operations. 465 Default: yes on amd64, no elsewhere. 466 467MKRUMP If "no", do not build and install rump related headers, 468 libraries, and programs. 469 Default: yes 470 471USE_HESIOD If "no", disables building Hesiod support into 472 various system utilities/libraries that support it. 473 If ${MKHESIOD} is "no", USE_HESIOD will also be 474 forced to "no". 475 476USE_INET6 If "no", disables building INET6 (IPv6) support into 477 various system utilities/libraries that support it. 478 If ${MKINET6} is "no", USE_INET6 will also be 479 forced to "no". 480 481USE_JEMALLOC If "no", disables building the "jemalloc" allocator 482 designed for improved performance with threaded 483 applications. The "phkmalloc" allocator as used up 484 before NetBSD-5.0 will be substituted. 485 486USE_KERBEROS If "no", disables building Kerberos v5 487 support into various system utilities/libraries that 488 support it. If ${MKKERBEROS} is "no", USE_KERBEROS 489 will also be forced to "no". 490 491USE_LDAP If "no", disables building LDAP support into various 492 system utilities/libraries that support it. 493 If ${MKLDAP} is "no", USE_LDAP will also be forced to "no". 494 495USE_PAM If "no", disables building PAM authentication support 496 into various system utilities/libraries that support it. 497 If ${MKPAM} is "no", USE_PAM will also be forced to "no". 498 499USE_SKEY If "no", disables building S/key authentication 500 support into various system utilities/libraries that 501 support it. If ${MKSKEY} is "no", USE_SKEY will 502 also be forced to "no". 503 Default: no 504 505USE_SSP If "no", disables GCC stack protection code, which 506 detects stack overflows and aborts the program. The 507 stack protection code imposes a performance penalty 508 of about 5%. 509 Default: "no", unless "USE_FORT" is set to "yes" 510 511NOSSP Don't compile with stack protector during build. 512 It is set internally for standalone programs. 513 514USE_FORT If "yes" turns on substitute wrappers for commonly used 515 functions that do not do bounds checking regularly, but 516 they could in some cases by using the gcc 517 __builtin_object_size() function to determine the buffer 518 size where it is known and detect buffer overflows. 519 These substitute functions are in /usr/include/ssp. 520 Default: depends on the part of the source tree 521 522NOFORT Don't compile with substitute wrappers during build. 523 It is set internally for standalone programs. 524 525USE_YP If "no", disables building YP (NIS) support into 526 various system utilities/libraries that support it. 527 If ${MKYP} is "no", USE_YP will also be forced to "no". 528 529USE_PIGZGZIP If "no", use the host "gzip" program to compress things. 530 Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ}, 531 and use nbpigz to compress things. 532 Default: "no". 533 534COPTS.lib<lib> 535OBJCOPTS.lib<lib> 536LDADD.lib<lib> 537CPPFLAGS.lib<lib> 538CXXFLAGS.lib<lib> 539COPTS.<prog> 540OBJCCOPTS.<prog> 541LDADD.<prog> 542CPPFLAGS.<prog> 543CXXFLAGS.<prog> These provide a way to specify additions to the associated 544 variables in a way that applies only to a particular library 545 or program. <lib> corresponds to the LIB variable set in 546 the library's makefile. <prog> corresponds to either PROG 547 or PROG_CXX (if set). For example, if COPTS.libcrypto is 548 set to "-g", "-g" will be added to COPTS only when compiling 549 the crypto library. 550 551The active compiler is selected using the following variables: 552AVAILABLE_COMPILER 553 List of available compiler suites. Processed in order 554 for selecting the active compiler for each frontend. 555HAVE_PCC If defined, PCC is present and enabled. 556HAVE_LLVM If defined, LLVM/Clang is present and enabled. 557UNSUPPORTED_COMPILER.xxx 558 If defined, the support for compiler "xxx" is disabled. 559 560For the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist: 561ACTIVE_CC Active compile suite for the CC frontend. 562SUPPORTED_CC Compile suite with support for the CC frontend. 563TOOL_CC.xxx Path to the CC frontend for compiler "xxx" 564 565=-=-=-=-= sys.mk =-=-=-=-= 566 567The include file <sys.mk> has the default rules for all makes, in the BSD 568environment or otherwise. You probably don't want to touch this file. 569 570=-=-=-=-= bsd.own.mk =-=-=-=-= 571 572The include file <bsd.own.mk> contains source tree configuration parameters, 573such as the owners, groups, etc. for both manual pages and binaries, and 574a few global "feature configuration" parameters. 575 576It has no targets. 577 578To get system-specific configuration parameters, <bsd.own.mk> will try to 579include the file specified by the "MAKECONF" variable. If MAKECONF is not 580set, or no such file exists, the system make configuration file, /etc/mk.conf 581is included. These files may define any of the variables described below. 582 583<bsd.own.mk> sets the following variables, if they are not already defined 584(defaults are in brackets): 585 586NETBSDSRCDIR Top of the NetBSD source tree. 587 If _SRC_TOP_ != "", that will be used as the default, 588 otherwise BSDSRCDIR will be used as the default. 589 Various makefiles within the NetBSD source tree will 590 use this to reference the top level of the source tree. 591 592_SRC_TOP_ Top of the system source tree, as determined by <bsd.own.mk> 593 based on the presence of tools/ and build.sh. This variable 594 is "internal" to <bsd.own.mk>, although its value is only 595 determined once and then propagated to all sub-makes. 596 597_NETBSD_VERSION_DEPENDS 598 A list of files which contain information about 599 the version of the NetBSD being built. This is 600 defined only if the current directory appears 601 to be inside a NetBSD source tree. The list of 602 files includes ${NETBSDSRCDIR}/sys/sys/param.h 603 (which contains the kernel version number), 604 ${NETBSDSRCDIR}/sys/conf/newvers.sh and 605 ${NETBSDSRCDIR}/sys/conf/osrelease.sh (which 606 interpret the information in sys/sys/param.h), and 607 ${_SRC_TOP_OBJ_}/params (which is an optional file, 608 created by "make build" in ${_SRC_TOP_}/Makefile, 609 containing all the variables that may influence the 610 build). 611 612 Targets that depend on the NetBSD version, or on 613 variables defined at build time, can declare a 614 dependency on ${_NETBSD_VERSION_DEPENDS}, like this: 615 616 version.c: ${_NETBSD_VERSION_DEPENDS} 617 commands to create version.c 618 619BSDSRCDIR The real path to the system sources, so that 'make obj' 620 will work correctly. [/usr/src] 621 622BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' 623 will work correctly. [/usr/obj] 624 625BINGRP Binary group. [wheel] 626 627BINOWN Binary owner. [root] 628 629BINMODE Binary mode. [555] 630 631NONBINMODE Mode for non-executable files. [444] 632 633MANDIR Base path for manual installation. [/usr/share/man/cat] 634 635MANGRP Manual group. [wheel] 636 637MANOWN Manual owner. [root] 638 639MANMODE Manual mode. [${NONBINMODE}] 640 641MANINSTALL Manual installation type. Space separated list: 642 catinstall, htmlinstall, maninstall 643 Default value derived from MKCATPAGES and MKHTML. 644 645LDSTATIC Control program linking; if set blank, link everything 646 dynamically. If set to "-static", link everything statically. 647 If not set, programs link according to their makefile. 648 649LIBDIR Base path for library installation. [/usr/lib] 650 651LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] 652 653LIBGRP Library group. [${BINGRP}] 654 655LIBOWN Library owner. [${BINOWN}] 656 657LIBMODE Library mode. [${NONBINMODE}] 658 659DOCDIR Base path for system documentation (e.g. PSD, USD, etc.) 660 installation. [/usr/share/doc] 661 662DOCGRP Documentation group. [wheel] 663 664DOCOWN Documentation owner. [root] 665 666DOCMODE Documentation mode. [${NONBINMODE}] 667 668GZIP_N_FLAG Flags to pass to TOOL_GZIP to prevent it from inserting 669 file names or timestamps in the compressed output. 670 [-n, or -nT when TOOL_GZIP is really TOOL_PIGZ] 671 672NLSDIR Base path for Native Language Support files installation. 673 [/usr/share/nls] 674 675NLSGRP Native Language Support files group. [wheel] 676 677NLSOWN Native Language Support files owner. [root] 678 679NLSMODE Native Language Support files mode. [${NONBINMODE}] 680 681X11SRCDIR The path to the xsrc tree. [${NETBSDSRCDIR}/../xsrc, 682 if that exists; otherwise /usr/xsrc] 683 684X11SRCDIR.local The path to the local X11 src tree. [${X11SRCDIR}/local] 685 686X11SRCDIR.lib<package> 687X11SRCDIR.<package> 688 The path to the xorg src tree for the specificed package>. 689 [${X11SRCDIR}/external/mit/xorg/<package>/dist] 690 691X11ROOTDIR Root directory of the X11 installation. [/usr/X11R7] 692 693X11BINDIR X11 bin directory. [${X11ROOTDIR}/bin] 694 695X11FONTDIR X11 font directory. [${X11ROOTDIR}/lib/X11/fonts] 696 697X11INCDIR X11 include directory. [${X11ROOTDIR}/include] 698 699X11LIBDIR X11 lib/x11 (config) directory. [${X11ROOTDIR}/lib/X11] 700 701X11MANDIR X11 manual directory. [${X11ROOTDIR}/man] 702 703X11USRLIBDIR X11 library directory. [${X11ROOTDIR}/lib] 704 705STRIPFLAG The flag passed to the install program to cause the binary 706 to be stripped. This is to be used when building your 707 own install script so that the entire system can be made 708 stripped/not-stripped using a single knob. [] 709 710COPY The flag passed to the install program to cause the binary 711 to be copied rather than moved. This is to be used when 712 building our own install script so that the entire system 713 can either be installed with copies, or with moves using 714 a single knob. [-c] 715 716MAKEDIRTARGETENV 717 Environment variables passed to the child make process 718 invoked by MAKEDIRTARGET. 719 720MAKEDIRTARGET dir target [params] 721 Runs "cd $${dir} && ${MAKE} [params] $${target}", 722 displaying a "pretty" message whilst doing so. 723 724RELEASEMACHINEDIR 725 Subdirectory used below RELEASEDIR when building 726 a release. [${MACHINE}] 727 728RELEASEMACHINE Subdirectory or path component used for the following 729 paths: 730 distrib/${RELEASEMACHINE} 731 distrib/notes/${RELEASEMACHINE} 732 etc/etc.${RELEASEMACHINE} 733 Used when building a release. [${MACHINE}] 734 735Additionally, the following variables may be set by <bsd.own.mk> or in a 736make configuration file to modify the behavior of the system build 737process (default values are in brackets along with comments, if set by 738<bsd.own.mk>): 739 740USETOOLS Indicates whether the tools specified by ${TOOLDIR} should 741 be used as part of a build in progress. 742 Supported values: 743 744 yes Use the tools from TOOLDIR. 745 Must be set to this if cross-compiling. 746 747 no Do not use the tools from TOOLDIR, but refuse to 748 build native compilation tool components that are 749 version-specific for that tool. 750 751 never Do not use the tools from TOOLDIR, even when 752 building native tool components. This is similar to 753 the traditional NetBSD build method, but does not 754 verify that the compilation tools in use are 755 up-to-date enough in order to build the tree 756 successfully. This may cause build or runtime 757 problems when building the whole NetBSD source tree. 758 759 Default: "yes" if building all or part of a whole NetBSD 760 source tree (detected automatically); "no" otherwise 761 (to preserve traditional semantics of the <bsd.*.mk> 762 make(1) include files). 763 764OBJECT_FMT Object file format. [set to "ELF" on architectures that 765 use ELF -- currently all architectures]. 766 767TOOLCHAIN_MISSING 768 If not "no", this indicates that the platform being built 769 does not have a working in-tree toolchain. If the 770 ${MACHINE_ARCH} in question falls into this category, 771 TOOLCHAIN_MISSING is conditionally assigned the value "yes". 772 Otherwise, the variable is unconditionally assigned the 773 value "no". 774 If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are 775 unconditionally assigned the value "no". 776 777EXTERNAL_TOOLCHAIN 778 This variable is not directly set by <bsd.own.mk>, but 779 including <bsd.own.mk> is the canonical way to gain 780 access to this variable. The variable should be defined 781 either in the user's environment or in the user's mk.conf 782 file. If defined, this variable indicates the root of 783 an external toolchain which will be used to build the 784 tree. For example, if a platform is a ${TOOLCHAIN_MISSING} 785 platform, EXTERNAL_TOOLCHAIN can be used to re-enable the 786 cross-compile framework. 787 788 If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally 789 assigned the value "no", since the external version of the 790 compiler may not be able to build the library components of 791 the in-tree compiler. 792 793 This variable should be used in conjunction with an appropiate 794 HAVE_GCC or HAVE_LLVM setting to control the compiler flags. 795 796 NOTE: This variable is not yet used in as many places as 797 it should be. Expect the exact semantics of this variable 798 to change in the short term as parts of the cross-compile 799 framework continue to be cleaned up. 800 801The following variables are defined to commands to perform the 802appropriate operation, with the default in [brackets]. Note that 803the defaults change if USETOOLS == "yes": 804 805TOOL_AMIGAAOUT2BB aout to Amiga bootblock converter. [amiga-aout2bb] 806 807TOOL_AMIGAELF2BB ELF to Amiga bootblock converter. [amiga-elf2bb] 808 809TOOL_AMIGATXLT Amige assembly language format translator. [amiga-txlt] 810 811TOOL_ASN1_COMPILE ASN1 compiler. [asn1_compile] 812 813TOOL_AWK Pattern-directed scanning/processing language. [awk] 814 815TOOL_CAP_MKDB Create capability database. [cap_mkdb] 816 817TOOL_CAT Concatenate and print files. [cat] 818 819TOOL_CKSUM Display file checksums. [cksum] 820 821TOOL_COMPILE_ET Error table compiler. [compile_et] 822 823TOOL_CONFIG Build kernel compilation directories. [config] 824 825TOOL_CRUNCHGEN Generate crunched binary build environment. [crunchgen] 826 827TOOL_CTAGS Create a tags file. [ctags] 828 829TOOL_DB Manipulate db(3) databases. [db] 830 831TOOL_DISKLABEL Read and write disk pack label. [disklabel] 832 833TOOL_EQN Format equations for groff. [eqn] 834 835TOOL_FDISK MS-DOS partition maintenance program. [fdisk] 836 837TOOL_FGEN IEEE 1275 Open Firmware FCode Tokenizer. [fgen] 838 839TOOL_GENASSYM Generate constants for assembly files. [genassym] 840 841TOOL_GENCAT Generate NLS message catalogs. [gencat] 842 843TOOL_GMAKE GNU make utility. [gmake] 844 845TOOL_GREP Print lines matching a pattern. [grep] 846 847TOOL_GROFF Front end for groff document formatting system. [groff] 848 849TOOL_GZIP Compression/decompression tool. [gzip] 850 851TOOL_GZIP_N Same as TOOL_GZIP, plus a command line option to 852 prevent it from inserting file names or timestamps 853 into the compressed output. 854 [${TOOL_GZIP} ${GZIP_N_FLAG}] 855 856TOOL_HEXDUMP Ascii, decimal, hexadecimal, octal dump. [hexdump] 857 858TOOL_HP300MKBOOT Make bootable image for hp300. [hp300-mkboot] 859 860TOOL_HPPAMKBOOT Make bootable image for hppa. [hppa-mkboot] 861 862TOOL_INDXBIB Make bibliographic database's inverted index. [indxbib] 863 864TOOL_INSTALLBOOT Install disk bootstrap software. [installboot] 865 866TOOL_INSTALL_INFO Update info/dir entries. [install-info] 867 868TOOL_JOIN Relational database operator. [join] 869 870TOOL_M4 M4 macro language processor. [m4] 871 872TOOL_MACPPCFIXCOFF Fix up xcoff headers for macppc. [macppc-fixcoff] 873 874TOOL_MAKEFS Create file system image from directory tree. [makefs] 875 876TOOL_MAKEINFO Translate Texinfo documents. [makeinfo] 877 878TOOL_MAKEWHATIS Create a whatis.db database. [makewhatis] 879 880TOOL_MDSETIMAGE Set kernel RAM disk image. [mdsetimage] 881 882TOOL_MENUC Menu compiler. [menuc] 883 884TOOL_MIPSELF2ECOFF Convert ELF-format executable to ECOFF for mips. 885 [mips-elf2ecoff] 886 887TOOL_MKCSMAPPER Make charset mapping table. [mkcsmapper] 888 889TOOL_MKESDB Make encoding scheme database. [mkesdb] 890 891TOOL_MKLOCALE Make LC_CTYPE locale files. [mklocale] 892 893TOOL_MKMAGIC Create database for file(1). [file] 894 895TOOL_MKNOD Make device special file. [mknod] 896 897TOOL_MKTEMP Make (unique) temporary file name. [mktemp] 898 899TOOL_MSGC Simple message list compiler. [msgc] 900 901TOOL_MTREE Map a directory hierarchy. [mtree] 902 903TOOL_NCDCS Turn ELF kernel into a NCD firmware image. [ncdcs] 904 905TOOL_PAX Manipulate file archives and copy directories. [pax] 906 907TOOL_PIC Compile pictures for groff. [pic] 908 909TOOL_PIGZ Parallel compressor. [pigz] 910 911TOOL_POWERPCMKBOOTIMAGE Make bootable image for powerpc. [powerpc-mkbootimage] 912 913TOOL_PWD_MKDB Generate the password databases. [pwd_mkdb] 914 915TOOL_REFER Preprocess bibliographic references for groff. [refer] 916 917TOOL_ROFF_ASCII Generate ASCII groff output. [nroff] 918 919TOOL_ROFF_DVI Generate DVI groff output. [${TOOL_GROFF} -Tdvi] 920 921TOOL_ROFF_HTML Generate HTML groff output. 922 [${TOOL_GROFF} -Tlatin1 -mdoc2html] 923 924TOOL_ROFF_PS Generate PS groff output. [${TOOL_GROFF} -Tps] 925 926TOOL_ROFF_RAW Generate "raw" groff output. [${TOOL_GROFF} -Z] 927 928TOOL_RPCGEN Remote Procedure Call (RPC) protocol compiler. [rpcgen] 929 930TOOL_SED Stream editor. [sed] 931 932TOOL_SOELIM Eliminate .so's from groff input. [soelim] 933 934TOOL_SPARKCRC Generate a crc suitable for use in a sparkive file. 935 [sparkcrc] 936 937TOOL_STAT Display file status. [stat] 938 939TOOL_STRFILE Create a random access file for storing strings. 940 [strfile] 941 942TOOL_SUNLABEL Read or modify a SunOS disk label. [sunlabel] 943 944TOOL_TBL Format tables for groff. [tbl] 945 946TOOL_UUDECODE Uudecode a binary file. [uudecode] 947 948TOOL_VGRIND Grind nice listings of programs. [vgrind -f] 949 950TOOL_ZIC Time zone compiler. [zic] 951 952For each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a 953list of what ports can be built for it. This keeps those definitions in 954centralized place. 955 956<bsd.own.mk> is generally useful when building your own Makefiles so that 957they use the same default owners etc. as the rest of the tree. 958 959 960=-=-=-=-= bsd.clean.mk =-=-=-=-= 961 962The include file <bsd.clean.mk> defines the clean and cleandir 963targets. It uses the following variables: 964 965CLEANFILES Files to remove for both the clean and cleandir targets. 966 967CLEANDIRFILES Files to remove for the cleandir target, but not for 968 the clean target. 969 970MKCLEANSRC Controls whether or not the clean and cleandir targets 971 will delete files from both the object directory, 972 ${.OBJDIR}, and the source directory, ${.CURDIR}. 973 974 If MKCLEANSRC is set to "no", then the file names in 975 CLEANFILES or CLEANDIRFILES are interpreted relative 976 to the object directory, ${.OBJDIR}. This is the 977 traditional behaviour. 978 979 If MKCLEANSRC is set to "yes", then the file deletion 980 is performed relative to both the object directory, 981 ${.OBJDIR}, and the source directory, ${.CURDIR}. (This 982 has no effect if ${.OBJDIR} is the same as ${.CURDIR}.) 983 Deleting files from ${.CURDIR} is intended to remove 984 stray output files that had been left in the source 985 directory by an earlier build that did not use object 986 directories. 987 988 The default is MKCLEANSRC=yes. If you always build with 989 separate object directories, and you are sure that there 990 are no stray files in the source directories, then you 991 may set MKCLEANSRC=no to save some time. 992 993MKCLEANVERIFY Controls whether or not the clean and cleandir targets 994 will verify that files have been deleted. 995 996 If MKCLEANVERIFY is set to "no", then the files will 997 be deleted using a "rm -f" command, and its success or 998 failure will be ignored. 999 1000 If MKCLEANVERIFY is set to "yes", then the success of 1001 the "rm -f" command will be verified using an "ls" 1002 command. 1003 1004 The default is MKCLEANVERIFY=yes. If you are sure that 1005 there will be no problems caused by file permissions, 1006 read-only file systems, or the like, then you may set 1007 MKCLEANVERIFY=no to save some time. 1008 1009To use the clean and cleandir targets defined in <bsd.clean.mk>, other 1010Makefiles or bsd.*.mk files should append file names to the CLEANFILES 1011or CLEANDIRFILES variables. For example: 1012 1013 CLEANFILES+= a.out 1014 CLEANDIRFILES+= .depend 1015 1016 .include <bsd.clean.mk> 1017 1018The files listed in CLEANFILES and CLEANDIRFILES must not be 1019directories, because the potential risk from running "rm -rf" commands 1020in bsd.clean.mk is considered too great. If you want to recursively 1021delete a directory as part of "make clean" or "make cleandir" then you 1022need to provide your own target. 1023 1024=-=-=-=-= bsd.dep.mk =-=-=-=-= 1025 1026The include file <bsd.dep.mk> contains the default targets for building 1027.depend files. It creates .d files from entries in SRCS and DPSRCS 1028that are C, C++, or Objective C source files, and builds .depend from the 1029.d files. All other files in SRCS and all of DPSRCS will be used as 1030dependencies for the .d files. In order for this to function correctly, 1031it should be .included after all other .mk files and directives that may 1032modify SRCS or DPSRCS. It uses the following variables: 1033 1034SRCS List of source files to build the program. 1035 1036DPSRCS List of source files which are needed for generating 1037 dependencies, but are not needed in ${SRCS}. 1038 1039 1040=-=-=-=-= bsd.files.mk =-=-=-=-= 1041 1042The include file <bsd.files.mk> handles the FILES variables and is included 1043from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables: 1044 1045FILES The list of files to install. 1046 1047CONFIGFILES Similar semantics to FILES, except that the files 1048 are installed by the `configinstall' target, 1049 not the `install' target. 1050 The FILES* variables documented below also apply. 1051 1052FILESOWN File owner. [${BINOWN}] 1053 1054FILESGRP File group. [${BINGRP}] 1055 1056FILESMODE File mode. [${NONBINMODE}] 1057 1058FILESDIR The location to install the files. 1059 1060FILESNAME Optional name to install each file as. 1061 1062FILESOWN_<fn> File owner of the specific file <fn>. 1063 1064FILESGRP_<fn> File group of the specific file <fn>. 1065 1066FILESMODE_<fn> File mode of the specific file <fn>. 1067 1068FILESDIR_<fn> The location to install the specific file <fn>. 1069 1070FILESNAME_<fn> Optional name to install <fn> as. 1071 1072FILESBUILD If this variable is defined, then its value will be 1073 used as the default for all FILESBUILD_<fn> variables. 1074 Otherwise, the default will be "no". 1075 1076FILESBUILD_<fn> A value different from "no" will add the file to the list of 1077 targets to be built by `realall'. Users of that variable 1078 should provide a target to build the file. 1079 1080 1081BUILDSYMLINKS List of two word items: 1082 lnsrc lntgt 1083 For each lnsrc item, create a symlink named lntgt. 1084 The lntgt symlinks are removed by the cleandir target. 1085 1086UUDECODE_FILES List of files which are stored as <file>.uue in the source 1087 tree. Each one will be decoded with ${TOOL_UUDECODE}. 1088 The source files have a `.uue' suffix, the generated files do 1089 not. 1090 1091UUDECODE_FILES_RENAME_<fn> 1092 Rename the output from the decode to the provided name. 1093 1094 *NOTE: These files are simply decoded, with no install or other 1095 rule applying implicitly except being added to the clean 1096 target. 1097 1098=-=-=-=-= bsd.gcc.mk =-=-=-=-= 1099 1100The include file <bsd.gcc.mk> computes various parameters related to GCC 1101support libraries. It defines no targets. <bsd.own.mk> MUST be included 1102before <bsd.gcc.mk>. 1103 1104The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each 1105of which need to know where to find certain GCC support libraries. 1106 1107The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable, 1108which is generally set by the user. If EXTERNAL_TOOLCHAIN it set, then 1109the compiler is asked where to find the support libraries, otherwise the 1110support libraries are found in ${DESTDIR}/usr/lib. 1111 1112<bsd.gcc.mk> sets the following variables: 1113 1114_GCC_CRTBEGIN The full path name to crtbegin.o. 1115 1116_GCC_CRTBEGINS The full path name to crtbeginS.o. 1117 1118_GCC_CRTEND The full path name to crtend.o. 1119 1120_GCC_CRTENDS The full path name to crtendS.o. 1121 1122_GCC_LIBGCCDIR The directory where libgcc.a is located. 1123 1124 1125=-=-=-=-= bsd.inc.mk =-=-=-=-= 1126 1127The include file <bsd.inc.mk> defines the includes target and uses the 1128variables: 1129 1130INCS The list of include files. 1131 1132INCSDIR The location to install the include files. 1133 1134INCSNAME Target name of the include file, if only one; same as 1135 FILESNAME, but for include files. 1136 1137INCSYMLINKS Similar to SYMLINKS in <bsd.links.mk>, except that these 1138 are installed in the 'includes' target and not the 1139 (much later) 'install' target. 1140 1141INCSNAME_<file> The name file <file> should be installed as, if not <file>, 1142 same as FILESNAME_<file>, but for include files. 1143 1144 1145=-=-=-=-= bsd.info.mk =-=-=-=-= 1146 1147The include file <bsd.info.mk> is used to generate and install GNU Info 1148documentation from respective Texinfo source files. It defines three 1149implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the 1150following variables: 1151 1152TEXINFO List of Texinfo source files. Info documentation will 1153 consist of single files with the extension replaced by 1154 .info. 1155 1156INFOFLAGS Flags to pass to makeinfo. [] 1157 1158 1159=-=-=-=-= bsd.kernobj.mk =-=-=-=-= 1160 1161The include file <bsd.kernobj.mk> defines variables related to the 1162location of kernel sources and object directories. 1163 1164KERNSRCDIR Is the location of the top of the kernel src. 1165 [${_SRC_TOP_}/sys] 1166 1167KERNARCHDIR Is the location of the machine dependent kernel sources. 1168 [arch/${MACHINE}] 1169 1170KERNCONFDIR Is where the configuration files for kernels are found. 1171 [${KERNSRCDIR}/${KERNARCHDIR}/conf] 1172 1173KERNOBJDIR Is the kernel build directory. The kernel GENERIC for 1174 instance will be compiled in ${KERNOBJDIR}/GENERIC. 1175 The default value is 1176 ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile 1177 if it exists or the target 'obj' is being made. 1178 Otherwise the default is 1179 ${KERNSRCDIR}/${KERNARCHDIR}/compile. 1180 1181It is important that Makefiles (such as those under src/distrib) that 1182wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR} 1183rather than make assumptions about the location of the compiled kernel. 1184 1185 1186=-=-=-=-= bsd.kinc.mk =-=-=-=-= 1187 1188The include file <bsd.kinc.mk> defines the many targets (includes, 1189subdirectories, etc.), and is used by kernel makefiles to handle 1190include file installation. It is intended to be included alone, by 1191kernel Makefiles. It uses similar variables to <bsd.inc.mk>. 1192Please see <bsd.kinc.mk> for more details, and keep the documentation 1193in that file up to date. 1194 1195=-=-=-=-= bsd.syscall.mk =-=-=-=-= 1196 1197The include file <bsd.syscall.mk> contains the logic to create syscall 1198files for various emulations. It includes <bsd.kinc.mk> to handle the 1199rest of the targets. 1200 1201=-=-=-=-= bsd.lib.mk =-=-=-=-= 1202 1203The include file <bsd.lib.mk> has support for building libraries. It has 1204the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 1205includes, install, lint, and tags. Additionally, it has a checkver target 1206which checks for installed shared object libraries whose version is greater 1207that the version of the source. It has a limited number of suffixes, 1208consistent with the current needs of the BSD tree. <bsd.lib.mk> includes 1209<bsd.shlib.mk> to get shared library parameters. 1210 1211It sets/uses the following variables: 1212 1213LIB The name of the library to build. 1214 1215LIBDIR Target directory for libraries. 1216 1217MKARZERO Normally, ar(1) sets the timestamps, uid, gid and 1218 permissions in files inside its archives to those of 1219 the file it was fed. This leads to non-reproducible 1220 builds. If MKARZERO is set to "yes" (default is the 1221 same as MKREPRO, or "no" if MKREPRO is not defined), 1222 then the "D" flag is passed to ar, causing the 1223 timestamp, uid and gid to be zeroed and the file 1224 permissions to be set to 644. This allows .a files 1225 from different builds to be bit identical. 1226 1227SHLIBINSTALLDIR Target directory for shared libraries if ${USE_SHLIBDIR} 1228 is not "no". 1229 1230SHLIB_MAJOR 1231SHLIB_MINOR 1232SHLIB_TEENY Major, minor, and teeny version numbers of shared library 1233 1234USE_SHLIBDIR If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR} 1235 as the path to install shared libraries to. 1236 USE_SHLIBDIR must be defined before <bsd.own.mk> is included. 1237 Default: no 1238 1239LIBISMODULE If not "no", install as ${LIB}.so (without the "lib" prefix), 1240 and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no 1241 MKPROFILE=no MKSTATICLIB=no". 1242 Default: no 1243 1244LIBISPRIVATE If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no 1245 MKPROFILE=no", and don't install the (.a) library. 1246 This is useful for "build only" helper libraries. 1247 Default: no 1248 1249LIBISCXX If not "no", Use ${CXX} instead of ${CC} to link 1250 shared libraries. 1251 This is useful for C++ libraries. 1252 Default: no 1253 1254LINTLIBDIR Target directory for lint libraries. 1255 1256LIBGRP Library group. 1257 1258LIBOWN Library owner. 1259 1260LIBMODE Library mode. 1261 1262LDADD Additional loader objects. 1263 1264MAN The manual pages to be installed (use a .1 - .9 suffix). 1265 1266NOCHECKVER_<library> 1267NOCHECKVER If set, disables checking for installed shared object 1268 libraries with versions greater than the source. A 1269 particular library name, without the "lib" prefix, may 1270 be appended to the variable name to disable the check for 1271 only that library. 1272 1273SRCS List of source files to build the library. Suffix types 1274 .s, .c, and .f are supported. Note, .s files are preferred 1275 to .c files of the same name. (This is not the default for 1276 versions of make.) 1277 1278LIBDPLIBS A list of the tuples: 1279 libname path-to-srcdir-of-libname 1280 1281 For each tuple; 1282 * LIBDO.libname contains the .OBJDIR of the library 1283 `libname', and if it is not set it is determined 1284 from the srcdir and added to MAKEOVERRIDES (the 1285 latter is to allow for build time optimization). 1286 * LDADD gets -L${LIBDO.libname} -llibname added. 1287 * DPADD gets ${LIBDO.libname}/liblibname.so or 1288 ${LIBDO.libname}/liblibname.a added. 1289 1290 The special value "_external" for LIBDO.lib makes the 1291 build system to assume the library comes from outside 1292 of the NetBSD source tree and only causes -llibname 1293 to be added to LDADD. 1294 1295 This variable may be used for individual libraries, as 1296 well as in parent directories to cache common libraries 1297 as a build-time optimization. 1298 1299The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 1300if it exists, as well as the include file <bsd.man.mk>. 1301 1302It has rules for building profiled objects; profiled libraries are 1303built by default. 1304 1305Libraries are ranlib'd when made. 1306 1307 1308=-=-=-=-= bsd.links.mk =-=-=-=-= 1309 1310The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 1311and is included from from <bsd.lib.mk> and <bsd.prog.mk>. 1312 1313LINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log 1314is used. The defaults may be modified by other bsd.*.mk files which 1315include bsd.links.mk. In the future, these variables may be replaced 1316by a method for explicitly recording hard links in a metadata log. 1317 1318LINKS The list of hard links, consisting of pairs of paths: 1319 source-file target-file 1320 ${DESTDIR} is prepended to both paths before linking. 1321 For example, to link /bin/test and /bin/[, use: 1322 LINKS=/bin/test /bin/[ 1323 1324CONFIGLINKS Similar semantics to LINKS, except that the links 1325 are installed by the `configinstall' target, 1326 not the `install' target. 1327 1328SYMLINKS The list of symbolic links, consisting of pairs of paths: 1329 source-file target-file 1330 ${DESTDIR} is only prepended to target-file before linking. 1331 For example, to symlink /usr/bin/tar to /bin/tar resulting 1332 in ${DESTDIR}/usr/bin/tar -> /bin/tar: 1333 SYMLINKS=/bin/tar /usr/bin/tar 1334 1335CONFIGSYMLINKS Similar semantics to SYMLINKS, except that the symbolic links 1336 are installed by the `configinstall' target, 1337 not the `install' target. 1338 1339LINKSOWN Link owner. [${BINOWN}] 1340 1341LINKSGRP Link group. [${BINGRP}] 1342 1343LINKSMODE Link mode. [${NONBINMODE}] 1344 1345LINKSOWN_<fn> Link owner of the specific file <fn>. 1346 1347LINKSGRP_<fn> Link group of the specific file <fn>. 1348 1349LINKSMODE_<fn> Link mode of the specific file <fn>. 1350 1351 1352=-=-=-=-= bsd.man.mk =-=-=-=-= 1353 1354The include file <bsd.man.mk> handles installing manual pages and their 1355links. 1356 1357It has a three targets: 1358 1359 catinstall: 1360 Install the preformatted manual pages and their links. 1361 htmlinstall: 1362 Install the HTML manual pages and their links. 1363 maninstall: 1364 Install the manual page sources and their links. 1365 1366It sets/uses the following variables: 1367 1368MANDIR Base path for manual installation. 1369 1370MANGRP Manual group. 1371 1372MANOWN Manual owner. 1373 1374MANMODE Manual mode. 1375 1376MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 1377 or "/tahoe" for machine specific manual pages. 1378 1379MAN The manual pages to be installed (use a .1 - .9 suffix). 1380 1381MLINKS List of manual page links (using a .1 - .9 suffix). The 1382 linked-to file must come first, the linked file second, 1383 and there may be multiple pairs. 1384 1385The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 1386it exists. 1387 1388 1389=-=-=-=-= bsd.obj.mk =-=-=-=-= 1390 1391The include file <bsd.obj.mk> defines targets related to the creation 1392and use of separated object and source directories. 1393 1394If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses 1395${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if 1396it exists. Otherwise make(1) looks for the existence of a 1397subdirectory (or a symlink to a directory) of the source directory 1398into which built targets should be placed. If an environment variable 1399named MAKEOBJDIR is set, make(1) uses its value as the name of the 1400object directory; failing that, make first looks for a subdirectory 1401named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj". 1402 1403Object directories are not created automatically by make(1) if they 1404don't exist; you need to run a separate "make obj". (This will happen 1405during a top-level build if "MKOBJDIRS" is set to a value other than 1406"no"). When the source directory is a subdirectory of ${BSDSRCDIR} -- 1407and this is determined by a simple string prefix comparison -- object 1408directories are created in a separate object directory tree, and a 1409symlink to the object directory in that tree is created in the source 1410directory; otherwise, "make obj" assumes that you're not in the main 1411source tree and that it's not safe to use a separate object tree. 1412 1413Several variables used by <bsd.obj.mk> control exactly what 1414directories and links get created during a "make obj": 1415 1416MAKEOBJDIR If set, this is the component name of the object 1417 directory. 1418 1419OBJMACHINE If this is set but MAKEOBJDIR is not set, creates 1420 object directories or links named "obj.${MACHINE}"; 1421 otherwise, just creates ones named "obj". 1422 1423USR_OBJMACHINE If set, and the current directory is a subdirectory of 1424 ${BSDSRCDIR}, create object directory in the 1425 corresponding subdirectory of ${BSDOBJDIR}.${MACHINE}; 1426 otherwise, create it in the corresponding subdirectory 1427 of ${BSDOBJDIR} 1428 1429BUILDID If set, the contents of this variable are appended 1430 to the object directory name. If OBJMACHINE is also 1431 set, ".${BUILDID}" is added after ".${MACHINE}". 1432 1433 1434=-=-=-=-= bsd.prog.mk =-=-=-=-= 1435 1436The include file <bsd.prog.mk> handles building programs from one or 1437more source files, along with their manual pages. It has a limited number 1438of suffixes, consistent with the current needs of the BSD tree. 1439<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters. 1440 1441It has eight targets: 1442 1443 all: 1444 build the program and its manual page. This also 1445 creates a GDB initialization file (.gdbinit) in 1446 the objdir. The .gdbinit file sets the shared library 1447 prefix to ${DESTDIR} to facilitate cross-debugging. 1448 clean: 1449 remove the program, any object files and the files a.out, 1450 Errs, errs, mklog, and ${PROG}.core. 1451 cleandir: 1452 remove all of the files removed by the target clean, as 1453 well as .depend, tags, and any manual pages. 1454 `distclean' is a synonym for `cleandir'. 1455 depend: 1456 make the dependencies for the source files, and store 1457 them in the file .depend. 1458 includes: 1459 install any header files. 1460 install: 1461 install the program and its manual pages; if the Makefile 1462 does not itself define the target install, the targets 1463 beforeinstall and afterinstall may also be used to cause 1464 actions immediately before and after the install target 1465 is executed. 1466 lint: 1467 run lint on the source files 1468 tags: 1469 create a tags file for the source files. 1470 1471It sets/uses the following variables: 1472 1473BINGRP Binary group. 1474 1475BINOWN Binary owner. 1476 1477BINMODE Binary mode. 1478 1479CLEANDIRFILES Additional files to remove for the cleandir target. 1480 1481CLEANFILES Additional files to remove for the clean and cleandir targets. 1482 1483CONFIGOPTS Additional flags to config(1) when building kernels. 1484 1485COPTS Additional flags to the compiler when creating C objects. 1486 1487COPTS.<fn> Additional flags to the compiler when creating the 1488 C objects for <fn>. 1489 For <fn>.[ly], "<fn>.c" must be used. 1490 1491CPUFLAGS Additional flags to the compiler/assembler to select 1492 CPU instruction set options, CPU tuning options, etc. 1493 1494CPUFLAGS.<fn> Additional flags to the compiler/assembler for <fn>. 1495 For <fn>.[ly], "<fn>.c" must be used. 1496 1497CPPFLAGS Additional flags to the C pre-processor. 1498 1499CPPFLAGS.<fn> Additional flags to the C pre-processor for <fn>. 1500 For <fn>.[ly], "<fn>.c" must be used. 1501 1502GDBINIT List of GDB initialization files to add to "source" 1503 directives in the .gdbinit file that is created in the 1504 objdir. 1505 1506LDADD Additional loader objects. Usually used for libraries. 1507 For example, to load with the compatibility and utility 1508 libraries, use: 1509 1510 LDADD+=-lutil -lcompat 1511 1512LDFLAGS Additional linker flags (passed to ${CC} during link). 1513 1514LINKS See <bsd.links.mk> 1515 1516OBJCOPTS Additional flags to the compiler when creating ObjC objects. 1517 1518OBJCOPTS.<fn> Additional flags to the compiler when creating the 1519 ObjC objects for <fn>. 1520 For <fn>.[ly], "<fn>.c" must be used. 1521 1522SYMLINKS See <bsd.links.mk> 1523 1524MAN Manual pages (should end in .1 - .9). If no MAN variable is 1525 defined, "MAN=${PROG}.1" is assumed. 1526 1527PAXCTL_FLAGS If defined, run paxctl(1) on the program binary after link 1528 time, with the value of this variable as args to paxctl(1). 1529 1530PAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS. 1531 1532PROG The name of the program to build. If not supplied, nothing 1533 is built. 1534 1535PROG_CXX If defined, the name of the program to build. Also 1536 causes <bsd.prog.mk> to link the program with the C++ 1537 compiler rather than the C compiler. PROG_CXX overrides 1538 the value of PROG if PROG is also set. 1539 1540PROGNAME The name that the above program will be installed as, if 1541 different from ${PROG}. 1542 1543SRCS List of source files to build the program. If SRCS is not 1544 defined, it's assumed to be ${PROG}.c. 1545 1546DPSRCS List of source files which are needed for generating 1547 dependencies, but are not needed in ${SRCS}. 1548 1549DPADD Additional dependencies for the program. Usually used for 1550 libraries. For example, to depend on the compatibility and 1551 utility libraries use: 1552 1553 DPADD+=${LIBCOMPAT} ${LIBUTIL} 1554 1555 The following system libraries are predefined for DPADD: 1556 1557 LIBARCHIVE?= ${DESTDIR}/usr/lib/libarchive.a 1558 LIBASN1?= ${DESTDIR}/usr/lib/libasn1.a 1559 LIBATF_C?= ${DESTDIR}/usr/lib/libatf-c.a 1560 LIBATF_CXX?= ${DESTDIR}/usr/lib/libatf-c++.a 1561 LIBBIND9?= ${DESTDIR}/usr/lib/libbind9.a 1562 LIBBLUETOOTH?= ${DESTDIR}/usr/lib/libbluetooth.a 1563 LIBBSDMALLOC?= ${DESTDIR}/usr/lib/libbsdmalloc.a 1564 LIBBZ2?= ${DESTDIR}/usr/lib/libbz2.a 1565 LIBC?= ${DESTDIR}/usr/lib/libc.a 1566 LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 1567 LIBCOM_ERR?= ${DESTDIR}/usr/lib/libcom_err.a 1568 LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 1569 LIBCRTI?= ${DESTDIR}/usr/lib/crti.o 1570 LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 1571 LIBCRYPTO?= ${DESTDIR}/usr/lib/libcrypto.a 1572 LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 1573 LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 1574 LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 1575 LIBDES?= ${DESTDIR}/usr/lib/libdes.a 1576 LIBDNS?= ${DESTDIR}/usr/lib/libdns.a 1577 LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 1578 LIBEVENT?= ${DESTDIR}/usr/lib/libevent.a 1579 LIBEVENT_OPENSSL?= ${DESTDIR}/usr/lib/libevent_openssl.a 1580 LIBEVENT_PTHREADS?= ${DESTDIR}/usr/lib/libevent_pthreads.a 1581 LIBEXECINFO?= ${DESTDIR}/usr/lib/libexecinfo.a 1582 LIBEXPAT?= ${DESTDIR}/usr/lib/libexpat.a 1583 LIBFETCH?= ${DESTDIR}/usr/lib/libfetch.a 1584 LIBFORM?= ${DESTDIR}/usr/lib/libform.a 1585 LIBFL?= ${DESTDIR}/usr/lib/libfl.a 1586 LIBG2C?= ${DESTDIR}/usr/lib/libg2c.a 1587 LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 1588 LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 1589 LIBGSSAPI?= ${DESTDIR}/usr/lib/libgssapi.a 1590 LIBHDB?= ${DESTDIR}/usr/lib/libhdb.a 1591 LIBHEIMBASE?= ${DESTDIR}/usr/lib/libheimbase.a 1592 LIBHEIMNTLM?= ${DESTDIR}/usr/lib/libheimntlm.a 1593 LIBHX500?= ${DESTDIR}/usr/lib/libhx500.a 1594 LIBINTL?= ${DESTDIR}/usr/lib/libintl.a 1595 LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a 1596 LIBISC?= ${DESTDIR}/usr/lib/libisc.a 1597 LIBISCCC?= ${DESTDIR}/usr/lib/libisccc.a 1598 LIBISCFG?= ${DESTDIR}/usr/lib/libiscfg.a 1599 LIBKADM5CLNT?= ${DESTDIR}/usr/lib/libkadm5clnt.a 1600 LIBKADM5SRV?= ${DESTDIR}/usr/lib/libkadm5srv.a 1601 LIBKAFS?= ${DESTDIR}/usr/lib/libkafs.a 1602 LIBKRB5?= ${DESTDIR}/usr/lib/libkrb5.a 1603 LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 1604 LIBL?= ${DESTDIR}/usr/lib/libl.a 1605 LIBLBER?= ${DESTDIR}/usr/lib/liblber.a 1606 LIBLDAP?= ${DESTDIR}/usr/lib/libldap.a 1607 LIBLDAP_R?= ${DESTDIR}/usr/lib/libldap_r.a 1608 LIBLUA?= ${DESTDIR}/usr/lib/liblua.a 1609 LIBLUTOK?= ${DESTDIR}/usr/lib/liblutok.a 1610 LIBLWRES?= ${DESTDIR}/usr/lib/liblwres.a 1611 LIBM?= ${DESTDIR}/usr/lib/libm.a 1612 LIBMAGIC?= ${DESTDIR}/usr/lib/libmagic.a 1613 LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a 1614 LIBOBJC?= ${DESTDIR}/usr/lib/libobjc.a 1615 LIBOSSAUDIO?= ${DESTDIR}/usr/lib/libossaudio.a 1616 LIBPAM?= ${DESTDIR}/usr/lib/libpam.a 1617 LIBPANEL?= ${DESTDIR}/usr/lib/libpanel.a 1618 LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 1619 LIBPCI?= ${DESTDIR}/usr/lib/libpci.a 1620 LIBPMC?= ${DESTDIR}/usr/lib/libpmc.a 1621 LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a 1622 LIBPTHREAD?= ${DESTDIR}/usr/lib/libpthread.a 1623 LIBPUFFS?= ${DESTDIR}/usr/lib/libpuffs.a 1624 LIBQUOTA?= ${DESTDIR}/usr/lib/libquota.a 1625 LIBRADIUS?= ${DESTDIR}/usr/lib/libradius.a 1626 LIBREFUSE?= ${DESTDIR}/usr/lib/librefuse.a 1627 LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 1628 LIBRMT?= ${DESTDIR}/usr/lib/librmt.a 1629 LIBROKEN?= ${DESTDIR}/usr/lib/libroken.a 1630 LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 1631 LIBRT?= ${DESTDIR}/usr/lib/librt.a 1632 LIBRUMP?= ${DESTDIR}/usr/lib/librump.a 1633 LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a 1634 LIBRUMPFS_EFS?= ${DESTDIR}/usr/lib/librumpfs_efs.a 1635 LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a 1636 LIBRUMPFS_FFS?= ${DESTDIR}/usr/lib/librumpfs_ffs.a 1637 LIBRUMPFS_HFS?= ${DESTDIR}/usr/lib/librumpfs_hfs.a 1638 LIBRUMPFS_LFS?= ${DESTDIR}/usr/lib/librumpfs_lfs.a 1639 LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a 1640 LIBRUMPFS_NFS?= ${DESTDIR}/usr/lib/librumpfs_nfs.a 1641 LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a 1642 LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a 1643 LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a 1644 LIBRUMPFS_UDF?= ${DESTDIR}/usr/lib/librumpfs_udf.a 1645 LIBRUMPFS_UFS?= ${DESTDIR}/usr/lib/librumpfs_ufs.a 1646 LIBRUMPUSER?= ${DESTDIR}/usr/lib/librumpuser.a 1647 LIBSASLC?= ${DESTDIR}/usr/lib/libsaslc.a 1648 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 1649 LIBSL?= ${DESTDIR}/usr/lib/libsl.a 1650 LIBSQLITE3?= ${DESTDIR}/usr/lib/libsqlite3.a 1651 LIBSS?= ${DESTDIR}/usr/lib/libss.a 1652 LIBSSH?= ${DESTDIR}/usr/lib/libssh.a 1653 LIBSSL?= ${DESTDIR}/usr/lib/libssl.a 1654 LIBSSP?= ${DESTDIR}/usr/lib/libssp.a 1655 LIBSTDCXX?= ${DESTDIR}/usr/lib/libstdc++.a 1656 LIBSUPCXX?= ${DESTDIR}/usr/lib/libsupc++.a 1657 LIBTERMINFO?= ${DESTDIR}/usr/lib/libterminfo.a 1658 LIBTRE?= ${DESTDIR}/usr/lib/libtre.a 1659 LIBUNBOUND?= ${DESTDIR}/usr/lib/libunbound.a 1660 LIBUSBHID?= ${DESTDIR}/usr/lib/libusbhid.a 1661 LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 1662 LIBWIND?= ${DESTDIR}/usr/lib/libwind.a 1663 LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 1664 LIBY?= ${DESTDIR}/usr/lib/liby.a 1665 LIBZ?= ${DESTDIR}/usr/lib/libz.a 1666 1667 The following X-Windows libraries are predefined for DPADD: 1668 1669 LIBFS?= ${DESTDIR}/usr/X11R7/lib/libFS.a 1670 LIBGL?= ${DESTDIR}/usr/X11R7/lib/libGL.a 1671 LIBGLU?= ${DESTDIR}/usr/X11R7/lib/libGLU.a 1672 LIBICE?= ${DESTDIR}/usr/X11R7/lib/libICE.a 1673 LIBSM?= ${DESTDIR}/usr/X11R7/lib/libSM.a 1674 LIBX11?= ${DESTDIR}/usr/X11R7/lib/libX11.a 1675 LIBX11_XCB?= ${DESTDIR}/usr/X11R7/lib/libX11-xcb.a 1676 LIBXTRAP?= ${DESTDIR}/usr/X11R7/lib/libXTrap.a 1677 LIBXAU?= ${DESTDIR}/usr/X11R7/lib/libXau.a 1678 LIBXAW?= ${DESTDIR}/usr/X11R7/lib/libXaw.a 1679 LIBXCB?= ${DESTDIR}/usr/X11R7/lib/libxcb.a 1680 LIBXDMCP?= ${DESTDIR}/usr/X11R7/lib/libXdmcp.a 1681 LIBXEXT?= ${DESTDIR}/usr/X11R7/lib/libXext.a 1682 LIBXFONT?= ${DESTDIR}/usr/X11R7/lib/libXfont.a 1683 LIBXFONT2?= ${DESTDIR}/usr/X11R7/lib/libXfont2.a 1684 LIBXFT?= ${DESTDIR}/usr/X11R7/lib/libXft.a 1685 LIBXI?= ${DESTDIR}/usr/X11R7/lib/libXi.a 1686 LIBXINERAMA?= ${DESTDIR}/usr/X11R7/lib/libXinerama.a 1687 LIBXMU?= ${DESTDIR}/usr/X11R7/lib/libXmu.a 1688 LIBXMUU?= ${DESTDIR}/usr/X11R7/lib/libXmuu.a 1689 LIBXPM?= ${DESTDIR}/usr/X11R7/lib/libXpm.a 1690 LIBXRANDR?= ${DESTDIR}/usr/X11R7/lib/libXrandr.a 1691 LIBXRENDER?= ${DESTDIR}/usr/X11R7/lib/libXrender.a 1692 LIBXSS?= ${DESTDIR}/usr/X11R7/lib/libXss.a 1693 LIBXT?= ${DESTDIR}/usr/X11R7/lib/libXt.a 1694 LIBXTST?= ${DESTDIR}/usr/X11R7/lib/libXtst.a 1695 LIBXV?= ${DESTDIR}/usr/X11R7/lib/libXv.a 1696 LIBXXF86DGA?= ${DESTDIR}/usr/X11R7/lib/libXxf86dga.a 1697 LIBXXF86MISC?= ${DESTDIR}/usr/X11R7/lib/libXxf86misc.a 1698 LIBXXF86VM?= ${DESTDIR}/usr/X11R7/lib/libXxf86vm.a 1699 LIBDPS?= ${DESTDIR}/usr/X11R7/lib/libdps.a 1700 LIBFNTSTUBS?= ${DESTDIR}/usr/X11R7/lib/libfntstubs.a 1701 LIBFONTCONFIG?= ${DESTDIR}/usr/X11R7/lib/libfontconfig.a 1702 LIBFONTENC?= ${DESTDIR}/usr/X11R7/lib/libfontenc.a 1703 LIBFREETYPE?= ${DESTDIR}/usr/X11R7/lib/libfreetype.a 1704 LIBLBXUTIL?= ${DESTDIR}/usr/X11R7/lib/liblbxutil.a 1705 LIBXKBFILE?= ${DESTDIR}/usr/X11R7/lib/libxkbfile.a 1706 1707SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 1708 strings, using xstr(1). Note that this will not work with 1709 parallel makes. 1710 1711STRIPFLAG The flag passed to the install program to cause the binary 1712 to be stripped. 1713 1714SUBDIR A list of subdirectories that should be built as well. 1715 Each of the targets will execute the same target in the 1716 subdirectories. 1717 1718SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 1719 These are installed exactly like programs. 1720 1721SCRIPTSDIR The location to install the scripts. Each script can be 1722 installed to a separate path by setting SCRIPTSDIR_<script>. 1723 1724SCRIPTSNAME The name that the above program will be installed as, if 1725 different from ${SCRIPTS}. These can be further specialized 1726 by setting SCRIPTSNAME_<script>. 1727 1728FILES See description of <bsd.files.mk>. 1729 1730SHLINKDIR Target directory for shared linker. See description of 1731 <bsd.own.mk> for additional information about this variable. 1732 1733The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 1734if it exists, as well as the include file <bsd.man.mk>. 1735 1736Some simple examples: 1737 1738To build foo from foo.c with a manual page foo.1, use: 1739 1740 PROG= foo 1741 1742 .include <bsd.prog.mk> 1743 1744To build foo from foo.c with a manual page foo.2, add the line: 1745 1746 MAN= foo.2 1747 1748If foo does not have a manual page at all, add the line: 1749 1750 MKMAN= no 1751 1752If foo has multiple source files, add the line: 1753 1754 SRCS= a.c b.c c.c d.c 1755 1756 1757=-=-=-=-= bsd.rpc.mk =-=-=-=-= 1758 1759The include file <bsd.rpc.mk> contains a makefile fragment used to 1760construct source files built by rpcgen. 1761 1762The following macros may be defined in makefiles which include 1763<bsd.rpc.mk> in order to control which files get built and how they 1764are to be built: 1765 1766RPC_INCS: construct .h file from .x file 1767RPC_XDRFILES: construct _xdr.c from .x file 1768 (for marshalling/unmarshalling data types) 1769RPC_SVCFILES: construct _svc.c from .x file 1770 (server-side stubs) 1771RPC_SVCFLAGS: Additional flags passed to builds of RPC_SVCFILES. 1772 1773RPC_XDIR: Directory containing .x/.h files 1774 1775 1776=-=-=-=-= bsd.shlib.mk =-=-=-=-= 1777 1778The include file <bsd.shlib.mk> computes parameters for shared library 1779installation and use. It defines no targets. <bsd.own.mk> MUST be 1780included before <bsd.shlib.mk>. 1781 1782<bsd.own.mk> sets the following variables, if they are not already defined 1783(defaults are in brackets): 1784 1785SHLIBINSTALLDIR If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR} 1786 instead of ${LIBDIR} as the base path for shared library 1787 installation. [/lib] 1788 1789SHLIBDIR The path to USE_SHLIBDIR shared libraries to use when building 1790 a program. [/lib for programs in /bin and /sbin, /usr/lib 1791 for all others.] 1792 1793_LIBSODIR Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no", 1794 otherwise set to ${LIBDIR} 1795 1796SHLINKINSTALLDIR Base path for shared linker. [/libexec] 1797 1798SHLINKDIR Path to use for shared linker when building a program. 1799 [/libexec for programs in /bin and /sbin, /usr/libexec for 1800 all others.] 1801 1802 1803=-=-=-=-= bsd.subdir.mk =-=-=-=-= 1804 1805The include file <bsd.subdir.mk> contains the default targets for building 1806subdirectories. It has the same eight targets as <bsd.prog.mk>: all, 1807clean, cleandir, depend, includes, install, lint, and tags. It uses the 1808following variables: 1809 1810NOSUBDIR If this variable is defined, then the SUBDIR variable 1811 will be ignored and subdirectories will not be processed. 1812 1813SUBDIR For all of the directories listed in ${SUBDIR}, the 1814 specified directory will be visited and the target made. 1815 1816 As a special case, the use of a token .WAIT as an 1817 entry in SUBDIR acts as a synchronization barrier 1818 when multiple make jobs are run; subdirs before the 1819 .WAIT must complete before any subdirs after .WAIT are 1820 started. See make(1) for some caveats on use of .WAIT 1821 and other special sources. 1822 1823 1824=-=-=-=-= bsd.x11.mk =-=-=-=-= 1825 1826The include file <bsd.x11.mk> contains parameters and targets for 1827cross-building X11 from ${X11SRCDIR.<package>}. It should be included 1828after the general Makefile contents but before the include files such as 1829<bsd.prog.mk> and <bsd.lib.mk>. 1830 1831It provides the following targets: 1832 .man.1 .man.3 .man.4 .man.5 .man.7: 1833 If ${MAN} or ${PROG} is set and ${MKMAN} != "no", 1834 these rules convert from X11's manual page source 1835 into an mdoc.old source file. 1836 1837It sets the following variables: 1838 1839BINDIR Set to ${X11BINDIR}. 1840 To override, define after including <bsd.x11.mk> 1841 1842LIBDIR Set to ${X11USRLIBDIR}. 1843 To override, define after including <bsd.x11.mk> 1844 1845MANDIR Set to ${X11MANDIR}. 1846 To override, define after including <bsd.x11.mk> 1847 1848CPPFLAGS Appended with definitions to include from 1849 ${DESTDIR}${X11INCDIR} 1850 1851LDFLAGS Appended with definitions to link from 1852 ${DESTDIR}${X11USRLIBDIR} 1853 1854X11FLAGS.CONNECTION Equivalent to X11's CONNECTION_FLAGS. 1855 1856X11FLAGS.EXTENSION Equivalent to X11's EXT_DEFINES. 1857 1858X11FLAGS.LOADABLE Equivalent to X11's LOADABLE. 1859 1860X11FLAGS.OS_DEFINES Equivalent to X11's OS_DEFINES. 1861 1862X11FLAGS.SERVER Equivalent to X11's ServerDefines. 1863 1864X11FLAGS.THREADLIB Equivalent to X11's THREADS_DEFINES for libraries. 1865 1866X11FLAGS.THREADS Equivalent to X11's THREADS_DEFINES. 1867 1868X11FLAGS.VERSION cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION. 1869 1870X11FLAGS.DIX Equivalent to X11's DIX_DEFINES. 1871 1872X11TOOL_UNXCOMM Commandline to convert `XCOMM' comments to `#' 1873 1874It uses the following variables: 1875 1876APPDEFS List of app-default files to install. 1877 1878CPPSCRIPTS List of files/scripts to run through cpp(1) 1879 and then ${X11TOOL_UNXCOMM}. The source files 1880 have a `.cpp' suffix, the generated files do not. 1881 1882CPPSCRIPTFLAGS Additional flags to cpp(1) when building CPPSCRIPTS. 1883 1884CPPSCRIPTFLAGS_<fn> Additional flags to cpp(1) when building CPPSCRIPT <fn>. 1885 1886 1887=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1888 1889The following files are described here for completion, but they are not 1890supposed to be included directly from other Makefiles; they are used 1891internally by other system files. 1892 1893=-=-=-=-= bsd.sys.mk =-=-=-=-= 1894 1895The include file <bsd.sys.mk> is used by other system mk files and 1896it is not intended to be included standalone. It contains rules and 1897system build variables. It requires bsd.own.mk to be included first. 1898It contains overrides that are used when building the NetBSD source tree. 1899 1900The following variables control how various files are compiled/built. 1901(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"): 1902 1903AR Create, modify, and extract from archives. [ar] 1904 1905ARFLAGS Options to ${AR}. [rl] 1906 1907AS Assembler. [as] 1908 1909AFLAGS Options to ${CC} when compiling or linking .s or .S 1910 assembly source files. [] 1911 1912BUILDSEED GCC uses random numbers when compiling C++ code. 1913 If this option is present, seed the random number 1914 generator based on the value, source file names and 1915 the output file name to make builds more deterministic. 1916 Additional information is available in the GCC 1917 documentation of -frandom-seed. 1918 1919CC C compiler. [cc] 1920 1921CFLAGS Options to ${CC}. [Usually -O or -O2] 1922 1923CPP C Pre-Processor. [cpp] 1924 1925CPPFLAGS Options to ${CPP}. [] 1926 1927CPUFLAGS Optimization flags for ${CC}. [] 1928 1929CXX C++ compiler. [c++] 1930 1931CXXFLAGS Options to ${CXX}. [${CFLAGS}] 1932 1933ELF2ECOFF Convert ELF-format executable to ECOFF. [elf2ecoff] 1934 1935FC Fortran compiler. [f77] 1936 1937FFLAGS Options to {$FC}. [-O] 1938 1939HOST_SH Shell. This must be an absolute path, because it may be 1940 substituted into "#!" lines in scripts. [/bin/sh] 1941 1942INSTALL install(1) command. [install] 1943 1944LEX Lexical analyzer. [lex] 1945 1946LFLAGS Options to ${LEX}. [] 1947 1948LPREFIX Symbol prefix for ${LEX} (see -P option in lex(1)) [yy] 1949 1950LD Linker. [ld] 1951 1952LDFLAGS Options to ${CC} during the link process. [] 1953 1954LINT C program verifier. [lint] 1955 1956LINTFLAGS Options to ${LINT}. [-chapbxzgFS] 1957 1958LORDER List dependencies for object files. [lorder] 1959 1960MAKE make(1). [make] 1961 1962MKDEP Construct Makefile dependency list. [mkdep] 1963 1964MKDEPCXX Construct Makefile dependency list for C++ files. [mkdep] 1965 1966NM List symbols from object files. [nm] 1967 1968PC Pascal compiler. [pc] (Not present) 1969 1970PFLAGS Options to ${PC}. [] 1971 1972OBJC Objective C compiler. [${CC}] 1973 1974OBJCFLAGS Options to ${OBJC}. [${CFLAGS}] 1975 1976OBJCOPY Copy and translate object files. [objcopy] 1977 1978OBJCOPYLIBFLAGS Flags to pass to objcopy when library objects are 1979 being built. [${.TARGET} =~ "*.po" ? -X : -x] 1980 1981OBJDUMP Display information from object files. [objdump] 1982 1983RANLIB Generate index to archive. [ranlib] 1984 1985READELF Display information from ELF object files. [readelf] 1986 1987SIZE List section sizes and total size. [size] 1988 1989STRINGS Display printable character sequences in files. [strings] 1990 1991STRIP Discard symbols from object files. [strip] 1992 1993TSORT Topological sort of a directed graph. [tsort -q] 1994 1995YACC LALR(1) parser generator. [yacc] 1996 1997YFLAGS Options to ${YACC}. [] 1998 1999YHEADER If defined, add "-d" to YFLAGS, and add dependencies 2000 from <file>.y to <file>.h and <file>.c, and add 2001 <foo>.h to CLEANFILES. 2002 2003YPREFIX If defined, add "-p ${YPREFIX}" to YFLAGS. 2004 2005 2006Other variables of note (incomplete list): 2007 2008NOGCCERROR If defined, prevents passing certain ${CFLAGS} to GCC 2009 that cause warnings to be fatal, such as: 2010 -Werror -Wa,--fatal-warnings 2011 (The latter being for as(1).) 2012 2013NOCLANGERROR If defined and clang is used as C compiler, -Werror is not 2014 passed to it. 2015 2016WARNS Crank up compiler warning options; the distinct levels are: 2017 WARNS=1 2018 WARNS=2 2019 WARNS=3 2020 WARNS=4 2021 WARNS=5 2022 WARNS=6 2023 2024=-=-=-=-= bsd.host.mk =-=-=-=-= 2025 2026This file is automatically included from bsd.own.mk. It contains settings 2027for all the HOST_* variables that are used in host programs and libraries. 2028 2029HOST_AR The host archive processing command 2030 2031HOST_CC The host c compiler 2032 2033HOST_CFLAGS The host c compiler flags 2034 2035HOST_COMPILE.c The host c compiler line with flags 2036 2037HOST_COMPILE.cc The host c++ compiler line with flags 2038 2039HOST_CPP The host c pre-processor 2040 2041HOST_CPPFLAGS The cost c pre-processor flags 2042 2043HOST_CXX The host c++ compiler 2044 2045HOST_CXXFLAGS The host c++ compiler flags 2046 2047HOST_INSTALL_DIR The host command to install a directory 2048 2049HOST_INSTALL_FILE The host command to install a file 2050 2051HOST_INSTALL_SYMLINK The host command to install a symlink 2052 2053HOST_LD The host linker command 2054 2055HOST_LDFLAGS The host linker flags 2056 2057HOST_LINK.c The host c linker line with flags 2058 2059HOST_LINK.cc The host c++ linker line with flags 2060 2061HOST_LN The host command to link two files 2062 2063HOST_MKDEP The host command to create dependencies for c programs 2064 2065HOST_MKDEPCXX The host command to create dependencies for c++ programs 2066 2067HOST_OSTYPE The host OSNAME-RELEASE-ARCH tupple 2068 2069HOST_RANLIB The host command to create random access archives 2070 2071HOST_SH The host Bourne shell interpreter name (absolute path) 2072 2073=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 2074