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