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