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