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