1# $NetBSD: bsd.README,v 1.107 2002/11/26 23:15: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' by a user to disable functionality. 65 Defaults to `yes' (or usually does) 66 67NOxxx If defined, disables a feature. Not intended for users, 68 it's to allow Makefiles to disable functionality that 69 they don't support (such as missing man pages). 70 NOxxx variables must be defined before <bsd.own.mk> 71 is included. 72 73The following variables that control how things are made/installed that 74are not set by default. These should not be set by Makefiles; they're for 75the user to define in MAKECONF (see bsd.own.mk, below) or on the make(1) 76command line: 77 78BUILD If defined, 'make install' checks that the targets in the 79 source directories are up-to-date and remakes them if they 80 are out of date, instead of blindly trying to install 81 out of date or non-existent targets. 82 83UPDATE If defined, 'make install' only installs targets that are 84 more recently modified in the source directories that their 85 installed counterparts. 86 87UNPRIVED If defined, don't set the owner/group/mode when installing 88 files or directories, and keep a metadata log of what 89 the owner/group/mode should be. This allows a 90 non-root "make install". 91 92MKBFD If "no", don't build libbfd, libiberty, or any of 93 the things that depend on them (binutils/gas/ld, 94 gdb, dbsym, mdsetimage). 95 96MKCATPAGES If "no", don't build or install the catman pages. 97 98MKDOC If "no", don't build or install the documentation. 99 100MKDYNAMICROOT If "no", build programs in /bin and /sbin statically, 101 don't install certain libraries in /lib, and don't 102 install the shared linker into /libexec. 103 104MKGDB If "no", don't build gdb. 105 106MKGCC If "no", don't build gcc or any of the gcc-related 107 libraries (libg2c, libgcc, libobjc, libstdc++). 108 109MKIEEEFP If "no", don't add code for IEEE754/IEC60559 conformance. 110 Has no effect on most platforms. 111 112MKINFO If "no", don't build or install Info documentation from 113 Texinfo source files. 114 115MKLINT If "no", don't build or install the lint libraries. 116 117MKMAN If "no", don't build or install the man or catman pages. 118 Also acts as "MKCATPAGES=no" 119 120MKNLS If "no", don't build or install the NLS files and locale 121 definition files. 122 123MKOBJ If "no", don't enable the rule which creates objdirs. 124 "yes" by default. 125 126MKOBJDIRS If "no", don't create objdirs during a "make build". 127 "no" by default. 128 129MKPIC If "no", don't build or install shared libraries. 130 131MKPICINSTALL If "no", don't install the *_pic.a libraries. 132 133MKPROFILE If "no", don't build or install the profiling libraries. 134 135MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKINFO=no MKMAN=no 136 MKNLS=no". I.e, don't build catman pages, documentation, 137 Info documentation, man pages, NLS files, ... 138 139=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 140 141The include file <sys.mk> has the default rules for all makes, in the BSD 142environment or otherwise. You probably don't want to touch this file. 143If you intend to run a cross build, you will need to supply the following 144host tools, and configure the following variables properly: 145 146OBJCOPY objcopy - copy and translate object files 147 148STRIP strip - Discard symbols from object files 149 150CONFIG config - build kernel compilation directories 151 152RPCGEN rpcgen - Remote Procedure Call (RPC) protocol compiler 153 154MKLOCALE mklocale - make LC_CTYPE locale files 155 156MTREE mtree - build directory tree from a spec file 157 158=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 159 160The include file <bsd.man.mk> handles installing manual pages and their 161links. 162 163It has a two targets: 164 165 maninstall: 166 Install the manual page sources and their links. 167 catinstall: 168 Install the preformatted manual pages and their links. 169 170It sets/uses the following variables: 171 172MANDIR Base path for manual installation. 173 174MANGRP Manual group. 175 176MANOWN Manual owner. 177 178MANMODE Manual mode. 179 180MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 181 or "/tahoe" for machine specific manual pages. 182 183MAN The manual pages to be installed (use a .1 - .9 suffix). 184 185MLINKS List of manual page links (using a .1 - .9 suffix). The 186 linked-to file must come first, the linked file second, 187 and there may be multiple pairs. The files are soft-linked. 188 189The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 190it exists. 191 192=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 193 194The include file <bsd.own.mk> contains source tree configuration parameters, 195such as the owners, groups, etc. for both manual pages and binaries, and 196a few global "feature configuration" parameters. 197 198It has no targets. 199 200To get system-specific configuration parameters, bsd.own.mk will try to 201include the file specified by the "MAKECONF" variable. If MAKECONF is not 202set, or no such file exists, the system make configuration file, /etc/mk.conf 203is included. These files may define any of the variables described below. 204 205bsd.own.mk sets the following variables, if they are not already defined 206(defaults are in brackets): 207 208NETBSDSRCDIR Top of the NetBSD source tree. 209 If _SRC_TOP_ != "", that will be used as the default, 210 otherwise BSDSRCDIR will be used as the default. 211 Various makefiles within the NetBSD source tree will 212 use this to reference the top level of the source tree. 213 214_SRC_TOP_ Top of the system source tree, as determined by <bsd.own.mk> 215 based on the presence of tools/ and build.sh. This variable 216 is "internal" to <bsd.own.mk>, although its value is only 217 determined once and then propagated to all sub-makes. 218 219BSDSRCDIR The real path to the system sources, so that 'make obj' 220 will work correctly. [/usr/src] 221 222BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' 223 will work correctly. [/usr/obj] 224 225BINGRP Binary group. [wheel] 226 227BINOWN Binary owner. [root] 228 229BINMODE Binary mode. [555] 230 231NONBINMODE Mode for non-executable files. [444] 232 233MANDIR Base path for manual installation. [/usr/share/man/cat] 234 235MANGRP Manual group. [wheel] 236 237MANOWN Manual owner. [root] 238 239MANMODE Manual mode. [${NONBINMODE}] 240 241MANINSTALL Manual installation type: maninstall, catinstall, or both 242 243LDSTATIC Control program linking; if set blank, link everything 244 dynamically. If set to "-static", link everything statically. 245 If not set, programs link according to their makefile. 246 247LIBDIR Base path for library installation. [/usr/lib] 248 249LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] 250 251LIBGRP Library group. [${BINGRP}] 252 253LIBOWN Library owner. [${BINOWN}] 254 255LIBMODE Library mode. [${NONBINMODE}] 256 257DOCDIR Base path for system documentation (e.g. PSD, USD, etc.) 258 installation. [/usr/share/doc] 259 260HTMLDOCDIR Base path for html system documentation installation. 261 [/usr/share/doc/html] 262 263DOCGRP Documentation group. [wheel] 264 265DOCOWN Documentation owner. [root] 266 267DOCMODE Documentation mode. [${NONBINMODE}] 268 269NLSDIR Base path for Native Language Support files installation. 270 [/usr/share/nls] 271 272NLSGRP Native Language Support files group. [wheel] 273 274NLSOWN Native Language Support files owner. [root] 275 276NLSMODE Native Language Support files mode. [${NONBINMODE}] 277 278STRIPFLAG The flag passed to the install program to cause the binary 279 to be stripped. This is to be used when building your 280 own install script so that the entire system can be made 281 stripped/not-stripped using a single knob. [-s] 282 283COPY The flag passed to the install program to cause the binary 284 to be copied rather than moved. This is to be used when 285 building our own install script so that the entire system 286 can either be installed with copies, or with moves using 287 a single knob. [-c] 288 289Additionally, the following variables may be set by bsd.own.mk or in a 290make configuration file to modify the behaviour of the system build 291process (default values are in brackets along with comments, if set by 292bsd.own.mk): 293 294MKCRYPTO If set to "no", no cryptography support will be built 295 into the system. Defaults to "yes". 296 297MKCRYPTO_IDEA If set to "yes", IDEA support will be built into 298 libcrypto_idea.a. Defaults to "no". 299 300MKCRYPTO_MDC2 If set to "yes", MDC2 support will be built into 301 libcrypto_mdc2.a. Defaults to "no". 302 303MKCRYPTO_RC5 If set to "yes", RC5 support will be built into 304 libcrypto_rc5.a. Defaults to "no". 305 306MKHESIOD If set to "no", disables building of Hesiod infrastructure 307 (libraries and support programs). 308 309MKKERBEROS If set to "no", disables building of Kerberos (v4 or v5) 310 infrastructure (libraries and support programs). 311 312MKSKEY If set to "no", disables building of S/key authentication 313 infrastructure (libraries and support programs). 314 315MKYP If set to "no", disables building of YP (NIS) 316 infrastructure (libraries and support programs). 317 318USE_HESIOD If set to "no", disables building Hesiod support into 319 various system utilities/libraries that support it. 320 If MKHESIOD is set to "no", USE_HESIOD will also be 321 forced to "no". 322 323USE_KERBEROS If set to "no", disables building Kerberos (v4 or v5) 324 support into various system utilities/libraries that 325 support it. If MKKERBEROS is set to "no", USE_KERBEROS 326 will also be forced to "no". 327 328USE_SKEY If set to "no", disables building S/key authentication 329 support into various system utilities/libraries that 330 support it. If MKSKEY is set to "no", USE_SKEY will 331 also be forced to "no". 332 333USE_YP If set to "no", disables building YP (NIS) support into 334 various system utilities/libraries that support it. If 335 MKYP is set to "no", USE_YP will also be forced to "no". 336 337MANZ Compress manual pages at installation time. 338 339NOPROFILE Do not build profiled versions of system libraries 340 341NOPIC Do not build PIC versions of system libraries, and 342 do not build shared libraries. [set if ${MACHINE_ARCH} 343 is "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.] 344 345NOLINT Do not build lint libraries. 346 347OBJECT_FMT Object file format. [set to "ELF" on architectures that 348 use ELF -- currently if ${MACHINE_ARCH} is "alpha", 349 "mipsel", "mipseb", "powerpc", "sparc", "sparc64", 350 "i386" and some m68k machines, or set to "a.out" on 351 other architectures]. 352 353MKSOFTFLOAT If "yes", build with options to enable the compiler to 354 generate output containing library calls for floating 355 point and possibly soft-float library support. Defaults 356 to "no". 357 358TOOLCHAIN_MISSING 359 If "yes", this indicates that the platform being built 360 does not have a working in-tree toolchain. If the 361 MACHINE_ARCH in question falls into this category, the 362 variable is conditionally assigned the value "yes". 363 Otherwise, the variable is unconditionally assigned the 364 value "no". 365 366 If TOOLCHAIN_MISSING is "yes", the variables MKBFD, MKGCC, 367 and MKGDB are unconditionally assigned the value "no". 368 369EXTERNAL_TOOLCHAIN 370 This variable is not directly set by <bsd.own.mk>, but 371 including <bsd.own.mk> is the canonical way to gain 372 access to this variable. The variable should be defined 373 either in the user's environment or in the user's mk.conf 374 file. If defined, this variable indicates the root of 375 an external toolchain which will be used to build the 376 tree. For example, if a platform is a TOOLCHAIN_MISSING 377 platform, EXTERNAL_TOOLCHAIN can be used to re-enable the 378 cross-compile framework. 379 380 If EXTERNAL_TOOLCHAIN is defined, the variable MKGCC is 381 unconditionally assigned the value "no", since the external 382 version of the compiler may not be able to build the library 383 components of the in-tree compiler. 384 385 NOTE: This variable is not yet used in as many places as 386 it should be. Expect the exact semantics of this variable 387 to change in the short term as parts of the cross-compile 388 framework continue to be cleaned up. 389 390bsd.own.mk is generally useful when building your own Makefiles so that 391they use the same default owners etc. as the rest of the tree. 392 393=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 394 395The include file <bsd.shlib.mk> computes parameters for shared library 396installation and use. It defines no targets. <bsd.own.mk> MUST be 397included before bsd.shlib.mk. 398 399bsd.own.mk sets the following variables, if they are not already defined 400(defaults are in brackets): 401 402SHLIBINSTALLDIR If ${USE_SHLIBDIR} is "yes", use ${SHLIBINSTALLDIR} instead of 403 ${LIBDIR} as the base path for shared library installation. 404 [/lib] 405 406SHLIBDIR The path to USE_SHLIBDIR shared libraries to use when building 407 a program. [/lib for programs in /bin and /sbin, /usr/lib 408 for all others.] 409 410_LIBSODIR Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is "yes", 411 otherwise set to ${LIBDIR} 412 413SHLINKINSTALLDIR Base path for shared linker. [/libexec] 414 415SHLINKDIR Path to use for shared linker when building a program. 416 [/libexec for programs in /bin and /sbin, /usr/libexec for 417 all others.] 418 419=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 420 421The include file <bsd.prog.mk> handles building programs from one or 422more source files, along with their manual pages. It has a limited number 423of suffixes, consistent with the current needs of the BSD tree. bsd.prog.mk 424includes <bsd.shlib.mk> to get shared library parameters. 425 426It has eight targets: 427 428 all: 429 build the program and its manual page. This also 430 creates a GDB initialization file (.gdbinit) in 431 the objdir. The .gdbinit file sets the shared library 432 prefix to ${DESTDIR} to facilitate cross-debugging. 433 clean: 434 remove the program, any object files and the files a.out, 435 Errs, errs, mklog, and ${PROG}.core. 436 cleandir: 437 remove all of the files removed by the target clean, as 438 well as .depend, tags, and any manual pages. 439 `distclean' is a synonym for `cleandir'. 440 depend: 441 make the dependencies for the source files, and store 442 them in the file .depend. 443 includes: 444 install any header files. 445 install: 446 install the program and its manual pages; if the Makefile 447 does not itself define the target install, the targets 448 beforeinstall and afterinstall may also be used to cause 449 actions immediately before and after the install target 450 is executed. 451 lint: 452 run lint on the source files 453 tags: 454 create a tags file for the source files. 455 456It sets/uses the following variables: 457 458BINGRP Binary group. 459 460BINOWN Binary owner. 461 462BINMODE Binary mode. 463 464CLEANFILES Additional files to remove for the clean and cleandir targets. 465 466COPTS Additional flags to the compiler when creating C objects. 467 468CPPFLAGS Additional flags to the C pre-processor 469 470GDBINIT List of GDB initialization files to add to "source" 471 directives in the .gdbinit file that is created in the 472 objdir. 473 474LDADD Additional loader objects. Usually used for libraries. 475 For example, to load with the compatibility and utility 476 libraries, use: 477 478 LDADD+=-lutil -lcompat 479 480LDFLAGS Additional loader flags. 481 482LINKS The list of binary links; should be full pathnames, the 483 linked-to file coming first, followed by the linked 484 file. The files are hard-linked. For example, to link 485 /bin/test and /bin/[, use: 486 487 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 488 489SYMLINKS The list of symbolic links; should be full pathnames. 490 Syntax is identical to LINKS. Note that DESTDIR is not 491 automatically included in the link. 492 493MAN Manual pages (should end in .1 - .9). If no MAN variable is 494 defined, "MAN=${PROG}.1" is assumed. 495 496PROG The name of the program to build. If not supplied, nothing 497 is built. 498 499PROG_CXX If defined, the name of the program to build. Also 500 causes <bsd.prog.mk> to link the program with the C++ 501 compiler rather than the C compiler. PROG_CXX overrides 502 the value of PROG if PROG is also set. 503 504PROGNAME The name that the above program will be installed as, if 505 different from ${PROG}. 506 507SRCS List of source files to build the program. If SRCS is not 508 defined, it's assumed to be ${PROG}.c. 509 510DPADD Additional dependencies for the program. Usually used for 511 libraries. For example, to depend on the compatibility and 512 utility libraries use: 513 514 DPADD+=${LIBCOMPAT} ${LIBUTIL} 515 516 The following libraries are predefined for DPADD: 517 518 LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 519 LIBBZ2?= ${DESTDIR}/usr/lib/libbz2.a 520 LIBC?= ${DESTDIR}/usr/lib/libc.a 521 LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 522 LIBCDK?= ${DESTDIR}/usr/lib/libcdk.a 523 LIBCOM_ERR?= ${DESTDIR}/usr/lib/libcom_err.a 524 LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 525 LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 526 LIBCRYPTO?= ${DESTDIR}/usr/lib/libcrypto.a 527 LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a 528 LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a 529 LIBCRYPTO_RC5?= ${DESTDIR}/usr/lib/libcrypto_rc5.a 530 LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 531 LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 532 LIBDES?= ${DESTDIR}/usr/lib/libdes.a 533 LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 534 LIBFORM?= ${DESTDIR}/usr/lib/libform.a 535 LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 536 LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 537 LIBGSSAPI?= ${DESTDIR}/usr/lib/libgssapi.a 538 LIBHDB?= ${DESTDIR}/usr/lib/libhdb.a 539 LIBINTL?= ${DESTDIR}/usr/lib/libintl.a 540 LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a 541 LIBKADM?= ${DESTDIR}/usr/lib/libkadm.a 542 LIBKADM5CLNT?= ${DESTDIR}/usr/lib/libkadm5clnt.a 543 LIBKADM5SRV?= ${DESTDIR}/usr/lib/libkadm5srv.a 544 LIBKAFS?= ${DESTDIR}/usr/lib/libkafs.a 545 LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a 546 LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a 547 LIBKRB5?= ${DESTDIR}/usr/lib/libkrb5.a 548 LIBKSTREAM?= ${DESTDIR}/usr/lib/libkstream.a 549 LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 550 LIBL?= ${DESTDIR}/usr/lib/libl.a 551 LIBM?= ${DESTDIR}/usr/lib/libm.a 552 LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a 553 LIBMP?= ${DESTDIR}/usr/lib/libmp.a 554 LIBNTP?= ${DESTDIR}/usr/lib/libntp.a 555 LIBOBJC?= ${DESTDIR}/usr/lib/libobjc.a 556 LIBOSSAUDIO?= ${DESTDIR}/usr/lib/libossaudio.a 557 LIBPC?= ${DESTDIR}/usr/lib/libpc.a 558 LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 559 LIBPCI?= ${DESTDIR}/usr/lib/libpci.a 560 LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a 561 LIBPMC?= ${DESTDIR}/usr/lib/libpmc.a 562 LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a 563 LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 564 LIBRMT?= ${DESTDIR}/usr/lib/librmt.a 565 LIBROKEN?= ${DESTDIR}/usr/lib/libroken.a 566 LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 567 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 568 LIBSS?= ${DESTDIR}/usr/lib/libss.a 569 LIBSSL?= ${DESTDIR}/usr/lib/libssl.a 570 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 571 LIBSL?= ${DESTDIR}/usr/lib/libsl.a 572 LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a 573 LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a 574 LIBUSBHID?= ${DESTDIR}/usr/lib/libusbhid.a 575 LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 576 LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 577 LIBY?= ${DESTDIR}/usr/lib/liby.a 578 LIBZ?= ${DESTDIR}/usr/lib/libz.a 579 580SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 581 strings, using xstr(1). Note that this will not work with 582 parallel makes. 583 584STRIPFLAG The flag passed to the install program to cause the binary 585 to be stripped. 586 587SUBDIR A list of subdirectories that should be built as well. 588 Each of the targets will execute the same target in the 589 subdirectories. 590 591SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 592 These are installed exactly like programs. 593 594SCRIPTSNAME The name that the above program will be installed as, if 595 different from ${SCRIPTS}. These can be further specialized 596 by setting SCRIPTSNAME_<script>. 597 598FILES A list of files to install. The installation is controlled 599 by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR 600 variables that can be further specialized by FILES<VAR>_<file> 601 602SHLINKDIR Target directory for shared linker. See description of 603 <bsd.own.mk> for additional information about this variable. 604 605The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 606if it exists, as well as the include file <bsd.man.mk>. 607 608Some simple examples: 609 610To build foo from foo.c with a manual page foo.1, use: 611 612 PROG= foo 613 614 .include <bsd.prog.mk> 615 616To build foo from foo.c with a manual page foo.2, add the line: 617 618 MAN= foo.2 619 620If foo does not have a manual page at all, add the line: 621 622 MKMAN= no 623 624If foo has multiple source files, add the line: 625 626 SRCS= a.c b.c c.c d.c 627 628=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 629 630The include file <bsd.subdir.mk> contains the default targets for building 631subdirectories. It has the same eight targets as <bsd.prog.mk>: all, 632clean, cleandir, depend, includes, install, lint, and tags. For all of 633the directories listed in the variable SUBDIR, the specified directory 634will be visited and the target made. There is also a default target which 635allows the command "make subdir" where subdir is any directory listed in 636the variable SUBDIR. 637 638As a special case, the use of a token .WAIT as an entry in SUBDIR acts 639as a synchronization barrier when multiple make jobs are run; subdirs 640before the .WAIT must complete before any subdirs after .WAIT are 641started. See make(1) for some caveats on use of .WAIT and other 642special sources. 643 644=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 645 646The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 647and is included from from bsd.lib.mk and bsd.prog.mk. 648 649=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 650 651The include file <bsd.files.mk> handles the FILES variables and is included 652from bsd.lib.mk and bsd.prog.mk. 653 654=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 655 656The include file <bsd.inc.mk> defines the includes target and uses two 657variables: 658 659INCS The list of include files 660 661INCSDIR The location to install the include files. 662 663INCSNAME Target name of the include file, if only one; same as 664 FILESNAME, but for include files. 665 666INCSNAME_<file> The name file <file> should be installed as, if not <file>, 667 same as FILESNAME_<file>, but for include files. 668 669=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 670 671The include file <bsd.kinc.mk> defines the many targets (includes, 672subdirectories, etc.), and is used by kernel makefiles to handle 673include file installation. It is intended to be included alone, by 674kernel Makefiles. Please see bsd.kinc.mk for more details, and keep 675the documentation in that file up to date. 676 677=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 678 679The include file <bsd.info.mk> is used to generate and install GNU Info 680documentation from respective Texinfo source files. It defines three 681implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the 682following variables: 683 684TEXINFO List of Texinfo source files. Info documentation will 685 consist of single files with the extension replaced by 686 .info. 687 688INFOFLAGS Flags to pass to makeinfo. [] 689 690INSTALL_INFO Name of install-info program. [install-info] 691 692MAKEINFO Name of makeinfo program. [makeinfo] 693 694=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 695 696The include file <bsd.sys.mk> is used by <bsd.prog.mk> and 697<bsd.lib.mk>. It contains overrides that are used when building 698the NetBSD source tree. For instance, if "PARALLEL" is defined by 699the program/library Makefile, it includes a set of rules for lex and 700yacc that allow multiple lex and yacc targets to be built in parallel. 701 702Other variables of note (incomplete list): 703 704WARNS Crank up gcc warning options; the distinct levels are: 705 WARNS=1 706 WARNS=2 707 WARNS=3 708 709FORMAT_AUDIT If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on 710WFORMAT -Wnetbsd-format-audit for extra-stringent format checking. 711 WFORMAT belongs in individual makefiles and/or 712 Makefile.inc files. (set WFORMAT=1 in individual 713 makefiles if a program is not security critical and is 714 doing bizarre things with format strings which would 715 be even uglier if rewritten) FORMAT_AUDIT should go in 716 mk.conf if you're doing format-string auditing. 717 FORMAT_AUDIT may go away in time. 718 719=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 720 721The include file <bsd.lib.mk> has support for building libraries. It has 722the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 723includes, install, lint, and tags. Additionally, it has a checkver target 724which checks for installed shared object libraries whose version is greater 725that the version of the source. It has a limited number of suffixes, 726consistent with the current needs of the BSD tree. bsd.lib.mk includes 727<bsd.shlib.mk> to get shared library parameters. 728 729It sets/uses the following variables: 730 731LIB The name of the library to build. 732 733LIBDIR Target directory for libraries. 734 735SHLIBINSTALLDIR Target directory for shared libraries if ${USE_SHLIBDIR} 736 is "yes". 737 738USE_SHLIBDIR If "yes", use ${SHLIBINSTALLDIR} instead of ${LIBDIR} 739 as the path to install shared libraries to. 740 USE_SHLIBDIR must be defined before <bsd.own.mk> is included. 741 742LINTLIBDIR Target directory for lint libraries. 743 744LIBGRP Library group. 745 746LIBOWN Library owner. 747 748LIBMODE Library mode. 749 750LDADD Additional loader objects. 751 752MAN The manual pages to be installed (use a .1 - .9 suffix). 753 754MKLINKLIB If "no", act as "MKPICINSTALL=no MKPROFILE=no". 755 Also: 756 - don't install the .a libraries 757 - don't install _pic.a libraries on PIC systems 758 - don't build .a libraries on PIC systems 759 - don't install the .so symlink on ELF systems 760 I.e, only install the shared library (and the .so.major 761 symlink on ELF). 762 763MKPICLIB If "no", don't build _pic.a libraries, and build the 764 shared object libraries from the .a libraries. A 765 symlink is installed in ${DESTDIR}/usr/lib for the 766 _pic.a library pointing to the .a library. 767 768NOCHECKVER_<library> 769NOCHECKVER If set, disables checking for installed shared object 770 libraries with versions greater than the source. A 771 particular library name, without the "lib" prefix, may 772 be appended to the variable name to disable the check for 773 only that library. 774 775SRCS List of source files to build the library. Suffix types 776 .s, .c, and .f are supported. Note, .s files are preferred 777 to .c files of the same name. (This is not the default for 778 versions of make.) 779 780The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 781if it exists, as well as the include file <bsd.man.mk>. 782 783It has rules for building profiled objects; profiled libraries are 784built by default. 785 786Libraries are ranlib'd when made. 787 788=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 789 790The include file <bsd.obj.mk> defines targets related to the creation 791and use of separated object and source directories. 792 793If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses 794${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if 795it exists. Otherwise make(1) looks for the existence of a 796subdirectory (or a symlink to a directory) of the source directory 797into which built targets should be placed. If an environment variable 798named MAKEOBJDIR is set, make(1) uses its value as the name of the 799object directory; failing that, make first looks for a subdirectory 800named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj". 801 802Object directories are not created automatically by make(1) if they 803don't exist; you need to run a separate "make obj". (This will happen 804during a top-level build if "MKOBJDIRS" is set to a value other than 805"no"). When the source directory is a subdirectory of ${BSDSRCDIR} -- 806and this is determined by a simple string prefix comparison -- object 807directories are created in a separate object directory tree, and a 808symlink to the object directory in that tree is created in the source 809directory; otherwise, "make obj" assumes that you're not in the main 810source tree and that it's not safe to use a separate object tree. 811 812Several variables used by <bsd.obj.mk> control exactly what 813directories and links get created during a "make obj": 814 815MAKEOBJDIR If set, this is the component name of the object 816 directory. 817 818OBJMACHINE If this is set but MAKEOBJDIR is not set, creates 819 object directories or links named "obj.${MACHINE}"; 820 otherwise, just creates ones named "obj". 821 822USR_OBJMACHINE If set, and the current directory is a subdirectory of 823 ${BSDSRCDIR}, create object directory in the 824 corresponding subdirectory of ${BSDOBJDIR}.${MACHINE}; 825 otherwise, create it in the corresponding subdirectory 826 of ${BSDOBJDIR} 827 828BUILDID If set, the contents of this variable are appended 829 to the object directory name. If OBJMACHINE is also 830 set, ".${BUILDID}" is added after ".${MACHINE}". 831 832=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 833 834The include file <bsd.kernobj.mk> defines variables related to the 835location of kernel sources and object directories. 836 837KERNSRCDIR Is the location of the top of the kernel src. 838 It defaults to ${_SRC_TOP_}/sys 839 840KERNARCHDIR Is the location of the machine dependent kernel 841 sources. It defaults to arch/${MACHINE} 842 843KERNCONFDIR Is where the configuration files for kernels are 844 found; default is ${KERNSRCDIR}/${KERNARCHDIR}/conf. 845 846KERNOBJDIR Is the kernel build directory. The kernel GENERIC for 847 instance will be compiled in ${KERNOBJDIR}/GENERIC. 848 The default value is 849 ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile 850 if it exists or the target 'obj' is being made. 851 Otherwise the default is 852 ${KERNSRCDIR}/${KERNARCHDIR}/compile. 853 854It is important that Makefiles (such as those under src/distrib) that 855wish to find compiled kernels use bsd.kernobj.mk and ${KERNOBJDIR} 856rather than make assumptions about the location of the compiled kernel. 857 858=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 859