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