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