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