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