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