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