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