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