bsd.README revision 1.137
1# $NetBSD: bsd.README,v 1.137 2003/09/13 11:16:28 simonb Exp $ 2# @(#)bsd.README 8.2 (Berkeley) 4/2/94 3 4This is the README file for the new make "include" files for the BSD 5source tree. The files are installed in /usr/share/mk, and are, by 6convention, 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 ".so" denotes a shared (position-independent) object. 60 61There are various make variables used during the build. Basic rule for 62the variable naming scheme is as follows: 63 64MKxxx Can be set to "no" to disable functionality, or 65 "yes" to enable it. 66 Usually defaults to "yes", although some variables 67 default to "no". 68 Due to make(1) implementation issues, if a temporary 69 command-line override of a mk.conf or <bsd.own.mk> setting 70 is required whilst still honouring a particular 71 Makefile's setting of MKxxx, use 72 env MKxxx=value make 73 instead of 74 make MKxxx=value 75 76NOxxx If defined, disables a feature. 77 Not intended for users. 78 This is to allow Makefiles to disable functionality 79 that they don't support (such as missing man pages). 80 NOxxx variables must be defined before <bsd.own.mk> 81 is included. 82 83The following variables that control how things are made/installed that 84are not set by default. These should not be set by Makefiles; they're for 85the user to define in MAKECONF (see <bsd.own.mk>, below) or on the make(1) 86command line: 87 88BUILD If defined, 'make install' checks that the targets in the 89 source directories are up-to-date and remakes them if they 90 are out of date, instead of blindly trying to install 91 out of date or non-existent targets. 92 93MKBFD If "no", don't build libbfd, libiberty, or any of the things 94 that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage). 95 Default: yes 96 97MKCATPAGES If "no", don't build or install the catman pages. 98 Default: yes 99 100MKCRYPTO If "no", no cryptography support will be built into the system, 101 and also acts as MKKERBEROS=no MKKERBEROS4=no. 102 Default: yes 103 104MKCRYPTO_IDEA If not "no", IDEA support will be built into libcrypto_idea.a. 105 Default: no 106 107MKCRYPTO_MDC2 If not "no", MDC2 support will be built into libcrypto_mdc2.a 108 Default: no 109 110MKCRYPTO_RC5 If not "no", RC5 support will be built into libcrypto_rc5.a. 111 Default: no 112 113MKDOC If "no", don't build or install the documentation. 114 Default: yes 115 116MKDYNAMICROOT If "no", build programs in /bin and /sbin statically, 117 don't install certain libraries in /lib, and don't 118 install the shared linker into /libexec. 119 Default: yes 120 121MKGCC If "no", don't build gcc or any of the gcc-related 122 libraries (libg2c, libgcc, libobjc, libstdc++). 123 Default: yes 124 125MKGDB If "no", don't build gdb. 126 Default: yes 127 128MKHESIOD If "no", disables building of Hesiod infrastructure 129 (libraries and support programs). 130 Default: yes 131 132MKHOSTOBJ If "yes", for programs intended to be run on the compile host, 133 the name, release, and architecture of the host operating 134 system will be suffixed to the name of the object directory 135 created by "make obj". 136 Default: no 137 138MKHTML If "no", don't build or install the html man pages. 139 Default: yes 140 141MKIEEEFP If "no", don't add code for IEEE754/IEC60559 conformance. 142 Has no effect on most platforms. 143 Default: yes 144 145MKINFO If "no", don't build or install Info documentation from 146 Texinfo source files. 147 Default: yes 148 149MKKERBEROS4 If "no", disables building of Kerberos v4 150 infrastructure (libraries and support programs). 151 Default: yes 152 153MKKERBEROS If "no", disables building of Kerberos v5 154 infrastructure (libraries and support programs). 155 Default: yes 156 157MKLINKLIB If "no", act as "MKPICINSTALL=no MKPROFILE=no". 158 Also: 159 - don't install the .a libraries 160 - don't install _pic.a libraries on PIC systems 161 - don't build .a libraries on PIC systems 162 - don't install the .so symlink on ELF systems 163 I.e, only install the shared library (and the .so.major 164 symlink on ELF). 165 Default: yes 166 167MKLINT If "no", don't build or install the lint libraries. 168 Default: yes 169 170MKMAN If "no", don't build or install the man or catman pages, 171 and also acts as "MKCATPAGES=no MKHTML=no" 172 Default: yes 173 174MKMANZ If not "no", compress manual pages at installation time. 175 Default: no 176 177MKNLS If "no", don't build or install the NLS files and locale 178 definition files. 179 Default: yes 180 181MKOBJ If "no", don't enable the rule which creates objdirs, 182 and also acts as "MKOBJDIRS=no" 183 Default: yes 184 185MKOBJDIRS If "no", don't create objdirs during a "make build". 186 Default: no 187 188MKPIC If "no", don't build or install shared libraries, and 189 also acts as "MKPICLIB=no" 190 Default: yes, except for ${MACHINE_ARCH} == "sh3" 191 192MKPICINSTALL If "no", don't install the *_pic.a libraries. 193 Default: yes 194 195MKPICLIB If "no", don't build *_pic.a libraries, and build the 196 shared object libraries from the .a libraries. 197 A symlink is installed in ${DESTDIR}/usr/lib for the 198 _pic.a library pointing to the .a library. 199 Default: yes 200 201MKPROFILE If "no", don't build or install the profiling libraries. 202 Default: yes 203 204MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no 205 MKMAN=no MKNLS=no". 206 I.e, don't build catman pages, documentation, Info 207 documentation, man pages, NLS files, ... 208 Default: yes 209 210MKSKEY If "no", disables building of S/key authentication 211 infrastructure (libraries and support programs). 212 Default: yes 213 214MKSOFTFLOAT If not "no", build with options to enable the compiler to 215 generate output containing library calls for floating 216 point and possibly soft-float library support. 217 Default: no 218 219MKUNPRIVED If not "no", don't set the owner/group/mode when installing 220 files or directories, and keep a metadata log of what 221 the owner/group/mode should be. This allows a 222 non-root "make install". 223 Default: no 224 225MKUPDATE If not "no", 'make install' only installs targets that are 226 more recently modified in the source directories that their 227 installed counterparts. 228 Default: no 229 230MKYP If "no", disables building of YP (NIS) 231 infrastructure (libraries and support programs). 232 Default: yes 233 234USE_HESIOD If "no", disables building Hesiod support into 235 various system utilities/libraries that support it. 236 If MKHESIOD is "no", USE_HESIOD will also be 237 forced to "no". 238 239USE_KERBEROS4 If "no", disables building Kerberos v4 240 support into various system utilities/libraries that 241 support it. If MKKERBEROS4 is "no", USE_KERBEROS4 242 will also be forced to "no". 243 244USE_KERBEROS If "no", disables building Kerberos v4 or v5) 245 support into various system utilities/libraries that 246 support it. If MKKERBEROS is "no", USE_KERBEROS 247 will also be forced to "no". 248 249USE_SKEY If "no", disables building S/key authentication 250 support into various system utilities/libraries that 251 support it. If MKSKEY is "no", USE_SKEY will 252 also be forced to "no". 253 254USE_YP If "no", disables building YP (NIS) support into 255 various system utilities/libraries that support it. 256 If MKYP is "no", USE_YP will also be forced to "no". 257 258COPTS.lib<lib> 259LDADD.lib<lib> 260CPPFLAGS.lib<lib> 261CXXFLAGS.lib<lib> 262COPTS.<prog> 263LDADD.<prog> 264CPPFLAGS.<prog> 265CXXFLAGS.<prog> These provide a way to specify additions to the associated 266 variables in a way that applies only to a particular library 267 or program. <lib> corresponds to the LIB variable set in 268 the library's makefile. <prog> corresponds to either PROG 269 or PROG_CXX (if set). For example, if COPTS.libcrypto is 270 set to "-g", "-g" will be added to COPTS only when compiling 271 the crypto library. 272 273=-=-=-=-= sys.mk =-=-=-=-= 274 275The include file <sys.mk> has the default rules for all makes, in the BSD 276environment or otherwise. You probably don't want to touch this file. 277 278=-=-=-=-= bsd.own.mk =-=-=-=-= 279 280The include file <bsd.own.mk> contains source tree configuration parameters, 281such as the owners, groups, etc. for both manual pages and binaries, and 282a few global "feature configuration" parameters. 283 284It has no targets. 285 286To get system-specific configuration parameters, <bsd.own.mk> will try to 287include the file specified by the "MAKECONF" variable. If MAKECONF is not 288set, or no such file exists, the system make configuration file, /etc/mk.conf 289is included. These files may define any of the variables described below. 290 291<bsd.own.mk> sets the following variables, if they are not already defined 292(defaults are in brackets): 293 294NETBSDSRCDIR Top of the NetBSD source tree. 295 If _SRC_TOP_ != "", that will be used as the default, 296 otherwise BSDSRCDIR will be used as the default. 297 Various makefiles within the NetBSD source tree will 298 use this to reference the top level of the source tree. 299 300_SRC_TOP_ Top of the system source tree, as determined by <bsd.own.mk> 301 based on the presence of tools/ and build.sh. This variable 302 is "internal" to <bsd.own.mk>, although its value is only 303 determined once and then propagated to all sub-makes. 304 305BSDSRCDIR The real path to the system sources, so that 'make obj' 306 will work correctly. [/usr/src] 307 308BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' 309 will work correctly. [/usr/obj] 310 311BINGRP Binary group. [wheel] 312 313BINOWN Binary owner. [root] 314 315BINMODE Binary mode. [555] 316 317NONBINMODE Mode for non-executable files. [444] 318 319MANDIR Base path for manual installation. [/usr/share/man/cat] 320 321MANGRP Manual group. [wheel] 322 323MANOWN Manual owner. [root] 324 325MANMODE Manual mode. [${NONBINMODE}] 326 327MANINSTALL Manual installation type: maninstall, catinstall, or both 328 329LDSTATIC Control program linking; if set blank, link everything 330 dynamically. If set to "-static", link everything statically. 331 If not set, programs link according to their makefile. 332 333LIBDIR Base path for library installation. [/usr/lib] 334 335LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] 336 337LIBGRP Library group. [${BINGRP}] 338 339LIBOWN Library owner. [${BINOWN}] 340 341LIBMODE Library mode. [${NONBINMODE}] 342 343DOCDIR Base path for system documentation (e.g. PSD, USD, etc.) 344 installation. [/usr/share/doc] 345 346HTMLDOCDIR Base path for html system documentation installation. 347 [/usr/share/doc/html] 348 349DOCGRP Documentation group. [wheel] 350 351DOCOWN Documentation owner. [root] 352 353DOCMODE Documentation mode. [${NONBINMODE}] 354 355NLSDIR Base path for Native Language Support files installation. 356 [/usr/share/nls] 357 358NLSGRP Native Language Support files group. [wheel] 359 360NLSOWN Native Language Support files owner. [root] 361 362NLSMODE Native Language Support files mode. [${NONBINMODE}] 363 364STRIPFLAG The flag passed to the install program to cause the binary 365 to be stripped. This is to be used when building your 366 own install script so that the entire system can be made 367 stripped/not-stripped using a single knob. [-s] 368 369COPY The flag passed to the install program to cause the binary 370 to be copied rather than moved. This is to be used when 371 building our own install script so that the entire system 372 can either be installed with copies, or with moves using 373 a single knob. [-c] 374 375Additionally, the following variables may be set by <bsd.own.mk> or in a 376make configuration file to modify the behaviour of the system build 377process (default values are in brackets along with comments, if set by 378<bsd.own.mk>): 379 380OBJECT_FMT Object file format. [set to "ELF" on architectures that 381 use ELF -- currently if ${MACHINE_ARCH} is "alpha", 382 "mipsel", "mipseb", "powerpc", "sparc", "sparc64", 383 "i386" and some m68k machines, or set to "a.out" on 384 other architectures]. 385 386TOOLCHAIN_MISSING 387 If "yes", this indicates that the platform being built 388 does not have a working in-tree toolchain. If the 389 MACHINE_ARCH in question falls into this category, the 390 variable is conditionally assigned the value "yes". 391 Otherwise, the variable is unconditionally assigned the 392 value "no". 393 394 If TOOLCHAIN_MISSING is "yes", the variables MKBFD, MKGCC, 395 and MKGDB are unconditionally assigned the value "no". 396 397EXTERNAL_TOOLCHAIN 398 This variable is not directly set by <bsd.own.mk>, but 399 including <bsd.own.mk> is the canonical way to gain 400 access to this variable. The variable should be defined 401 either in the user's environment or in the user's mk.conf 402 file. If defined, this variable indicates the root of 403 an external toolchain which will be used to build the 404 tree. For example, if a platform is a TOOLCHAIN_MISSING 405 platform, EXTERNAL_TOOLCHAIN can be used to re-enable the 406 cross-compile framework. 407 408 If EXTERNAL_TOOLCHAIN is defined, the variable MKGCC is 409 unconditionally assigned the value "no", since the external 410 version of the compiler may not be able to build the library 411 components of the in-tree compiler. 412 413 NOTE: This variable is not yet used in as many places as 414 it should be. Expect the exact semantics of this variable 415 to change in the short term as parts of the cross-compile 416 framework continue to be cleaned up. 417 418<bsd.own.mk> is generally useful when building your own Makefiles so that 419they use the same default owners etc. as the rest of the tree. 420 421 422=-=-=-=-= bsd.dep.mk =-=-=-=-= 423 424The include file <bsd.dep.mk> contains the default targets for building 425.depend files. It creates .d files from entries in SRCS and DPSRCS 426that are C, C++, or Objective C source files, and builds .depend from the 427.d files. All other files in SRCS and all of DPSRCS will be used as 428dependencies for the .d files. In order for this to function correctly, 429it should be .included after all other .mk files and directives that may 430modify SRCS or DPSRCS. It uses the following variables: 431 432SRCS List of source files to build the program. 433 434DPSRCS List of source files which are needed for generating 435 dependencies, but are not needed in ${SRCS}. 436 437 438=-=-=-=-= bsd.files.mk =-=-=-=-= 439 440The include file <bsd.files.mk> handles the FILES variables and is included 441from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables: 442 443FILES The list of files to install. 444 445FILESOWN File owner. [${BINOWN}] 446 447FILESGRP File group. [${BINGRP}] 448 449FILESMODE File mode. [${BINMODE}] 450 451FILESDIR The location to install the files. 452 453FILESNAME Optional name to install each file as. 454 455FILESDIR.<fn> The location to install the specific file <fn>. 456 457FILESNAME.<fn> Optional name to install <fn> as. 458 459LNFILES List of two word items: 460 lnsrc lntgt 461 For each lnsrc item, create a symlink named lntgt. 462 The lntgt symlinks are removed by the cleandir target. 463 464 465=-=-=-=-= bsd.gcc.mk =-=-=-=-= 466 467The include file <bsd.gcc.mk> computes various parameters related to GCC 468support libraries. It defines no targets. <bsd.own.mk> MUST be included 469before <bsd.gcc.mk>. 470 471The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each 472of which need to know where to find certain GCC support libraries. 473 474The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable, 475which is generally set by the user. If EXTERNAL_TOOLCHAIN it set, then 476the compiler is asked where to find the support libraries, otherwise the 477support libraries are found in ${DESTDIR}/usr/lib. 478 479<bsd.gcc.mk> sets the following variables: 480 481_GCC_CRTBEGIN The full path name to crtbegin.o. 482 483_GCC_CRTBEGINS The full path name to crtbeginS.o. 484 485_GCC_CRTEND The full path name to crtend.o. 486 487_GCC_CRTENDS The full path name to crtendS.o. 488 489_GCC_LIBGCCDIR The directory where libgcc.a is located. 490 491 492=-=-=-=-= bsd.inc.mk =-=-=-=-= 493 494The include file <bsd.inc.mk> defines the includes target and uses the 495variables: 496 497INCS The list of include files. 498 499INCSDIR The location to install the include files. 500 501INCSNAME Target name of the include file, if only one; same as 502 FILESNAME, but for include files. 503 504INCSYMLINKS Similar to SYMLINKS in <bsd.links.mk>, except that these 505 are installed in the 'includes' target and not the 506 (much later) 'install' target. 507 508INCSNAME_<file> The name file <file> should be installed as, if not <file>, 509 same as FILESNAME_<file>, but for include files. 510 511 512=-=-=-=-= bsd.info.mk =-=-=-=-= 513 514The include file <bsd.info.mk> is used to generate and install GNU Info 515documentation from respective Texinfo source files. It defines three 516implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the 517following variables: 518 519TEXINFO List of Texinfo source files. Info documentation will 520 consist of single files with the extension replaced by 521 .info. 522 523INFOFLAGS Flags to pass to makeinfo. [] 524 525 526=-=-=-=-= bsd.kernobj.mk =-=-=-=-= 527 528The include file <bsd.kernobj.mk> defines variables related to the 529location of kernel sources and object directories. 530 531KERNSRCDIR Is the location of the top of the kernel src. 532 [${_SRC_TOP_}/sys] 533 534KERNARCHDIR Is the location of the machine dependent kernel sources. 535 [arch/${MACHINE}] 536 537KERNCONFDIR Is where the configuration files for kernels are found. 538 [${KERNSRCDIR}/${KERNARCHDIR}/conf] 539 540KERNOBJDIR Is the kernel build directory. The kernel GENERIC for 541 instance will be compiled in ${KERNOBJDIR}/GENERIC. 542 The default value is 543 ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile 544 if it exists or the target 'obj' is being made. 545 Otherwise the default is 546 ${KERNSRCDIR}/${KERNARCHDIR}/compile. 547 548It is important that Makefiles (such as those under src/distrib) that 549wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR} 550rather than make assumptions about the location of the compiled kernel. 551 552 553=-=-=-=-= bsd.kinc.mk =-=-=-=-= 554 555The include file <bsd.kinc.mk> defines the many targets (includes, 556subdirectories, etc.), and is used by kernel makefiles to handle 557include file installation. It is intended to be included alone, by 558kernel Makefiles. It uses similar variables to <bsd.inc.mk>. 559Please see <bsd.kinc.mk> for more details, and keep the documentation 560in that file up to date. 561 562 563=-=-=-=-= bsd.lib.mk =-=-=-=-= 564 565The include file <bsd.lib.mk> has support for building libraries. It has 566the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 567includes, install, lint, and tags. Additionally, it has a checkver target 568which checks for installed shared object libraries whose version is greater 569that the version of the source. It has a limited number of suffixes, 570consistent with the current needs of the BSD tree. <bsd.lib.mk> includes 571<bsd.shlib.mk> to get shared library parameters. 572 573It sets/uses the following variables: 574 575LIB The name of the library to build. 576 577LIBDIR Target directory for libraries. 578 579SHLIBINSTALLDIR Target directory for shared libraries if ${USE_SHLIBDIR} 580 is "yes". 581 582USE_SHLIBDIR If "yes", use ${SHLIBINSTALLDIR} instead of ${LIBDIR} 583 as the path to install shared libraries to. 584 USE_SHLIBDIR must be defined before <bsd.own.mk> is included. 585 Default: no 586 587LINTLIBDIR Target directory for lint libraries. 588 589LIBGRP Library group. 590 591LIBOWN Library owner. 592 593LIBMODE Library mode. 594 595LDADD Additional loader objects. 596 597MAN The manual pages to be installed (use a .1 - .9 suffix). 598 599NOCHECKVER_<library> 600NOCHECKVER If set, disables checking for installed shared object 601 libraries with versions greater than the source. A 602 particular library name, without the "lib" prefix, may 603 be appended to the variable name to disable the check for 604 only that library. 605 606SRCS List of source files to build the library. Suffix types 607 .s, .c, and .f are supported. Note, .s files are preferred 608 to .c files of the same name. (This is not the default for 609 versions of make.) 610 611The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 612if it exists, as well as the include file <bsd.man.mk>. 613 614It has rules for building profiled objects; profiled libraries are 615built by default. 616 617Libraries are ranlib'd when made. 618 619 620=-=-=-=-= bsd.links.mk =-=-=-=-= 621 622The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 623and is included from from <bsd.lib.mk> and <bsd.prog.mk>. 624 625LINKS The list of hard links, consisting of pairs of paths: 626 source-file target-file 627 ${DESTDIR} is prepended to both paths before linking. 628 For example, to link /bin/test and /bin/[, use: 629 LINKS=/bin/test /bin/[ 630 631SYMLINKS The list of symbolic links, consisting of pairs of paths: 632 source-file target-file 633 ${DESTDIR} is only prepended to target-file before linking. 634 For example, to symlink /usr/bin/tar to /bin/tar resulting 635 in ${DESTDIR}/usr/bin/tar -> /bin/tar: 636 SYMLINKS=/bin/tar /usr/bin/tar 637 638 639=-=-=-=-= bsd.man.mk =-=-=-=-= 640 641The include file <bsd.man.mk> handles installing manual pages and their 642links. 643 644It has a two targets: 645 646 maninstall: 647 Install the manual page sources and their links. 648 catinstall: 649 Install the preformatted manual pages and their links. 650 651It sets/uses the following variables: 652 653MANDIR Base path for manual installation. 654 655MANGRP Manual group. 656 657MANOWN Manual owner. 658 659MANMODE Manual mode. 660 661MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 662 or "/tahoe" for machine specific manual pages. 663 664MAN The manual pages to be installed (use a .1 - .9 suffix). 665 666MLINKS List of manual page links (using a .1 - .9 suffix). The 667 linked-to file must come first, the linked file second, 668 and there may be multiple pairs. The files are soft-linked. 669 670The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 671it exists. 672 673 674=-=-=-=-= bsd.obj.mk =-=-=-=-= 675 676The include file <bsd.obj.mk> defines targets related to the creation 677and use of separated object and source directories. 678 679If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses 680${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if 681it exists. Otherwise make(1) looks for the existence of a 682subdirectory (or a symlink to a directory) of the source directory 683into which built targets should be placed. If an environment variable 684named MAKEOBJDIR is set, make(1) uses its value as the name of the 685object directory; failing that, make first looks for a subdirectory 686named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj". 687 688Object directories are not created automatically by make(1) if they 689don't exist; you need to run a separate "make obj". (This will happen 690during a top-level build if "MKOBJDIRS" is set to a value other than 691"no"). When the source directory is a subdirectory of ${BSDSRCDIR} -- 692and this is determined by a simple string prefix comparison -- object 693directories are created in a separate object directory tree, and a 694symlink to the object directory in that tree is created in the source 695directory; otherwise, "make obj" assumes that you're not in the main 696source tree and that it's not safe to use a separate object tree. 697 698Several variables used by <bsd.obj.mk> control exactly what 699directories and links get created during a "make obj": 700 701MAKEOBJDIR If set, this is the component name of the object 702 directory. 703 704OBJMACHINE If this is set but MAKEOBJDIR is not set, creates 705 object directories or links named "obj.${MACHINE}"; 706 otherwise, just creates ones named "obj". 707 708USR_OBJMACHINE If set, and the current directory is a subdirectory of 709 ${BSDSRCDIR}, create object directory in the 710 corresponding subdirectory of ${BSDOBJDIR}.${MACHINE}; 711 otherwise, create it in the corresponding subdirectory 712 of ${BSDOBJDIR} 713 714BUILDID If set, the contents of this variable are appended 715 to the object directory name. If OBJMACHINE is also 716 set, ".${BUILDID}" is added after ".${MACHINE}". 717 718 719=-=-=-=-= bsd.prog.mk =-=-=-=-= 720 721The include file <bsd.prog.mk> handles building programs from one or 722more source files, along with their manual pages. It has a limited number 723of suffixes, consistent with the current needs of the BSD tree. 724<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters. 725 726It has eight targets: 727 728 all: 729 build the program and its manual page. This also 730 creates a GDB initialization file (.gdbinit) in 731 the objdir. The .gdbinit file sets the shared library 732 prefix to ${DESTDIR} to facilitate cross-debugging. 733 clean: 734 remove the program, any object files and the files a.out, 735 Errs, errs, mklog, and ${PROG}.core. 736 cleandir: 737 remove all of the files removed by the target clean, as 738 well as .depend, tags, and any manual pages. 739 `distclean' is a synonym for `cleandir'. 740 depend: 741 make the dependencies for the source files, and store 742 them in the file .depend. 743 includes: 744 install any header files. 745 install: 746 install the program and its manual pages; if the Makefile 747 does not itself define the target install, the targets 748 beforeinstall and afterinstall may also be used to cause 749 actions immediately before and after the install target 750 is executed. 751 lint: 752 run lint on the source files 753 tags: 754 create a tags file for the source files. 755 756It sets/uses the following variables: 757 758BINGRP Binary group. 759 760BINOWN Binary owner. 761 762BINMODE Binary mode. 763 764CLEANFILES Additional files to remove for the clean and cleandir targets. 765 766COPTS Additional flags to the compiler when creating C objects. 767 768COPTS.<fn> Additional flags to the compiler when creating the 769 C objects for <fn>. 770 For <fn>.[ly], "<fn>.c" must be used. 771 772CPUFLAGS Additional flags to the compiler/assembler to select 773 CPU instruction set options, CPU tuning options, etc. 774 775CPUFLAGS.<fn> Additional flags to the compiler/assembler for <fn>. 776 For <fn>.[ly], "<fn>.c" must be used. 777 778CPPFLAGS Additional flags to the C pre-processor. 779 780CPPFLAGS.<fn> Additional flags to the C pre-processor for <fn>. 781 For <fn>.[ly], "<fn>.c" must be used. 782 783GDBINIT List of GDB initialization files to add to "source" 784 directives in the .gdbinit file that is created in the 785 objdir. 786 787LDADD Additional loader objects. Usually used for libraries. 788 For example, to load with the compatibility and utility 789 libraries, use: 790 791 LDADD+=-lutil -lcompat 792 793LDFLAGS Additional loader flags. 794 795LINKS See <bsd.links.mk> 796 797SYMLINKS See <bsd.links.mk> 798 799MAN Manual pages (should end in .1 - .9). If no MAN variable is 800 defined, "MAN=${PROG}.1" is assumed. 801 802PROG The name of the program to build. If not supplied, nothing 803 is built. 804 805PROG_CXX If defined, the name of the program to build. Also 806 causes <bsd.prog.mk> to link the program with the C++ 807 compiler rather than the C compiler. PROG_CXX overrides 808 the value of PROG if PROG is also set. 809 810PROGNAME The name that the above program will be installed as, if 811 different from ${PROG}. 812 813SRCS List of source files to build the program. If SRCS is not 814 defined, it's assumed to be ${PROG}.c. 815 816DPSRCS List of source files which are needed for generating 817 dependencies, but are not needed in ${SRCS}. 818 819DPADD Additional dependencies for the program. Usually used for 820 libraries. For example, to depend on the compatibility and 821 utility libraries use: 822 823 DPADD+=${LIBCOMPAT} ${LIBUTIL} 824 825 The following libraries are predefined for DPADD: 826 827 LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 828 LIBBZ2?= ${DESTDIR}/usr/lib/libbz2.a 829 LIBC?= ${DESTDIR}/usr/lib/libc.a 830 LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 831 LIBCDK?= ${DESTDIR}/usr/lib/libcdk.a 832 LIBCOM_ERR?= ${DESTDIR}/usr/lib/libcom_err.a 833 LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 834 LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 835 LIBCRYPTO?= ${DESTDIR}/usr/lib/libcrypto.a 836 LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a 837 LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a 838 LIBCRYPTO_RC5?= ${DESTDIR}/usr/lib/libcrypto_rc5.a 839 LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 840 LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 841 LIBDES?= ${DESTDIR}/usr/lib/libdes.a 842 LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 843 LIBEVENT?= ${DESTDIR}/usr/lib/libevent.a 844 LIBFORM?= ${DESTDIR}/usr/lib/libform.a 845 LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 846 LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 847 LIBGSSAPI?= ${DESTDIR}/usr/lib/libgssapi.a 848 LIBHDB?= ${DESTDIR}/usr/lib/libhdb.a 849 LIBINTL?= ${DESTDIR}/usr/lib/libintl.a 850 LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a 851 LIBKADM?= ${DESTDIR}/usr/lib/libkadm.a 852 LIBKADM5CLNT?= ${DESTDIR}/usr/lib/libkadm5clnt.a 853 LIBKADM5SRV?= ${DESTDIR}/usr/lib/libkadm5srv.a 854 LIBKAFS?= ${DESTDIR}/usr/lib/libkafs.a 855 LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a 856 LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a 857 LIBKRB5?= ${DESTDIR}/usr/lib/libkrb5.a 858 LIBKSTREAM?= ${DESTDIR}/usr/lib/libkstream.a 859 LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 860 LIBL?= ${DESTDIR}/usr/lib/libl.a 861 LIBM?= ${DESTDIR}/usr/lib/libm.a 862 LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a 863 LIBMP?= ${DESTDIR}/usr/lib/libmp.a 864 LIBNTP?= ${DESTDIR}/usr/lib/libntp.a 865 LIBOBJC?= ${DESTDIR}/usr/lib/libobjc.a 866 LIBOSSAUDIO?= ${DESTDIR}/usr/lib/libossaudio.a 867 LIBPC?= ${DESTDIR}/usr/lib/libpc.a 868 LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 869 LIBPCI?= ${DESTDIR}/usr/lib/libpci.a 870 LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a 871 LIBPMC?= ${DESTDIR}/usr/lib/libpmc.a 872 LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a 873 LIBPTHREAD?= ${DESTDIR}/usr/lib/libpthread.a 874 LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a 875 LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 876 LIBRMT?= ${DESTDIR}/usr/lib/librmt.a 877 LIBROKEN?= ${DESTDIR}/usr/lib/libroken.a 878 LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 879 LIBRT?= ${DESTDIR}/usr/lib/librt.a 880 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 881 LIBSS?= ${DESTDIR}/usr/lib/libss.a 882 LIBSSL?= ${DESTDIR}/usr/lib/libssl.a 883 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 884 LIBSL?= ${DESTDIR}/usr/lib/libsl.a 885 LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a 886 LIBUSBHID?= ${DESTDIR}/usr/lib/libusbhid.a 887 LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 888 LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 889 LIBY?= ${DESTDIR}/usr/lib/liby.a 890 LIBZ?= ${DESTDIR}/usr/lib/libz.a 891 892SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 893 strings, using xstr(1). Note that this will not work with 894 parallel makes. 895 896STRIPFLAG The flag passed to the install program to cause the binary 897 to be stripped. 898 899SUBDIR A list of subdirectories that should be built as well. 900 Each of the targets will execute the same target in the 901 subdirectories. 902 903SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 904 These are installed exactly like programs. 905 906SCRIPTSNAME The name that the above program will be installed as, if 907 different from ${SCRIPTS}. These can be further specialized 908 by setting SCRIPTSNAME_<script>. 909 910FILES See description of <bsd.files.mk>. 911 912SHLINKDIR Target directory for shared linker. See description of 913 <bsd.own.mk> for additional information about this variable. 914 915USE_LIBSTDCXX If "no", the support libraries needed for C++ programs 916 are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'. 917 Default: yes 918 919The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 920if it exists, as well as the include file <bsd.man.mk>. 921 922Some simple examples: 923 924To build foo from foo.c with a manual page foo.1, use: 925 926 PROG= foo 927 928 .include <bsd.prog.mk> 929 930To build foo from foo.c with a manual page foo.2, add the line: 931 932 MAN= foo.2 933 934If foo does not have a manual page at all, add the line: 935 936 MKMAN= no 937 938If foo has multiple source files, add the line: 939 940 SRCS= a.c b.c c.c d.c 941 942 943=-=-=-=-= bsd.rpc.mk =-=-=-=-= 944 945The include file <bsd.rpc.mk> contains a makefile fragment used to 946construct source files built by rpcgen. 947 948The following macros may be defined in makefiles which include 949<bsd.rpc.mk> in order to control which files get built and how they 950are to be built: 951 952RPC_INCS: construct .h file from .x file 953RPC_XDRFILES: construct _xdr.c from .x file 954 (for marshalling/unmarshalling data types) 955RPC_SVCFILES: construct _svc.c from .x file 956 (server-side stubs) 957RPC_SVCFLAGS: Additional flags passed to builds of RPC_SVCFILES. 958 959RPC_XDIR: Directory containing .x/.h files 960 961 962=-=-=-=-= bsd.shlib.mk =-=-=-=-= 963 964The include file <bsd.shlib.mk> computes parameters for shared library 965installation and use. It defines no targets. <bsd.own.mk> MUST be 966included before <bsd.shlib.mk>. 967 968<bsd.own.mk> sets the following variables, if they are not already defined 969(defaults are in brackets): 970 971SHLIBINSTALLDIR If ${USE_SHLIBDIR} is "yes", use ${SHLIBINSTALLDIR} instead of 972 ${LIBDIR} as the base path for shared library installation. 973 [/lib] 974 975SHLIBDIR The path to USE_SHLIBDIR shared libraries to use when building 976 a program. [/lib for programs in /bin and /sbin, /usr/lib 977 for all others.] 978 979_LIBSODIR Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is "yes", 980 otherwise set to ${LIBDIR} 981 982SHLINKINSTALLDIR Base path for shared linker. [/libexec] 983 984SHLINKDIR Path to use for shared linker when building a program. 985 [/libexec for programs in /bin and /sbin, /usr/libexec for 986 all others.] 987 988 989=-=-=-=-= bsd.subdir.mk =-=-=-=-= 990 991The include file <bsd.subdir.mk> contains the default targets for building 992subdirectories. It has the same eight targets as <bsd.prog.mk>: all, 993clean, cleandir, depend, includes, install, lint, and tags. For all of 994the directories listed in the variable SUBDIR, the specified directory 995will be visited and the target made. There is also a default target which 996allows the command "make subdir" where subdir is any directory listed in 997the variable SUBDIR. 998 999As a special case, the use of a token .WAIT as an entry in SUBDIR acts 1000as a synchronization barrier when multiple make jobs are run; subdirs 1001before the .WAIT must complete before any subdirs after .WAIT are 1002started. See make(1) for some caveats on use of .WAIT and other 1003special sources. 1004 1005 1006=-=-=-=-= bsd.sys.mk =-=-=-=-= 1007 1008The include file <bsd.sys.mk> is used by <bsd.prog.mk> and 1009<bsd.lib.mk>. It contains overrides that are used when building 1010the NetBSD source tree. 1011 1012The following variables control how various files are compiled/built. 1013(Note that these may be overridden in <bsd.own.mk> if USETOOLS=yes): 1014 1015AR Create, modify, and extract from archives. [ar] 1016 1017ARFLAGS Options to ${AR}. [rl] 1018 1019CC C compiler. [cc] 1020 1021CFLAGS Options to ${CC}. [Usually -O or -O2] 1022 1023CPP C Pre-Processor. [cpp] 1024 1025CPPFLAGS Options to ${CPP}. [] 1026 1027CPUFLAGS Optimization flags for ${CC} 1028 1029CXX C++ compiler. [c++] 1030 1031CXXFLAGS Options to ${CXX}. [${CFLAGS}] 1032 1033ELF2ECOFF Convert ELF-format executable to ECOFF. [elf2ecoff] 1034 1035FC Fortran compiler. [f77] 1036 1037FFLAGS Options to {$FC}. [-O] 1038 1039INSTALL install(1) command. [install] 1040 1041LEX Lexical analyzer. [lex] 1042 1043LFLAGS Options to ${LEX}. [] 1044 1045LD Linker. [ld] 1046 1047LDFLAGS Options to ${LD}. [] 1048 1049LINT C program verifier. [lint] 1050 1051LINTFLAGS Options to ${LINT}. [-chapbxzF] 1052 1053LORDER List dependencies for object files. [lorder] 1054 1055MAKE make(1). [make] 1056 1057MKDEP Construct Makefile dependency list. [mkdep] 1058 1059NM List symbols from object files. [nm] 1060 1061PC Pascal compiler. [pc] (Not present) 1062 1063PFLAGS Options to ${PC}. [] 1064 1065OBJC Objective C compiler. [${CC}] 1066 1067OBJCFLAGS Options to ${OBJC}. [${CFLAGS}] 1068 1069OBJCOPY Copy and translate object files. [objcopy] 1070 1071RANLIB Generate index to archive. [ranlib] 1072 1073SHELL Shell. [sh] 1074 1075SIZE List section sizes and total size. [size] 1076 1077STRIP Discard symbols from object files. [strip] 1078 1079TSORT Topological sort of a directed graph. [tsort -q] 1080 1081YACC LALR(1) parser generator. [yacc] 1082 1083YFLAGS Options to ${YACC}. [] 1084 1085YHEADER If defined, add "-d" to YFLAGS, and add dependencies 1086 from <file>.y to <file>.h and <file>.c, and add 1087 <foo>.h to CLEANFILES. 1088 1089YPREFIX If defined, add "-p ${YPREFIX}" to YFLAGS. 1090 1091 1092The following variables are defined to commands to perform the 1093appropriate operation, with the default in [brackets]. 1094(Note that these are overridden in <bsd.own.mk> if USETOOLS=yes): 1095 1096TOOL_ASN1_COMPILE ASN1 compiler. [asn1_compile] 1097 1098TOOL_CAP_MKDB Create capability database. [cap_mkdb] 1099 1100TOOL_CAT Concatenate and print files. [cat] 1101 1102TOOL_CKSUM Display file checksums. [cksum] 1103 1104TOOL_COMPILE_ET Error table compiler. [compile_et] 1105 1106TOOL_CONFIG Build kernel compilation directories. [config] 1107 1108TOOL_CRUNCHGEN Generate crunched binary build environment. [crunchgen] 1109 1110TOOL_CTAGS Create a tags file. [ctags] 1111 1112TOOL_DB Manipulate db(3) databases. [db] 1113 1114TOOL_EQN Format equations for groff. [eqn] 1115 1116TOOL_FGEN IEEE 1275 Open Firmware FCode Tokenizer. [fgen] 1117 1118TOOL_GENCAT Generate NLS message catalogs. [gencat] 1119 1120TOOL_GROFF Front end for groff document formatting system. [groff] 1121 1122TOOL_HEXDUMP Ascii, decimal, hexadecimal, octal dump. [hexdump] 1123 1124TOOL_INDXBIB Make bibliographic database's inverted index. [indxbib] 1125 1126TOOL_INSTALLBOOT Install disk bootstrap software. [installboot] 1127 1128TOOL_INSTALL_INFO Update info/dir entries. [install-info] 1129 1130TOOL_M4 M4 macro language processor. [m4] 1131 1132TOOL_MAKEFS Create file system image from directory tree. [makefs] 1133 1134TOOL_MAKEINFO Translate Texinfo documents. [makeinfo] 1135 1136TOOL_MAKEWHATIS Create a whatis.db database. [makewhatis] 1137 1138TOOL_MDSETIMAGE Set kernel RAM disk image. [mdsetimage] 1139 1140TOOL_MENUC Menu compiler. [menuc] 1141 1142TOOL_MKCSMAPPER Make charset mapping table. [mkcsmapper] 1143 1144TOOL_MKESDB Make encoding scheme database. [mkesdb] 1145 1146TOOL_MKLOCALE Make LC_CTYPE locale files. [mklocale] 1147 1148TOOL_MKMAGIC Create database for file(1). [file] 1149 1150TOOL_MKTEMP Make (unique) temporary file name. [mktemp] 1151 1152TOOL_MSGC Simple message list compiler. [msgc] 1153 1154TOOL_MTREE Map a directory hierarchy. [mtree] 1155 1156TOOL_PAX Manipulate file archives and copy directories. [pax] 1157 1158TOOL_PIC Compile pictures for groff. [pic] 1159 1160TOOL_PREPMKBOOTIMAGE prep-mkbootimage (XXXBUILDSH). [prep-mkbootimage] 1161 1162TOOL_PWD_MKDB Generate the password databases. [pwd_mkdb] 1163 1164TOOL_REFER Preprocess bibliographic references for groff. [refer] 1165 1166TOOL_ROFF_ASCII Generate ASCII groff output. [nroff] 1167 1168TOOL_ROFF_DVI Generate DVI groff output. [${TOOL_GROFF} -Tdvi] 1169 1170TOOL_ROFF_HTML Generate HTML groff output. 1171 [${TOOL_GROFF} -Tlatin1 -mdoc2html] 1172 1173TOOL_ROFF_PS Generate PS groff output. [${TOOL_GROFF} -Tps] 1174 1175TOOL_ROFF_RAW Generate "raw" groff output. [${TOOL_GROFF} -Z] 1176 1177TOOL_RPCGEN Remote Procedure Call (RPC) protocol compiler. [rpcgen] 1178 1179TOOL_SOELIM Eliminate .so's from groff input. [soelim] 1180 1181TOOL_STAT Display file status. [stat] 1182 1183TOOL_SUNLABEL Read or modify a SunOS disk label. [sunlabel] 1184 1185TOOL_TBL Format tables for groff. [tbl] 1186 1187TOOL_UUDECODE Uudecode a binary file. [uudecode] 1188 1189TOOL_VGRIND Grind nice listings of programs. [vgrind -f] 1190 1191TOOL_ZIC Time zone compiler. [zic] 1192 1193 1194Other variables of note (incomplete list): 1195 1196WARNS Crank up gcc warning options; the distinct levels are: 1197 WARNS=1 1198 WARNS=2 1199 WARNS=3 1200 1201FORMAT_AUDIT If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on 1202WFORMAT -Wnetbsd-format-audit for extra-stringent format checking. 1203 WFORMAT belongs in individual makefiles and/or 1204 Makefile.inc files. (set WFORMAT=1 in individual 1205 makefiles if a program is not security critical and is 1206 doing bizarre things with format strings which would 1207 be even uglier if rewritten) FORMAT_AUDIT should go in 1208 mk.conf if you're doing format-string auditing. 1209 FORMAT_AUDIT may go away in time. 1210 1211=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1212