[BACK]Return to bsd.README CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / share / mk

Annotation of src/share/mk/bsd.README, Revision 1.374

1.374   ! wiz         1: #      $NetBSD: bsd.README,v 1.373 2018/06/02 01:41:49 christos Exp $
1.24      mikel       2: #      @(#)bsd.README  8.2 (Berkeley) 4/2/94
1.1       cgd         3:
1.213     lukem       4: This is the README file for the make "include" files for the NetBSD
                      5: source tree.  The files are installed in /usr/share/mk, and are,
                      6: by convention, named with the suffix ".mk".
1.1       cgd         7:
                      8: Note, this file is not intended to replace reading through the .mk
                      9: files for anything tricky.
                     10:
                     11: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
                     12:
                     13: RANDOM THINGS WORTH KNOWING:
                     14:
                     15: The files are simply C-style #include files, and pretty much behave like
                     16: you'd expect.  The syntax is slightly different in that a single '.' is
                     17: used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
                     18:
                     19: One difference that will save you lots of debugging time is that inclusion
                     20: of the file is normally done at the *end* of the Makefile.  The reason for
                     21: this is because .mk files often modify variables and behavior based on the
                     22: values of variables set in the Makefile.  To make this work, remember that
                     23: the 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:
                     30: the command "make a" will echo "a".  To make things confusing, the SECOND
                     31: variable 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:
                     39: the command "make b" will echo "bar".  This is for compatibility with the
                     40: way the V7 make behaved.
                     41:
                     42: It's fairly difficult to make the BSD .mk files work when you're building
1.75      agc        43: multiple programs in a single directory.  It's a lot easier to split up the
1.1       cgd        44: programs than to deal with the problem.  Most of the agony comes from making
1.36      ross       45: the "obj" directory stuff work right, not because we switched to a new version
1.1       cgd        46: of make.  So, don't get mad at us, figure out a better way to handle multiple
                     47: architectures so we can quit using the symbolic link stuff.  (Imake doesn't
                     48: count.)
                     49:
                     50: The file .depend in the source directory is expected to contain dependencies
                     51: for the source files.  This file is read automatically by make after reading
                     52: the Makefile.
                     53:
                     54: The variable DESTDIR works as before.  It's not set anywhere but will change
                     55: the tree where the file gets installed.
                     56:
                     57: The profiled libraries are no longer built in a different directory than
                     58: the regular libraries.  A new suffix, ".po", is used to denote a profiled
1.265     njoly      59: object, and ".pico" denotes a shared (position-independent) object.
1.97      itojun     60:
1.142     lukem      61: There are various make variables used during the build.
                     62:
                     63: Many variables support a (case sensitive) value of "no" or "yes",
                     64: and are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
                     65:
                     66:
1.172     hubertf    67: The basic rule for the variable naming scheme is as follows:
                     68:
1.231     apb        69: HOST_xxx       A command that runs on the host machine regardless of
                     70:                whether or not the system is being cross compiled, or
                     71:                flags for such a command.
                     72:
1.172     hubertf    73: MKxxx          Can be set to "no" to disable functionality, or
                     74:                "yes" to enable it.
                     75:                Usually defaults to "yes", although some variables
                     76:                default to "no".
                     77:                Due to make(1) implementation issues, if a temporary
1.224     lukem      78:                command-line override of a mk.conf(5) or <bsd.own.mk>
1.214     wiz        79:                setting is required whilst still honoring a particular
1.172     hubertf    80:                Makefile's setting of MKxxx, use
                     81:                        env MKxxx=value make
                     82:                instead of
                     83:                        make MKxxx=value
                     84:
                     85: NOxxx          If defined, disables a feature.
                     86:                Not intended for users.
                     87:                This is to allow Makefiles to disable functionality
                     88:                that they don't support (such as missing man pages).
                     89:                NOxxx variables must be defined before <bsd.own.mk>
                     90:                is included.
                     91:
1.231     apb        92: TOOL_xxx       A tool that is provided as part of the USETOOLS
                     93:                framework.  When not using the USETOOLS framework,
                     94:                TOOL_xxx variables should refer to tools that are
                     95:                already installed on the host system.
                     96:
1.172     hubertf    97: The following variables that control how things are made/installed that
                     98: are not set by default. These should not be set by Makefiles; they're for
1.224     lukem      99: the user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
                    100: or on the make(1) command line:
1.172     hubertf   101:
                    102: BUILD          If defined, 'make install' checks that the targets in the
                    103:                source directories are up-to-date and remakes them if they
                    104:                 are out of date, instead of blindly trying to install
                    105:                 out of date or non-existent targets.
                    106:
                    107: MAKEVERBOSE    Control how "verbose" the standard make(1) rules are.
                    108:                Default: 2
                    109:                Supported values:
                    110:                    0   Minimal output ("quiet")
                    111:                    1   Describe what is occurring
                    112:                    2   Describe what is occurring and echo the actual command
1.241     apb       113:                    3   Ignore the effect of the "@" prefix in make commands
                    114:                    4   Trace shell commands using the shell's -x flag
1.172     hubertf   115:
1.312     jmmv      116: MKATF          If "no", don't build the Automated Testing Framework (ATF),
                    117:                which includes the libatf-c, libatf-c++ and libatf-sh libraries
                    118:                and the various command line tools.  Also, because the build of
                    119:                the libraries is disabled, don't build the NetBSD test suite
                    120:                either.
1.210     gmcgarry  121:                Default: yes
                    122:
1.252     skrll     123: MKBFD          Obsolete, use MKBINUTILS
                    124:
1.266     joerg     125: MKBINUTILS     If "no", don't build binutils (gas, ld, etc and libbfd,
                    126:                libopcodes)
1.172     hubertf   127:                Default: yes
                    128:
1.266     joerg     129: MKBSDTAR       If "yes", use the libarchive based cpio and tar instead of
                    130:                the pax frontends.
                    131:                Default: no
                    132:
1.172     hubertf   133: MKCATPAGES     If "no", don't build or install the catman pages.
1.292     joerg     134:                Default: no
1.172     hubertf   135:
1.234     mrg       136: MKCOMPAT       If "no", don't build or install the src/compat.
1.303     jkoshy    137:                Default: yes on amd64/mips64/sparc64, no elsewhere.
1.234     mrg       138:
1.344     matt      139: MKCOMPATTESTS          If "yes", build and install the NetBSD test suite when
                    140:                building and installing src/compat.
                    141:                Default: no
                    142:
1.345     matt      143: MKCOMPATX11    If "yes", build and install the X11 libraries when
                    144:                building and installing src/compat.
                    145:                Default: no
                    146:
1.210     gmcgarry  147: MKCOMPLEX      If "no", don't build libm support for <complex.h>
                    148:                Default: yes
                    149:
1.329     ozaki-r   150: MKCTF          If "no", do not build and install CTF tools, and also
                    151:                don't generate and manipulate CTF data of ELF binaries
                    152:                during build.
                    153:                Default: no
                    154:
1.349     christos  155: NOCTF          Don't generate and manipulate CTF data of ELF binaries
                    156:                during build. It is set internally for standalone programs.
                    157:
1.172     hubertf   158: MKCVS          If "no", don't build or install cvs(1).
                    159:                Default: yes
                    160:
1.184     lukem     161: MKDEBUG                If "no", don't build and install separate debugging symbols
                    162:                into /usr/libdata/debug.
                    163:                Default: no
                    164:
1.352     christos  165: NODEBUG                Don't compile with debugging symbols during build.
                    166:                It is set internally for standalone programs.
                    167:
1.219     lukem     168: MKDEBUGLIB     Build *_g.a debugging libraries, which are compiled
                    169:                with -DDEBUG.
1.176     christos  170:                Default: no
                    171:
1.314     christos  172: MKDEPINCLUDES  If "yes" issue .include statements in the .depend file
                    173:                instead of inlining the contents of the .d files. Useful
                    174:                when stale dependencies are present, to list the exact
                    175:                files that need refreshing. It is off by default because
                    176:                it is possibly slower.
                    177:                Default "no"
                    178:
1.172     hubertf   179: MKDOC          If "no", don't build or install the documentation.
                    180:                Default: yes
                    181:
1.302     jkoshy    182: MKDTRACE       If "no", do not build and install the kernel modules,
                    183:                utilities and libraries used to implement the dtrace(1)
                    184:                facility.
                    185:                Default: no
                    186:
1.172     hubertf   187: MKDYNAMICROOT  If "no", build programs in /bin and /sbin statically,
                    188:                don't install certain libraries in /lib, and don't
                    189:                install the shared linker into /libexec.
                    190:                Default: yes
                    191:
1.260     uebayasi  192: MKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
                    193:                to cross-build programs and libraries externally added by
                    194:                users, and automatically enables creation of those sets.
                    195:                Default: no
                    196:
1.372     mrg       197: MKFIRMWARE      If "no", install the /libdata/firmware directory,
                    198:                which is necessary for several drivers: athn(4), bwfm(4),
                    199:                ipw(4), iwi(4), iwm(4), iwn(4), otus(4), rtwn(4), urtwn(4),
                    200:                wpi(4), ral(4), rum(4), run(4), zyd(4), bcm43xx(4), and
                    201:                the Tegra 124 SoC.
                    202:                Default: yes on amd64, cobalt, evbarm evbmips, evbppc, hpcarm,
                    203:                hppa, i386, mac68k, macppc, sandpoint, and sparc64, no elsewhere.
                    204:
1.201     lukem     205: MKGCC          If "no", don't build gcc(1) or any of the GCC-related
1.186     mrg       206:                libraries (libgcc, libobjc, libstdc++).
1.172     hubertf   207:                Default: yes
                    208:
1.201     lukem     209: MKGCCCMDS      If "no", don't build gcc(1), but do build the GCC-related
                    210:                libraries (libgcc, libobjc, libstdc++).
1.172     hubertf   211:                Default: yes
                    212:
                    213: MKGDB          If "no", don't build gdb(1).
                    214:                Default: yes
                    215:
1.334     dholland  216: MKGROFFHTMLDOC If "no", avoid trying to use groff to generate html for
                    217:                miscellaneous articles, as this seems to sometimes want
                    218:                to run software not in base. Does not affect html man
                    219:                pages.
                    220:                Default: no
                    221:
1.172     hubertf   222: MKHESIOD       If "no", disables building of Hesiod infrastructure
                    223:                (libraries and support programs).
                    224:                Default: yes
                    225:
                    226: MKHOSTOBJ      If not "no", for programs intended to be run on the compile
                    227:                host, the name, release, and architecture of the host
                    228:                operating system will be suffixed to the name of the object
                    229:                directory created by "make obj".
                    230:                Default: no
                    231:
1.222     lukem     232: MKHTML         If "no", don't build or install the HTML man pages.
                    233:                Default: yes
1.172     hubertf   234:
                    235: MKIEEEFP       If "no", don't add code for IEEE754/IEC60559 conformance.
                    236:                Has no effect on most platforms.
                    237:                Default: yes
                    238:
1.225     joerg     239: MKSTRIPIDENT   Strip the RCS IDs from program binaries and shared libraries.
                    240:                Default: no
                    241:
1.172     hubertf   242: MKINET6                If "no", disables building of INET6 (IPv6) infrastructure
1.273     mrg       243:                (libraries and support programs).  This option must not be
                    244:                set to "no" if MKX11 is not "no".
1.172     hubertf   245:                Default: yes
                    246:
                    247: MKINFO         If "no", don't build or install Info documentation from
                    248:                Texinfo source files.
                    249:                Default: yes
                    250:
                    251: MKIPFILTER     If "no", don't build or install the IP Filter programs and LKM.
                    252:                Default: yes
                    253:
1.208     lukem     254: MKISCSI                If "no", don't build or install iSCSI library or applications
1.181     mrg       255:                (depends on libpthread.)
                    256:                Default: yes
                    257:
1.331     martin    258: MKKDEBUG       If "yes", force building of kernel symbol info and creation
                    259:                of netbsd.gdb in all kernel builds, independently of the
                    260:                settings for "makeoptions DEBUG" in the kernel config file.
                    261:
1.172     hubertf   262: MKKERBEROS     If "no", disables building of Kerberos v5
                    263:                infrastructure (libraries and support programs).
                    264:                Default: yes
                    265:
1.304     jkoshy    266: MKKMOD         If "no", disables building of kernel modules.
                    267:                Default: yes
                    268:
1.312     jmmv      269: MKKYUA         If "no", don't build Kyua nor its dependent library Lutok.
                    270:                Note that setting this to "no" does not disable the build of
                    271:                the NetBSD test suite itself; the build of the tests is
                    272:                controlled by the MKATF knob.
                    273:                Default: no (until the import is done and validated)
                    274:
1.208     lukem     275: MKLDAP         If "no", disables building of LDAP infrastructure
                    276:                (libraries and support programs).
                    277:                Default: yes
                    278:
1.316     joerg     279: MKLIBCXX       If not "no", build and install libc++.
                    280:                Default: no
                    281:
                    282: MKLIBSTDCXX    If not "no", build and install libstdc++.
                    283:                Default: yes
                    284:
1.206     lukem     285: MKLINKLIB      If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
1.172     hubertf   286:                Also:
                    287:                        - don't install the .a libraries
                    288:                        - don't install _pic.a libraries on PIC systems
                    289:                        - don't build .a libraries on PIC systems
                    290:                        - don't install the .so symlink on ELF systems
                    291:                I.e, only install the shared library (and the .so.major
                    292:                symlink on ELF).
                    293:                Default: yes
                    294:
                    295: MKLINT         If "no", don't build or install the lint libraries.
                    296:                Default: yes
                    297:
1.261     tron      298: MKLVM          If "no", don't build or install the logical volume manager
1.245     agc       299:                and device mapper tools and libraries
1.262     tron      300:                Default: yes
1.245     agc       301:
1.172     hubertf   302: MKMAN          If "no", don't build or install the man or catman pages,
                    303:                and also acts as "MKCATPAGES=no MKHTML=no".
                    304:                Default: yes
                    305:
1.256     joerg     306: MKMANDOC       If "yes", mandoc is built as tool and used to compile
                    307:                catman or html pages.  A directory can be exempted by
                    308:                defining NOMANDOC.  Individual man pages are exempted
1.278     joerg     309:                if NOMANDOC.${target} is set to "yes".
1.292     joerg     310:                Default: yes
1.256     joerg     311:
1.172     hubertf   312: MKMANZ         If not "no", compress manual pages at installation time.
                    313:                Default: no
                    314:
1.253     tsarna    315: MKMDNS         If "no", disables building of mDNS infrastructure
                    316:                (libraries and support programs).
                    317:                Default: yes
                    318:
1.172     hubertf   319: MKNLS          If "no", don't build or install the NLS files and locale
                    320:                definition files.
                    321:                Default: yes
                    322:
1.275     rmind     323: MKNPF          If "no", don't build or install the NPF and its modules.
                    324:                Default: yes
                    325:
1.357     christos  326: MKNSD          If "no", don't build or install the "nsd" DNS authoritative
                    327:                server.
                    328:                Default: no
                    329:
1.172     hubertf   330: MKOBJ          If "no", don't enable the rule which creates objdirs,
                    331:                and also acts as "MKOBJDIRS=no".
                    332:                Default: yes
                    333:
                    334: MKOBJDIRS      If "no", don't create objdirs during a "make build".
                    335:                Default: no
                    336:
                    337: MKPAM          If "no", disables building of PAM authentication
                    338:                infrastructure (libraries and support programs).
1.182     peter     339:                Default: yes
1.172     hubertf   340:
1.210     gmcgarry  341: MKPCC          If "no", don't build pcc(1) or any of the PCC-related
                    342:                libraries (libpcc, libpccsoftfloat).
                    343:                Default: no
                    344:
1.172     hubertf   345: MKPF           If "no", don't build or install the pf programs and LKM.
                    346:                Default: yes
                    347:
                    348: MKPIC          If "no", don't build or install shared libraries, and
                    349:                also acts as "MKPICLIB=no"
1.301     abs       350:                Default: yes (for MACHINE_ARCHs that support it)
1.172     hubertf   351:
                    352: MKPICINSTALL   If "no", don't install the *_pic.a libraries.
                    353:                Default: yes
                    354:
                    355: MKPICLIB       If "no", don't build *_pic.a libraries, and build the
                    356:                shared object libraries from the .a libraries.
                    357:                A symlink is installed in ${DESTDIR}/usr/lib for the
                    358:                _pic.a library pointing to the .a library.
                    359:                Default: yes
                    360:
1.198     christos  361: MKPIE          If "no", create regular executables. Otherwise create
                    362:                PIE (Position Independent Executables).
                    363:                Default: no
                    364:
1.350     christos  365: NOPIE          Don't create PIE (Position Independent Executables)
1.349     christos  366:                It is set internally for standalone programs.
                    367:
1.272     mrg       368: MKPIGZGZIP     If "no", only install pigz as pigz, not gzip.
1.271     mrg       369:                Default: no
                    370:
1.172     hubertf   371: MKPOSTFIX      If "no", don't build or install postfix(1).
                    372:                Default: yes
                    373:
                    374: MKPROFILE      If "no", don't build or install the profiling (*_p.a) libraries.
                    375:                Default: yes
                    376:
1.355     christos  377: MKRADEONFIRMWARE If "no", install the /libdata/firmware/radeon directory,
                    378:                which is necessary for the radeon DRM driver.
                    379:                Default: yes on i386 and amd64, no elsewhere.
                    380:
1.354     christos  381: MKRELRO                If "partial", set the non-PLT GOT to read-only. If "full"
                    382:                also force immediate symbol binding.
                    383:                Default: no
                    384:
1.364     khorben   385: MKREPRO         If "yes", create reproducible builds. This enables
1.295     wiz       386:                different switches to make two builds from the same source tree
                    387:                result in the same build results.
                    388:                Default: no
                    389:
1.373     christos  390: MKSANITIZER    if "yes", use the selected sanitizer to compile userland
                    391:                programs as defined in USE_SANITIZER, which defaults to
1.374   ! wiz       392:                "address". Available sanitizers are:
1.373     christos  393:                        address:        A memory error detector (default)
                    394:                        thread:         A data race detector
                    395:                        memory:         An uninitializer read detector
                    396:                        undefined:      An undefined behavior detector
                    397:                        dataflow:       A general data flow analysis
                    398:                        cfi:            A control flow detector
                    399:                        safe-stack:     Protect against stack-based corruption
1.374   ! wiz       400:                Only "address" is currently available for gcc(1).
1.373     christos  401:
1.172     hubertf   402: MKSHARE                If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
                    403:                MKMAN=no MKNLS=no".
                    404:                I.e, don't build catman pages, documentation, Info
                    405:                documentation, man pages, NLS files, ...
                    406:                Default: yes
                    407:
                    408: MKSKEY         If "no", disables building of S/key authentication
                    409:                infrastructure (libraries and support programs).
                    410:                Default: yes
                    411:
1.319     adam      412: MKSLJIT                If "no", disables building of sljit (stack-less platform
1.309     alnsn     413:                independent JIT compiler) private library and tests.
                    414:                Default: yes on amd64, i386 and sparc, no elsewhere.
                    415:
1.172     hubertf   416: MKSOFTFLOAT    If not "no", build with options to enable the compiler to
                    417:                generate output containing library calls for floating
                    418:                point and possibly soft-float library support.
                    419:                Default: no
                    420:
                    421: MKSTATICLIB    If "no", don't build or install the normal static (*.a)
                    422:                libraries.
                    423:                Default: yes
                    424:
1.363     christos  425: MKSTATICPIE    Compile in support for static pie binaries. These binaries
                    426:                use a special rcrt0.o/mcrt0.o that do the necessary relocations
                    427:                Default: yes on platforms that support it.
                    428:
1.359     ozaki-r   429: MKSTRIPSYM     If "yes", strip all local symbols from shared libraries;
                    430:                the affect is equivalent to -x option of ld(1). If "no",
                    431:                strip only temporary local symbols; the affect is equivalent
                    432:                to -X option of ld(1). Keeping non-temporary local symbols
                    433:                such as static function names is useful on using DTrace for
                    434:                userland libraries and getting a backtrace from a rump kernel
                    435:                loading shared libraries.
                    436:                Default: yes
                    437:
1.366     jmcneill  438: MKTEGRAFIRMWARE        If "no", install the /libdata/firmware/nvidia directory,
                    439:                which is necessary for the NVIDIA Tegra XHCI driver.
1.370     ryo       440:                Default: yes on evbarm, no elsewhere.
1.366     jmcneill  441:
1.351     christos  442: MKTOOLSDEBUG   If "yes" build the tools with debugging symbols.
                    443:                Default: no
                    444:
1.306     christos  445: MKTPM          If "no" then don't build the Trusted Platform Module
                    446:                infrastructure.
                    447:                Default: no
                    448:
1.355     christos  449: MKUNBOUND      If not "no", build and install the "unbound" DNS resolver.
1.356     christos  450:                Default: yes
1.355     christos  451:
1.172     hubertf   452: MKUNPRIVED     If not "no", don't set the owner/group/mode when installing
                    453:                files or directories, and keep a metadata log of what
                    454:                the owner/group/mode should be.  This allows a
                    455:                non-root "make install".
                    456:                Default: no
                    457:
                    458: MKUPDATE       If not "no", 'make install' only installs targets that are
                    459:                more recently modified in the source directories that their
                    460:                installed counterparts.
                    461:                Default: no
                    462:
1.346     mrg       463: MKX11          If not "no", 'make build' also descends into
                    464:                src/external/mit/xorg to cross-build X11 and automatically
                    465:                enables creation of X sets.
1.216     mrg       466:                Default: no
                    467:
1.346     mrg       468: MKX11FONTS     If not "no", do not build or install the X fonts.  The xfont
                    469:                set is still created but will be empty.
1.251     mrg       470:                Default: yes
                    471:
1.346     mrg       472: MKX11MOTIF:    If "yes", build the native X11 libGLw with Motif stubs.  If
                    473:                Motif is not installed in the default location /usr/pkg, the
                    474:                location can be specified using the X11MOTIFPATH variable.
1.318     mbalmer   475:                Default: no
                    476:
1.172     hubertf   477: MKYP           If "no", disables building of YP (NIS)
                    478:                infrastructure (libraries and support programs).
                    479:                Default: yes
                    480:
1.301     abs       481: MKZFS          If "no", do not build and install utilities and libraries
                    482:                used to manage ZFS file system. Do not build zfs and solaris
1.340     pooka     483:                compatibility kernel modules.  Note: ZFS requires 64bit
                    484:                atomic operations.
                    485:                Default: yes on amd64, no elsewhere.
1.254     haad      486:
1.298     christos  487: MKRUMP         If "no", do not build and install rump related headers,
                    488:                libraries, and programs.
                    489:                Default: yes
                    490:
1.172     hubertf   491: USE_HESIOD     If "no", disables building Hesiod support into
                    492:                various system utilities/libraries that support it.
                    493:                If ${MKHESIOD} is "no", USE_HESIOD will also be
                    494:                forced to "no".
                    495:
                    496: USE_INET6      If "no", disables building INET6 (IPv6) support into
                    497:                various system utilities/libraries that support it.
                    498:                If ${MKINET6} is "no", USE_INET6 will also be
                    499:                forced to "no".
                    500:
1.197     ad        501: USE_JEMALLOC   If "no", disables building the "jemalloc" allocator
                    502:                designed for improved performance with threaded
                    503:                applications.  The "phkmalloc" allocator as used up
                    504:                before NetBSD-5.0 will be substituted.
                    505:
1.175     christos  506: USE_KERBEROS   If "no", disables building Kerberos v5
1.172     hubertf   507:                support into various system utilities/libraries that
                    508:                support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
                    509:                will also be forced to "no".
                    510:
1.208     lukem     511: USE_LDAP       If "no", disables building LDAP support into various
                    512:                system utilities/libraries that support it.
                    513:                If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
                    514:
1.172     hubertf   515: USE_PAM                If "no", disables building PAM authentication support
                    516:                into various system utilities/libraries that support it.
                    517:                If ${MKPAM} is "no", USE_PAM will also be forced to "no".
                    518:
                    519: USE_SKEY       If "no", disables building S/key authentication
                    520:                support into various system utilities/libraries that
                    521:                support it.  If ${MKSKEY} is "no", USE_SKEY will
                    522:                also be forced to "no".
1.204     lukem     523:                Default: no
1.172     hubertf   524:
1.201     lukem     525: USE_SSP                If "no", disables GCC stack protection code, which
1.257     tron      526:                detects stack overflows and aborts the program. The
1.268     njoly     527:                stack protection code imposes a performance penalty
1.259     pgoyette  528:                of about 5%.
1.258     tron      529:                Default: "no", unless "USE_FORT" is set to "yes"
1.187     christos  530:
1.353     christos  531: NOSSP          Don't compile with stack protector during build.
                    532:                It is set internally for standalone programs.
                    533:
1.246     christos  534: USE_FORT       If "yes" turns on substitute wrappers for commonly used
                    535:                functions that do not do bounds checking regularly, but
                    536:                they could in some cases by using the gcc
1.301     abs       537:                __builtin_object_size() function to determine the buffer
1.246     christos  538:                size where it is known and detect buffer overflows.
                    539:                These substitute functions are in /usr/include/ssp.
1.257     tron      540:                Default: depends on the part of the source tree
1.246     christos  541:
1.353     christos  542: NOFORT         Don't compile with substitute wrappers during build.
                    543:                It is set internally for standalone programs.
                    544:
1.172     hubertf   545: USE_YP         If "no", disables building YP (NIS) support into
                    546:                various system utilities/libraries that support it.
                    547:                If ${MKYP} is "no", USE_YP will also be forced to "no".
                    548:
1.284     matt      549: USE_PIGZGZIP   If "no", use the host "gzip" program to compress things.
1.327     apb       550:                Otherwise, build tools/pigz, set TOOL_GZIP=${TOOL_PIGZ},
                    551:                and use nbpigz to compress things.
1.274     mrg       552:                Default: "no".
                    553:
1.172     hubertf   554: COPTS.lib<lib>
1.177     mrg       555: OBJCOPTS.lib<lib>
1.172     hubertf   556: LDADD.lib<lib>
                    557: CPPFLAGS.lib<lib>
                    558: CXXFLAGS.lib<lib>
                    559: COPTS.<prog>
1.177     mrg       560: OBJCCOPTS.<prog>
1.172     hubertf   561: LDADD.<prog>
                    562: CPPFLAGS.<prog>
                    563: CXXFLAGS.<prog>        These provide a way to specify additions to the associated
                    564:                variables in a way that applies only to a particular library
                    565:                or program.  <lib> corresponds to the LIB variable set in
                    566:                the library's makefile.  <prog> corresponds to either PROG
                    567:                or PROG_CXX (if set).  For example, if COPTS.libcrypto is
                    568:                set to "-g", "-g" will be added to COPTS only when compiling
                    569:                the crypto library.
1.118     lukem     570:
1.281     joerg     571: The active compiler is selected using the following variables:
                    572: AVAILABLE_COMPILER
                    573:                List of available compiler suites.  Processed in order
                    574:                for selecting the active compiler for each frontend.
                    575: HAVE_PCC       If defined, PCC is present and enabled.
                    576: HAVE_LLVM      If defined, LLVM/Clang is present and enabled.
                    577: UNSUPPORTED_COMPILER.xxx
                    578:                If defined, the support for compiler "xxx" is disabled.
                    579:
                    580: For the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
                    581: ACTIVE_CC      Active compile suite for the CC frontend.
                    582: SUPPORTED_CC   Compile suite with support for the CC frontend.
                    583: TOOL_CC.xxx    Path to the CC frontend for compiler "xxx"
                    584:
1.118     lukem     585: =-=-=-=-=   sys.mk   =-=-=-=-=
1.1       cgd       586:
                    587: The include file <sys.mk> has the default rules for all makes, in the BSD
                    588: environment or otherwise.  You probably don't want to touch this file.
                    589:
1.118     lukem     590: =-=-=-=-=   bsd.own.mk   =-=-=-=-=
1.1       cgd       591:
1.17      thorpej   592: The include file <bsd.own.mk> contains source tree configuration parameters,
                    593: such as the owners, groups, etc. for both manual pages and binaries, and
                    594: a few global "feature configuration" parameters.
1.1       cgd       595:
                    596: It has no targets.
                    597:
1.134     lukem     598: To get system-specific configuration parameters, <bsd.own.mk> will try to
1.29      cjs       599: include the file specified by the "MAKECONF" variable.  If MAKECONF is not
                    600: set, or no such file exists, the system make configuration file, /etc/mk.conf
                    601: is included.  These files may define any of the variables described below.
1.17      thorpej   602:
1.134     lukem     603: <bsd.own.mk> sets the following variables, if they are not already defined
1.17      thorpej   604: (defaults are in brackets):
1.15      cgd       605:
1.98      lukem     606: NETBSDSRCDIR   Top of the NetBSD source tree.
                    607:                If _SRC_TOP_ != "", that will be used as the default,
                    608:                otherwise BSDSRCDIR will be used as the default.
                    609:                Various makefiles within the NetBSD source tree will
                    610:                use this to reference the top level of the source tree.
                    611:
1.95      lukem     612: _SRC_TOP_      Top of the system source tree, as determined by <bsd.own.mk>
1.98      lukem     613:                based on the presence of tools/ and build.sh.  This variable
                    614:                is "internal" to <bsd.own.mk>, although its value is only
                    615:                determined once and then propagated to all sub-makes.
1.95      lukem     616:
1.305     apb       617: _NETBSD_VERSION_DEPENDS
                    618:                A list of files which contain information about
                    619:                the version of the NetBSD being built.  This is
                    620:                defined only if the current directory appears
                    621:                to be inside a NetBSD source tree.  The list of
                    622:                files includes ${NETBSDSRCDIR}/sys/sys/param.h
                    623:                (which contains the kernel version number),
                    624:                ${NETBSDSRCDIR}/sys/conf/newvers.sh and
                    625:                ${NETBSDSRCDIR}/sys/conf/osrelease.sh (which
                    626:                interpret the information in sys/sys/param.h), and
                    627:                ${_SRC_TOP_OBJ_}/params (which is an optional file,
                    628:                created by "make build" in ${_SRC_TOP_}/Makefile,
                    629:                containing all the variables that may influence the
                    630:                build).
                    631:
                    632:                Targets that depend on the NetBSD version, or on
                    633:                variables defined at build time, can declare a
                    634:                dependency on ${_NETBSD_VERSION_DEPENDS}, like this:
                    635:
                    636:                        version.c: ${_NETBSD_VERSION_DEPENDS}
                    637:                                commands to create version.c
                    638:
1.15      cgd       639: BSDSRCDIR      The real path to the system sources, so that 'make obj'
1.116     lukem     640:                will work correctly.  [/usr/src]
1.15      cgd       641:
                    642: BSDOBJDIR      The real path to the system 'obj' tree, so that 'make obj'
1.116     lukem     643:                will work correctly.  [/usr/obj]
1.15      cgd       644:
1.116     lukem     645: BINGRP         Binary group.  [wheel]
1.15      cgd       646:
1.116     lukem     647: BINOWN         Binary owner.  [root]
1.15      cgd       648:
1.116     lukem     649: BINMODE                Binary mode.  [555]
1.15      cgd       650:
1.116     lukem     651: NONBINMODE     Mode for non-executable files.  [444]
1.15      cgd       652:
1.116     lukem     653: MANDIR         Base path for manual installation.  [/usr/share/man/cat]
1.15      cgd       654:
1.116     lukem     655: MANGRP         Manual group.  [wheel]
1.15      cgd       656:
1.116     lukem     657: MANOWN         Manual owner.  [root]
1.15      cgd       658:
1.116     lukem     659: MANMODE                Manual mode.  [${NONBINMODE}]
1.15      cgd       660:
1.222     lukem     661: MANINSTALL     Manual installation type.  Space separated list:
                    662:                        catinstall, htmlinstall, maninstall
1.293     joerg     663:                Default value derived from MKCATPAGES and MKHTML.
1.76      fair      664:
                    665: LDSTATIC       Control program linking; if set blank, link everything
1.129     lukem     666:                dynamically.  If set to "-static", link everything statically.
1.76      fair      667:                If not set, programs link according to their makefile.
1.21      christos  668:
1.116     lukem     669: LIBDIR         Base path for library installation.  [/usr/lib]
1.15      cgd       670:
1.116     lukem     671: LINTLIBDIR     Base path for lint(1) library installation.  [/usr/libdata/lint]
1.15      cgd       672:
1.116     lukem     673: LIBGRP         Library group.  [${BINGRP}]
1.15      cgd       674:
1.116     lukem     675: LIBOWN         Library owner.  [${BINOWN}]
1.15      cgd       676:
1.116     lukem     677: LIBMODE                Library mode.  [${NONBINMODE}]
1.15      cgd       678:
                    679: DOCDIR         Base path for system documentation (e.g. PSD, USD, etc.)
1.116     lukem     680:                installation.  [/usr/share/doc]
1.62      simonb    681:
1.116     lukem     682: DOCGRP         Documentation group.  [wheel]
1.15      cgd       683:
1.116     lukem     684: DOCOWN         Documentation owner.  [root]
1.15      cgd       685:
1.116     lukem     686: DOCMODE                Documentation mode.  [${NONBINMODE}]
1.15      cgd       687:
1.335     apb       688: GZIP_N_FLAG    Flags to pass to TOOL_GZIP to prevent it from inserting
                    689:                file names or timestamps in the compressed output.
                    690:                [-n, or -nT when TOOL_GZIP is really TOOL_PIGZ]
                    691:
1.84      kleink    692: NLSDIR         Base path for Native Language Support files installation.
1.15      cgd       693:                [/usr/share/nls]
1.1       cgd       694:
1.116     lukem     695: NLSGRP         Native Language Support files group.  [wheel]
1.1       cgd       696:
1.116     lukem     697: NLSOWN         Native Language Support files owner.  [root]
1.1       cgd       698:
1.116     lukem     699: NLSMODE                Native Language Support files mode.  [${NONBINMODE}]
1.1       cgd       700:
1.255     apb       701: X11SRCDIR      The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
                    702:                if that exists; otherwise /usr/xsrc]
1.144     lukem     703:
1.221     mrg       704: X11SRCDIR.local        The path to the local X11 src tree.  [${X11SRCDIR}/local]
1.144     lukem     705:
1.221     mrg       706: X11SRCDIR.lib<package>
                    707: X11SRCDIR.<package>
                    708:                The path to the xorg src tree for the specificed package>.
                    709:                [${X11SRCDIR}/external/mit/xorg/<package>/dist]
                    710:
1.367     snj       711: X11ROOTDIR     Root directory of the X11 installation.  [/usr/X11R7]
1.144     lukem     712:
                    713: X11BINDIR      X11 bin directory.  [${X11ROOTDIR}/bin]
                    714:
                    715: X11FONTDIR     X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
                    716:
                    717: X11INCDIR      X11 include directory.  [${X11ROOTDIR}/include]
                    718:
                    719: X11LIBDIR      X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
                    720:
                    721: X11MANDIR      X11 manual directory.  [${X11ROOTDIR}/man]
                    722:
                    723: X11USRLIBDIR   X11 library directory.  [${X11ROOTDIR}/lib]
                    724:
1.32      mikel     725: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd       726:                to be stripped.  This is to be used when building your
                    727:                own install script so that the entire system can be made
1.146     lukem     728:                stripped/not-stripped using a single knob.  []
1.1       cgd       729:
1.2       cgd       730: COPY           The flag passed to the install program to cause the binary
                    731:                to be copied rather than moved.  This is to be used when
                    732:                building our own install script so that the entire system
                    733:                can either be installed with copies, or with moves using
1.116     lukem     734:                a single knob.  [-c]
1.15      cgd       735:
1.310     apb       736: MAKEDIRTARGETENV
                    737:                Environment variables passed to the child make process
                    738:                invoked by MAKEDIRTARGET.
                    739:
1.150     lukem     740: MAKEDIRTARGET dir target [params]
                    741:                Runs "cd $${dir} && ${MAKE} [params] $${target}",
                    742:                displaying a "pretty" message whilst doing so.
                    743:
1.152     cl        744: RELEASEMACHINEDIR
                    745:                Subdirectory used below RELEASEDIR when building
                    746:                a release.  [${MACHINE}]
                    747:
                    748: RELEASEMACHINE Subdirectory or path component used for the following
                    749:                paths:
                    750:                        distrib/${RELEASEMACHINE}
                    751:                        distrib/notes/${RELEASEMACHINE}
                    752:                        etc/etc.${RELEASEMACHINE}
                    753:                Used when building a release.  [${MACHINE}]
1.150     lukem     754:
1.134     lukem     755: Additionally, the following variables may be set by <bsd.own.mk> or in a
1.214     wiz       756: make configuration file to modify the behavior of the system build
1.17      thorpej   757: process (default values are in brackets along with comments, if set by
1.134     lukem     758: <bsd.own.mk>):
1.33      jonathan  759:
1.172     hubertf   760: USETOOLS       Indicates whether the tools specified by ${TOOLDIR} should
                    761:                be used as part of a build in progress.
                    762:                Supported values:
                    763:
                    764:                yes     Use the tools from TOOLDIR.
                    765:                        Must be set to this if cross-compiling.
                    766:
                    767:                no      Do not use the tools from TOOLDIR, but refuse to
                    768:                        build native compilation tool components that are
                    769:                        version-specific for that tool.
                    770:
                    771:                never   Do not use the tools from TOOLDIR, even when
                    772:                        building native tool components.  This is similar to
                    773:                        the traditional NetBSD build method, but does not
                    774:                        verify that the compilation tools in use are
                    775:                        up-to-date enough in order to build the tree
                    776:                        successfully.  This may cause build or runtime
                    777:                        problems when building the whole NetBSD source tree.
                    778:
                    779:                Default: "yes" if building all or part of a whole NetBSD
                    780:                source tree (detected automatically); "no" otherwise
                    781:                (to preserve traditional semantics of the <bsd.*.mk>
                    782:                make(1) include files).
1.142     lukem     783:
1.116     lukem     784: OBJECT_FMT     Object file format.  [set to "ELF" on architectures that
1.199     simonb    785:                use ELF -- currently all architectures].
1.33      jonathan  786:
1.103     thorpej   787: TOOLCHAIN_MISSING
1.142     lukem     788:                If not "no", this indicates that the platform being built
1.103     thorpej   789:                does not have a working in-tree toolchain.  If the
1.142     lukem     790:                ${MACHINE_ARCH} in question falls into this category,
1.301     abs       791:                TOOLCHAIN_MISSING is conditionally assigned the value "yes".
1.103     thorpej   792:                Otherwise, the variable is unconditionally assigned the
                    793:                value "no".
1.252     skrll     794:                If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
1.142     lukem     795:                unconditionally assigned the value "no".
1.103     thorpej   796:
                    797: EXTERNAL_TOOLCHAIN
                    798:                This variable is not directly set by <bsd.own.mk>, but
                    799:                including <bsd.own.mk> is the canonical way to gain
                    800:                access to this variable.  The variable should be defined
                    801:                either in the user's environment or in the user's mk.conf
                    802:                file.  If defined, this variable indicates the root of
                    803:                an external toolchain which will be used to build the
1.142     lukem     804:                tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
1.103     thorpej   805:                platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
                    806:                cross-compile framework.
                    807:
1.142     lukem     808:                If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
                    809:                assigned the value "no", since the external version of the
                    810:                compiler may not be able to build the library components of
                    811:                the in-tree compiler.
1.103     thorpej   812:
1.371     joerg     813:                This variable should be used in conjunction with an appropiate
                    814:                HAVE_GCC or HAVE_LLVM setting to control the compiler flags.
                    815:
1.103     thorpej   816:                NOTE: This variable is not yet used in as many places as
                    817:                it should be.  Expect the exact semantics of this variable
                    818:                to change in the short term as parts of the cross-compile
                    819:                framework continue to be cleaned up.
1.1       cgd       820:
1.236     apb       821: The following variables are defined to commands to perform the
                    822: appropriate operation, with the default in [brackets].  Note that
                    823: the defaults change if USETOOLS == "yes":
                    824:
                    825: TOOL_AMIGAAOUT2BB      aout to Amiga bootblock converter.  [amiga-aout2bb]
                    826:
                    827: TOOL_AMIGAELF2BB       ELF to Amiga bootblock converter.  [amiga-elf2bb]
                    828:
                    829: TOOL_AMIGATXLT         Amige assembly language format translator.  [amiga-txlt]
                    830:
                    831: TOOL_ASN1_COMPILE      ASN1 compiler.  [asn1_compile]
                    832:
                    833: TOOL_AWK               Pattern-directed scanning/processing language.  [awk]
                    834:
                    835: TOOL_CAP_MKDB          Create capability database.  [cap_mkdb]
                    836:
                    837: TOOL_CAT               Concatenate and print files.  [cat]
                    838:
                    839: TOOL_CKSUM             Display file checksums.  [cksum]
                    840:
                    841: TOOL_COMPILE_ET                Error table compiler.  [compile_et]
                    842:
                    843: TOOL_CONFIG            Build kernel compilation directories.  [config]
                    844:
                    845: TOOL_CRUNCHGEN         Generate crunched binary build environment.  [crunchgen]
                    846:
                    847: TOOL_CTAGS             Create a tags file.  [ctags]
                    848:
                    849: TOOL_DB                        Manipulate db(3) databases.  [db]
                    850:
                    851: TOOL_DISKLABEL         Read and write disk pack label.  [disklabel]
                    852:
                    853: TOOL_EQN               Format equations for groff.  [eqn]
                    854:
                    855: TOOL_FDISK             MS-DOS partition maintenance program.  [fdisk]
                    856:
                    857: TOOL_FGEN              IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
                    858:
                    859: TOOL_GENASSYM          Generate constants for assembly files.  [genassym]
                    860:
                    861: TOOL_GENCAT            Generate NLS message catalogs.  [gencat]
                    862:
                    863: TOOL_GMAKE             GNU make utility.  [gmake]
                    864:
1.247     sketch    865: TOOL_GREP              Print lines matching a pattern.  [grep]
                    866:
1.236     apb       867: TOOL_GROFF             Front end for groff document formatting system.  [groff]
                    868:
1.327     apb       869: TOOL_GZIP              Compression/decompression tool.  [gzip]
                    870:
1.335     apb       871: TOOL_GZIP_N            Same as TOOL_GZIP, plus a command line option to
                    872:                        prevent it from inserting file names or timestamps
                    873:                        into the compressed output.
                    874:                        [${TOOL_GZIP} ${GZIP_N_FLAG}]
                    875:
1.236     apb       876: TOOL_HEXDUMP           Ascii, decimal, hexadecimal, octal dump.  [hexdump]
                    877:
                    878: TOOL_HP300MKBOOT       Make bootable image for hp300.  [hp300-mkboot]
                    879:
1.328     skrll     880: TOOL_HPPAMKBOOT                Make bootable image for hppa.  [hppa-mkboot]
1.236     apb       881:
                    882: TOOL_INDXBIB           Make bibliographic database's inverted index.  [indxbib]
                    883:
                    884: TOOL_INSTALLBOOT       Install disk bootstrap software.  [installboot]
                    885:
                    886: TOOL_INSTALL_INFO      Update info/dir entries.  [install-info]
                    887:
                    888: TOOL_JOIN              Relational database operator.  [join]
                    889:
                    890: TOOL_M4                        M4 macro language processor.  [m4]
                    891:
                    892: TOOL_MACPPCFIXCOFF     Fix up xcoff headers for macppc.  [macppc-fixcoff]
                    893:
                    894: TOOL_MAKEFS            Create file system image from directory tree.  [makefs]
                    895:
                    896: TOOL_MAKEINFO          Translate Texinfo documents.  [makeinfo]
                    897:
                    898: TOOL_MAKEWHATIS                Create a whatis.db database.  [makewhatis]
                    899:
                    900: TOOL_MDSETIMAGE                Set kernel RAM disk image.  [mdsetimage]
                    901:
                    902: TOOL_MENUC             Menu compiler.  [menuc]
                    903:
                    904: TOOL_MIPSELF2ECOFF     Convert ELF-format executable to ECOFF for mips.
                    905:                        [mips-elf2ecoff]
                    906:
                    907: TOOL_MKCSMAPPER                Make charset mapping table.  [mkcsmapper]
                    908:
                    909: TOOL_MKESDB            Make encoding scheme database.  [mkesdb]
                    910:
                    911: TOOL_MKLOCALE          Make LC_CTYPE locale files.  [mklocale]
                    912:
                    913: TOOL_MKMAGIC           Create database for file(1).  [file]
                    914:
1.311     jmcneill  915: TOOL_MKNOD             Make device special file.  [mknod]
                    916:
1.236     apb       917: TOOL_MKTEMP            Make (unique) temporary file name.  [mktemp]
                    918:
                    919: TOOL_MSGC              Simple message list compiler.  [msgc]
                    920:
                    921: TOOL_MTREE             Map a directory hierarchy.  [mtree]
                    922:
1.332     phx       923: TOOL_NCDCS             Turn ELF kernel into a NCD firmware image. [ncdcs]
                    924:
1.236     apb       925: TOOL_PAX               Manipulate file archives and copy directories.  [pax]
                    926:
                    927: TOOL_PIC               Compile pictures for groff.  [pic]
                    928:
1.273     mrg       929: TOOL_PIGZ              Parallel compressor.  [pigz]
                    930:
1.236     apb       931: TOOL_POWERPCMKBOOTIMAGE        Make bootable image for powerpc.  [powerpc-mkbootimage]
                    932:
                    933: TOOL_PWD_MKDB          Generate the password databases.  [pwd_mkdb]
                    934:
                    935: TOOL_REFER             Preprocess bibliographic references for groff.  [refer]
                    936:
                    937: TOOL_ROFF_ASCII                Generate ASCII groff output.  [nroff]
                    938:
                    939: TOOL_ROFF_DVI          Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
                    940:
                    941: TOOL_ROFF_HTML         Generate HTML groff output.
                    942:                        [${TOOL_GROFF} -Tlatin1 -mdoc2html]
                    943:
                    944: TOOL_ROFF_PS           Generate PS groff output.  [${TOOL_GROFF} -Tps]
                    945:
                    946: TOOL_ROFF_RAW          Generate "raw" groff output.  [${TOOL_GROFF} -Z]
                    947:
                    948: TOOL_RPCGEN            Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
                    949:
                    950: TOOL_SED               Stream editor.  [sed]
                    951:
                    952: TOOL_SOELIM            Eliminate .so's from groff input.  [soelim]
                    953:
                    954: TOOL_SPARKCRC          Generate a crc suitable for use in a sparkive file.
                    955:                        [sparkcrc]
                    956:
                    957: TOOL_STAT              Display file status.  [stat]
                    958:
                    959: TOOL_STRFILE           Create a random access file for storing strings.
                    960:                        [strfile]
                    961:
                    962: TOOL_SUNLABEL          Read or modify a SunOS disk label.  [sunlabel]
                    963:
                    964: TOOL_TBL               Format tables for groff.  [tbl]
                    965:
                    966: TOOL_UUDECODE          Uudecode a binary file.  [uudecode]
                    967:
                    968: TOOL_VGRIND            Grind nice listings of programs.  [vgrind -f]
                    969:
                    970: TOOL_ZIC               Time zone compiler.  [zic]
                    971:
1.323     matt      972: For each possible value of MACHINE_CPU, MACHINES.${MACHINE_CPU} contain a
                    973: list of what ports can be built for it.  This keeps those definitions in
                    974: centralized place.
                    975:
1.134     lukem     976: <bsd.own.mk> is generally useful when building your own Makefiles so that
1.1       cgd       977: they use the same default owners etc. as the rest of the tree.
1.131     lukem     978:
                    979:
1.286     apb       980: =-=-=-=-=   bsd.clean.mk   =-=-=-=-=
                    981:
                    982: The include file <bsd.clean.mk> defines the clean and cleandir
                    983: targets.  It uses the following variables:
                    984:
                    985: CLEANFILES     Files to remove for both the clean and cleandir targets.
                    986:
                    987: CLEANDIRFILES  Files to remove for the cleandir target, but not for
                    988:                the clean target.
                    989:
1.287     apb       990: MKCLEANSRC     Controls whether or not the clean and cleandir targets
                    991:                will delete files from both the object directory,
                    992:                ${.OBJDIR}, and the source directory, ${.CURDIR}.
                    993:
                    994:                If MKCLEANSRC is set to "no", then the file names in
                    995:                CLEANFILES or CLEANDIRFILES are interpreted relative
                    996:                to the object directory, ${.OBJDIR}.  This is the
                    997:                traditional behaviour.
                    998:
                    999:                If MKCLEANSRC is set to "yes", then the file deletion
                   1000:                is performed relative to both the object directory,
                   1001:                ${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
                   1002:                has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
                   1003:                Deleting files from ${.CURDIR} is intended to remove
                   1004:                stray output files that had been left in the source
                   1005:                directory by an earlier build that did not use object
                   1006:                directories.
                   1007:
                   1008:                The default is MKCLEANSRC=yes.  If you always build with
                   1009:                separate object directories, and you are sure that there
                   1010:                are no stray files in the source directories, then you
                   1011:                may set MKCLEANSRC=no to save some time.
                   1012:
                   1013: MKCLEANVERIFY  Controls whether or not the clean and cleandir targets
                   1014:                will verify that files have been deleted.
                   1015:
                   1016:                If MKCLEANVERIFY is set to "no", then the files will
                   1017:                be deleted using a "rm -f" command, and its success or
                   1018:                failure will be ignored.
                   1019:
                   1020:                If MKCLEANVERIFY is set to "yes", then the success of
                   1021:                the "rm -f" command will be verified using an "ls"
                   1022:                command.
                   1023:
                   1024:                The default is MKCLEANVERIFY=yes.  If you are sure that
                   1025:                there will be no problems caused by file permissions,
                   1026:                read-only file systems, or the like, then you may set
                   1027:                MKCLEANVERIFY=no to save some time.
1.286     apb      1028:
                   1029: To use the clean and cleandir targets defined in <bsd.clean.mk>, other
                   1030: Makefiles or bsd.*.mk files should append file names to the CLEANFILES
                   1031: or CLEANDIRFILES variables.  For example:
                   1032:
                   1033:            CLEANFILES+= a.out
                   1034:            CLEANDIRFILES+= .depend
                   1035:
                   1036:            .include <bsd.clean.mk>
                   1037:
1.308     apb      1038: The files listed in CLEANFILES and CLEANDIRFILES must not be
                   1039: directories, because the potential risk from running "rm -rf" commands
                   1040: in bsd.clean.mk is considered too great.  If you want to recursively
                   1041: delete a directory as part of "make clean" or "make cleandir" then you
                   1042: need to provide your own target.
1.286     apb      1043:
1.131     lukem    1044: =-=-=-=-=   bsd.dep.mk   =-=-=-=-=
                   1045:
                   1046: The include file <bsd.dep.mk> contains the default targets for building
1.133     lukem    1047: .depend files.  It creates .d files from entries in SRCS and DPSRCS
                   1048: that are C, C++, or Objective C source files, and builds .depend from the
                   1049: .d files.  All other files in SRCS and all of DPSRCS will be used as
                   1050: dependencies for the .d files.  In order for this to function correctly,
1.132     lukem    1051: it should be .included after all other .mk files and directives that may
                   1052: modify SRCS or DPSRCS.  It uses the following variables:
                   1053:
                   1054: SRCS           List of source files to build the program.
                   1055:
                   1056: DPSRCS         List of source files which are needed for generating
                   1057:                dependencies, but are not needed in ${SRCS}.
1.1       cgd      1058:
                   1059:
1.118     lukem    1060: =-=-=-=-=   bsd.files.mk   =-=-=-=-=
1.106     thorpej  1061:
1.118     lukem    1062: The include file <bsd.files.mk> handles the FILES variables and is included
1.134     lukem    1063: from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
1.124     lukem    1064:
                   1065: FILES          The list of files to install.
                   1066:
1.153     lukem    1067: CONFIGFILES    Similar semantics to FILES, except that the files
                   1068:                are installed by the `configinstall' target,
                   1069:                not the `install' target.
                   1070:                The FILES* variables documented below also apply.
                   1071:
1.124     lukem    1072: FILESOWN       File owner.  [${BINOWN}]
                   1073:
                   1074: FILESGRP       File group.  [${BINGRP}]
                   1075:
1.203     dholland 1076: FILESMODE      File mode.  [${NONBINMODE}]
1.124     lukem    1077:
                   1078: FILESDIR       The location to install the files.
                   1079:
                   1080: FILESNAME      Optional name to install each file as.
                   1081:
1.153     lukem    1082: FILESOWN_<fn>  File owner of the specific file <fn>.
                   1083:
                   1084: FILESGRP_<fn>  File group of the specific file <fn>.
                   1085:
                   1086: FILESMODE_<fn> File mode of the specific file <fn>.
                   1087:
1.202     uwe      1088: FILESDIR_<fn>  The location to install the specific file <fn>.
1.153     lukem    1089:
                   1090: FILESNAME_<fn> Optional name to install <fn> as.
1.124     lukem    1091:
1.285     apb      1092: FILESBUILD     If this variable is defined, then its value will be
                   1093:                used as the default for all FILESBUILD_<fn> variables.
                   1094:                Otherwise, the default will be "no".
                   1095:
1.243     cube     1096: FILESBUILD_<fn>        A value different from "no" will add the file to the list of
                   1097:                targets to be built by `realall'.  Users of that variable
                   1098:                should provide a target to build the file.
                   1099:
1.135     lukem    1100:
1.139     lukem    1101: BUILDSYMLINKS  List of two word items:
1.135     lukem    1102:                        lnsrc lntgt
                   1103:                For each lnsrc item, create a symlink named lntgt.
                   1104:                The lntgt symlinks are removed by the cleandir target.
1.106     thorpej  1105:
1.148     jmc      1106: UUDECODE_FILES List of files which are stored as <file>.uue in the source
                   1107:                tree. Each one will be decoded with ${TOOL_UUDECODE}.
1.301     abs      1108:                The source files have a `.uue' suffix, the generated files do
1.148     jmc      1109:                not.
1.149     jmc      1110:
1.202     uwe      1111: UUDECODE_FILES_RENAME_<fn>
                   1112:                Rename the output from the decode to the provided name.
1.148     jmc      1113:
                   1114:                *NOTE: These files are simply decoded, with no install or other
                   1115:                       rule applying implicitly except being added to the clean
                   1116:                       target.
1.106     thorpej  1117:
1.118     lukem    1118: =-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
1.113     thorpej  1119:
                   1120: The include file <bsd.gcc.mk> computes various parameters related to GCC
                   1121: support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
1.134     lukem    1122: before <bsd.gcc.mk>.
1.113     thorpej  1123:
1.134     lukem    1124: The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
1.113     thorpej  1125: of which need to know where to find certain GCC support libraries.
                   1126:
1.134     lukem    1127: The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
1.113     thorpej  1128: which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
                   1129: the compiler is asked where to find the support libraries, otherwise the
                   1130: support libraries are found in ${DESTDIR}/usr/lib.
                   1131:
1.134     lukem    1132: <bsd.gcc.mk> sets the following variables:
1.113     thorpej  1133:
1.118     lukem    1134: _GCC_CRTBEGIN  The full path name to crtbegin.o.
                   1135:
                   1136: _GCC_CRTBEGINS The full path name to crtbeginS.o.
                   1137:
                   1138: _GCC_CRTEND    The full path name to crtend.o.
                   1139:
                   1140: _GCC_CRTENDS   The full path name to crtendS.o.
                   1141:
                   1142: _GCC_LIBGCCDIR The directory where libgcc.a is located.
                   1143:
                   1144:
                   1145: =-=-=-=-=   bsd.inc.mk   =-=-=-=-=
                   1146:
1.134     lukem    1147: The include file <bsd.inc.mk> defines the includes target and uses the
1.118     lukem    1148: variables:
                   1149:
1.124     lukem    1150: INCS           The list of include files.
1.118     lukem    1151:
                   1152: INCSDIR                The location to install the include files.
                   1153:
                   1154: INCSNAME       Target name of the include file, if only one; same as
                   1155:                FILESNAME, but for include files.
                   1156:
1.134     lukem    1157: INCSYMLINKS    Similar to SYMLINKS in <bsd.links.mk>, except that these
                   1158:                are installed in the 'includes' target and not the
                   1159:                (much later) 'install' target.
                   1160:
1.118     lukem    1161: INCSNAME_<file>        The name file <file> should be installed as, if not <file>,
                   1162:                same as FILESNAME_<file>, but for include files.
                   1163:
                   1164:
                   1165: =-=-=-=-=   bsd.info.mk   =-=-=-=-=
                   1166:
                   1167: The include file <bsd.info.mk> is used to generate and install GNU Info
                   1168: documentation from respective Texinfo source files.  It defines three
                   1169: implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
                   1170: following variables:
                   1171:
                   1172: TEXINFO                List of Texinfo source files.  Info documentation will
                   1173:                consist of single files with the extension replaced by
                   1174:                .info.
                   1175:
                   1176: INFOFLAGS      Flags to pass to makeinfo.  []
                   1177:
                   1178:
                   1179: =-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
                   1180:
                   1181: The include file <bsd.kernobj.mk> defines variables related to the
                   1182: location of kernel sources and object directories.
                   1183:
                   1184: KERNSRCDIR     Is the location of the top of the kernel src.
1.124     lukem    1185:                [${_SRC_TOP_}/sys]
1.118     lukem    1186:
1.124     lukem    1187: KERNARCHDIR    Is the location of the machine dependent kernel sources.
                   1188:                [arch/${MACHINE}]
1.120     lukem    1189:
1.124     lukem    1190: KERNCONFDIR    Is where the configuration files for kernels are found.
                   1191:                [${KERNSRCDIR}/${KERNARCHDIR}/conf]
1.118     lukem    1192:
                   1193: KERNOBJDIR     Is the kernel build directory.  The kernel GENERIC for
                   1194:                instance will be compiled in ${KERNOBJDIR}/GENERIC.
                   1195:                The default value is
                   1196:                ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
                   1197:                if it exists or the target 'obj' is being made.
                   1198:                Otherwise the default is
                   1199:                ${KERNSRCDIR}/${KERNARCHDIR}/compile.
                   1200:
                   1201: It is important that Makefiles (such as those under src/distrib) that
1.134     lukem    1202: wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
1.118     lukem    1203: rather than make assumptions about the location of the compiled kernel.
                   1204:
                   1205:
                   1206: =-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
                   1207:
                   1208: The include file <bsd.kinc.mk> defines the many targets (includes,
                   1209: subdirectories, etc.), and is used by kernel makefiles to handle
                   1210: include file installation.  It is intended to be included alone, by
1.134     lukem    1211: kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
                   1212: Please see <bsd.kinc.mk> for more details, and keep the documentation
                   1213: in that file up to date.
1.118     lukem    1214:
1.325     christos 1215: =-=-=-=-=   bsd.syscall.mk =-=-=-=-=
                   1216:
                   1217: The include file <bsd.syscall.mk> contains the logic to create syscall
                   1218: files for various emulations. It includes <bsd.kinc.mk> to handle the
                   1219: rest of the targets.
1.118     lukem    1220:
                   1221: =-=-=-=-=   bsd.lib.mk   =-=-=-=-=
                   1222:
                   1223: The include file <bsd.lib.mk> has support for building libraries.  It has
                   1224: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
                   1225: includes, install, lint, and tags.  Additionally, it has a checkver target
                   1226: which checks for installed shared object libraries whose version is greater
                   1227: that the version of the source. It has a limited number of suffixes,
1.134     lukem    1228: consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
1.118     lukem    1229: <bsd.shlib.mk> to get shared library parameters.
                   1230:
                   1231: It sets/uses the following variables:
                   1232:
                   1233: LIB            The name of the library to build.
                   1234:
                   1235: LIBDIR         Target directory for libraries.
                   1236:
1.248     perry    1237: MKARZERO       Normally, ar(1) sets the timestamps, uid, gid and
                   1238:                permissions in files inside its archives to those of
1.364     khorben  1239:                the file it was fed. This leads to non-reproducible
1.324     apb      1240:                builds. If MKARZERO is set to "yes" (default is the
                   1241:                same as MKREPRO, or "no" if MKREPRO is not defined),
1.248     perry    1242:                then the "D" flag is passed to ar, causing the
                   1243:                timestamp, uid and gid to be zeroed and the file
                   1244:                permissions to be set to 644. This allows .a files
                   1245:                from different builds to be bit identical.
                   1246:
1.300     joerg    1247: SHLIBINSTALLDIR        Target directory for shared libraries if ${USE_SHLIBDIR}
                   1248:                is not "no".
                   1249:
1.263     abs      1250: SHLIB_MAJOR
                   1251: SHLIB_MINOR
                   1252: SHLIB_TEENY    Major, minor, and teeny version numbers of shared library
                   1253:
1.300     joerg    1254: USE_SHLIBDIR   If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
1.118     lukem    1255:                as the path to install shared libraries to.
                   1256:                USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
1.130     lukem    1257:                Default: no
1.118     lukem    1258:
1.218     lukem    1259: LIBISMODULE    If not "no", install as ${LIB}.so (without the "lib" prefix),
                   1260:                and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
                   1261:                MKPROFILE=no MKSTATICLIB=no".
                   1262:                Default: no
                   1263:
1.211     lukem    1264: LIBISPRIVATE   If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
                   1265:                MKPROFILE=no", and don't install the (.a) library.
1.154     lukem    1266:                This is useful for "build only" helper libraries.
                   1267:                Default: no
                   1268:
1.244     mrg      1269: LIBISCXX       If not "no", Use ${CXX} instead of ${CC} to link
                   1270:                shared libraries.
                   1271:                This is useful for C++ libraries.
                   1272:                Default: no
                   1273:
1.118     lukem    1274: LINTLIBDIR     Target directory for lint libraries.
                   1275:
                   1276: LIBGRP         Library group.
                   1277:
                   1278: LIBOWN         Library owner.
                   1279:
                   1280: LIBMODE                Library mode.
                   1281:
                   1282: LDADD          Additional loader objects.
                   1283:
                   1284: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                   1285:
                   1286: NOCHECKVER_<library>
                   1287: NOCHECKVER     If set, disables checking for installed shared object
                   1288:                libraries with versions greater than the source.  A
                   1289:                particular library name, without the "lib" prefix, may
                   1290:                be appended to the variable name to disable the check for
                   1291:                only that library.
                   1292:
                   1293: SRCS           List of source files to build the library.  Suffix types
                   1294:                .s, .c, and .f are supported.  Note, .s files are preferred
                   1295:                to .c files of the same name.  (This is not the default for
                   1296:                versions of make.)
                   1297:
1.157     lukem    1298: LIBDPLIBS      A list of the tuples:
                   1299:                        libname  path-to-srcdir-of-libname
                   1300:
                   1301:                For each tuple;
                   1302:                     *  LIBDO.libname contains the .OBJDIR of the library
                   1303:                        `libname', and if it is not set it is determined
                   1304:                        from the srcdir and added to MAKEOVERRIDES (the
                   1305:                        latter is to allow for build time optimization).
                   1306:                     *  LDADD gets  -L${LIBDO.libname} -llibname    added.
                   1307:                     *  DPADD gets  ${LIBDO.libname}/liblibname.so  or
                   1308:                                    ${LIBDO.libname}/liblibname.a   added.
                   1309:
1.307     pooka    1310:                The special value "_external" for LIBDO.lib makes the
                   1311:                build system to assume the library comes from outside
                   1312:                of the NetBSD source tree and only causes -llibname
                   1313:                to be added to LDADD.
                   1314:
1.157     lukem    1315:                This variable may be used for individual libraries, as
1.301     abs      1316:                well as in parent directories to cache common libraries
1.157     lukem    1317:                as a build-time optimization.
                   1318:
1.118     lukem    1319: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
                   1320: if it exists, as well as the include file <bsd.man.mk>.
                   1321:
                   1322: It has rules for building profiled objects; profiled libraries are
                   1323: built by default.
                   1324:
                   1325: Libraries are ranlib'd when made.
                   1326:
                   1327:
                   1328: =-=-=-=-=   bsd.links.mk   =-=-=-=-=
                   1329:
                   1330: The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
1.134     lukem    1331: and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
                   1332:
1.249     apb      1333: LINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
                   1334: is used. The defaults may be modified by other bsd.*.mk files which
                   1335: include bsd.links.mk.  In the future, these variables may be replaced
                   1336: by a method for explicitly recording hard links in a metadata log.
                   1337:
1.134     lukem    1338: LINKS          The list of hard links, consisting of pairs of paths:
                   1339:                        source-file target-file
                   1340:                ${DESTDIR} is prepended to both paths before linking.
                   1341:                For example, to link /bin/test and /bin/[, use:
                   1342:                        LINKS=/bin/test /bin/[
                   1343:
1.153     lukem    1344: CONFIGLINKS    Similar semantics to LINKS, except that the links
                   1345:                are installed by the `configinstall' target,
                   1346:                not the `install' target.
                   1347:
1.134     lukem    1348: SYMLINKS       The list of symbolic links, consisting of pairs of paths:
                   1349:                        source-file target-file
                   1350:                ${DESTDIR} is only prepended to target-file before linking.
                   1351:                For example, to symlink /usr/bin/tar to /bin/tar resulting
                   1352:                in ${DESTDIR}/usr/bin/tar -> /bin/tar:
                   1353:                        SYMLINKS=/bin/tar /usr/bin/tar
1.118     lukem    1354:
1.153     lukem    1355: CONFIGSYMLINKS Similar semantics to SYMLINKS, except that the symbolic links
                   1356:                are installed by the `configinstall' target,
                   1357:                not the `install' target.
                   1358:
1.249     apb      1359: LINKSOWN       Link owner.  [${BINOWN}]
                   1360:
                   1361: LINKSGRP       Link group.  [${BINGRP}]
                   1362:
                   1363: LINKSMODE      Link mode.  [${NONBINMODE}]
                   1364:
                   1365: LINKSOWN_<fn>  Link owner of the specific file <fn>.
                   1366:
                   1367: LINKSGRP_<fn>  Link group of the specific file <fn>.
                   1368:
                   1369: LINKSMODE_<fn> Link mode of the specific file <fn>.
                   1370:
1.118     lukem    1371:
                   1372: =-=-=-=-=   bsd.man.mk   =-=-=-=-=
                   1373:
                   1374: The include file <bsd.man.mk> handles installing manual pages and their
                   1375: links.
                   1376:
1.222     lukem    1377: It has a three targets:
1.118     lukem    1378:
1.222     lukem    1379:        catinstall:
                   1380:                Install the preformatted manual pages and their links.
                   1381:        htmlinstall:
                   1382:                Install the HTML manual pages and their links.
1.118     lukem    1383:        maninstall:
                   1384:                Install the manual page sources and their links.
                   1385:
                   1386: It sets/uses the following variables:
                   1387:
                   1388: MANDIR         Base path for manual installation.
                   1389:
                   1390: MANGRP         Manual group.
                   1391:
                   1392: MANOWN         Manual owner.
                   1393:
                   1394: MANMODE                Manual mode.
                   1395:
                   1396: MANSUBDIR      Subdirectory under the manual page section, i.e. "/vax"
                   1397:                or "/tahoe" for machine specific manual pages.
                   1398:
                   1399: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                   1400:
                   1401: MLINKS         List of manual page links (using a .1 - .9 suffix).  The
                   1402:                linked-to file must come first, the linked file second,
1.276     reed     1403:                and there may be multiple pairs.
1.118     lukem    1404:
                   1405: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
                   1406: it exists.
                   1407:
                   1408:
                   1409: =-=-=-=-=   bsd.obj.mk   =-=-=-=-=
                   1410:
                   1411: The include file <bsd.obj.mk> defines targets related to the creation
                   1412: and use of separated object and source directories.
                   1413:
                   1414: If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
                   1415: ${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
                   1416: it exists.  Otherwise make(1) looks for the existence of a
                   1417: subdirectory (or a symlink to a directory) of the source directory
                   1418: into which built targets should be placed.  If an environment variable
                   1419: named MAKEOBJDIR is set, make(1) uses its value as the name of the
                   1420: object directory; failing that, make first looks for a subdirectory
                   1421: named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
                   1422:
                   1423: Object directories are not created automatically by make(1) if they
                   1424: don't exist; you need to run a separate "make obj".  (This will happen
                   1425: during a top-level build if "MKOBJDIRS" is set to a value other than
                   1426: "no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
                   1427: and this is determined by a simple string prefix comparison -- object
                   1428: directories are created in a separate object directory tree, and a
                   1429: symlink to the object directory in that tree is created in the source
                   1430: directory; otherwise, "make obj" assumes that you're not in the main
                   1431: source tree and that it's not safe to use a separate object tree.
                   1432:
                   1433: Several variables used by <bsd.obj.mk> control exactly what
                   1434: directories and links get created during a "make obj":
                   1435:
                   1436: MAKEOBJDIR     If set, this is the component name of the object
                   1437:                directory.
                   1438:
                   1439: OBJMACHINE     If this is set but MAKEOBJDIR is not set, creates
                   1440:                object directories or links named "obj.${MACHINE}";
                   1441:                otherwise, just creates ones named "obj".
                   1442:
                   1443: USR_OBJMACHINE  If set, and the current directory is a subdirectory of
                   1444:                ${BSDSRCDIR}, create object directory in the
                   1445:                corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
                   1446:                otherwise, create it in the corresponding subdirectory
                   1447:                of ${BSDOBJDIR}
1.113     thorpej  1448:
1.118     lukem    1449: BUILDID                If set, the contents of this variable are appended
                   1450:                to the object directory name.  If OBJMACHINE is also
                   1451:                set, ".${BUILDID}" is added after ".${MACHINE}".
1.113     thorpej  1452:
1.106     thorpej  1453:
1.118     lukem    1454: =-=-=-=-=   bsd.prog.mk   =-=-=-=-=
1.106     thorpej  1455:
1.1       cgd      1456: The include file <bsd.prog.mk> handles building programs from one or
                   1457: more source files, along with their manual pages.  It has a limited number
1.301     abs      1458: of suffixes, consistent with the current needs of the BSD tree.
1.134     lukem    1459: <bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
1.1       cgd      1460:
1.16      jtc      1461: It has eight targets:
1.1       cgd      1462:
                   1463:        all:
1.102     thorpej  1464:                build the program and its manual page.  This also
                   1465:                creates a GDB initialization file (.gdbinit) in
                   1466:                the objdir.  The .gdbinit file sets the shared library
                   1467:                prefix to ${DESTDIR} to facilitate cross-debugging.
1.1       cgd      1468:        clean:
                   1469:                remove the program, any object files and the files a.out,
1.24      mikel    1470:                Errs, errs, mklog, and ${PROG}.core.
1.1       cgd      1471:        cleandir:
                   1472:                remove all of the files removed by the target clean, as
                   1473:                well as .depend, tags, and any manual pages.
1.42      lukem    1474:                `distclean' is a synonym for `cleandir'.
1.1       cgd      1475:        depend:
                   1476:                make the dependencies for the source files, and store
                   1477:                them in the file .depend.
1.16      jtc      1478:        includes:
                   1479:                install any header files.
1.1       cgd      1480:        install:
                   1481:                install the program and its manual pages; if the Makefile
                   1482:                does not itself define the target install, the targets
                   1483:                beforeinstall and afterinstall may also be used to cause
                   1484:                actions immediately before and after the install target
                   1485:                is executed.
                   1486:        lint:
                   1487:                run lint on the source files
                   1488:        tags:
                   1489:                create a tags file for the source files.
                   1490:
                   1491: It sets/uses the following variables:
                   1492:
                   1493: BINGRP         Binary group.
                   1494:
                   1495: BINOWN         Binary owner.
                   1496:
                   1497: BINMODE                Binary mode.
                   1498:
1.286     apb      1499: CLEANDIRFILES  Additional files to remove for the cleandir target.
                   1500:
1.1       cgd      1501: CLEANFILES     Additional files to remove for the clean and cleandir targets.
                   1502:
1.337     uebayasi 1503: CONFIGOPTS     Additional flags to config(1) when building kernels.
                   1504:
1.1       cgd      1505: COPTS          Additional flags to the compiler when creating C objects.
1.112     thorpej  1506:
1.125     lukem    1507: COPTS.<fn>     Additional flags to the compiler when creating the
                   1508:                C objects for <fn>.
                   1509:                For <fn>.[ly], "<fn>.c" must be used.
                   1510:
1.112     thorpej  1511: CPUFLAGS       Additional flags to the compiler/assembler to select
                   1512:                CPU instruction set options, CPU tuning options, etc.
1.35      lukem    1513:
1.125     lukem    1514: CPUFLAGS.<fn>  Additional flags to the compiler/assembler for <fn>.
                   1515:                For <fn>.[ly], "<fn>.c" must be used.
                   1516:
1.124     lukem    1517: CPPFLAGS       Additional flags to the C pre-processor.
1.125     lukem    1518:
                   1519: CPPFLAGS.<fn>  Additional flags to the C pre-processor for <fn>.
                   1520:                For <fn>.[ly], "<fn>.c" must be used.
1.102     thorpej  1521:
                   1522: GDBINIT                List of GDB initialization files to add to "source"
                   1523:                directives in the .gdbinit file that is created in the
                   1524:                objdir.
1.1       cgd      1525:
                   1526: LDADD          Additional loader objects.  Usually used for libraries.
                   1527:                For example, to load with the compatibility and utility
                   1528:                libraries, use:
                   1529:
1.5       jtc      1530:                        LDADD+=-lutil -lcompat
1.1       cgd      1531:
1.178     lukem    1532: LDFLAGS                Additional linker flags (passed to ${CC} during link).
1.1       cgd      1533:
1.134     lukem    1534: LINKS          See <bsd.links.mk>
                   1535:
1.177     mrg      1536: OBJCOPTS       Additional flags to the compiler when creating ObjC objects.
                   1537:
                   1538: OBJCOPTS.<fn>  Additional flags to the compiler when creating the
                   1539:                ObjC objects for <fn>.
                   1540:                For <fn>.[ly], "<fn>.c" must be used.
                   1541:
1.134     lukem    1542: SYMLINKS       See <bsd.links.mk>
1.1       cgd      1543:
1.15      cgd      1544: MAN            Manual pages (should end in .1 - .9).  If no MAN variable is
1.8       cgd      1545:                defined, "MAN=${PROG}.1" is assumed.
1.1       cgd      1546:
1.214     wiz      1547: PAXCTL_FLAGS   If defined, run paxctl(1) on the program binary after link
1.212     lukem    1548:                time, with the value of this variable as args to paxctl(1).
1.193     perry    1549:
                   1550: PAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
                   1551:
1.1       cgd      1552: PROG           The name of the program to build.  If not supplied, nothing
                   1553:                is built.
                   1554:
1.88      thorpej  1555: PROG_CXX       If defined, the name of the program to build.  Also
                   1556:                causes <bsd.prog.mk> to link the program with the C++
                   1557:                compiler rather than the C compiler.  PROG_CXX overrides
                   1558:                the value of PROG if PROG is also set.
1.87      thorpej  1559:
1.21      christos 1560: PROGNAME       The name that the above program will be installed as, if
                   1561:                different from ${PROG}.
                   1562:
1.37      tv       1563: SRCS           List of source files to build the program.  If SRCS is not
1.1       cgd      1564:                defined, it's assumed to be ${PROG}.c.
1.108     jwise    1565:
                   1566: DPSRCS         List of source files which are needed for generating
                   1567:                dependencies, but are not needed in ${SRCS}.
1.1       cgd      1568:
                   1569: DPADD          Additional dependencies for the program.  Usually used for
                   1570:                libraries.  For example, to depend on the compatibility and
                   1571:                utility libraries use:
                   1572:
1.5       jtc      1573:                        DPADD+=${LIBCOMPAT} ${LIBUTIL}
1.1       cgd      1574:
1.288     christos 1575:                The following system libraries are predefined for DPADD:
1.1       cgd      1576:
1.196     joerg    1577:                LIBARCHIVE?=    ${DESTDIR}/usr/lib/libarchive.a
1.159     lukem    1578:                LIBASN1?=       ${DESTDIR}/usr/lib/libasn1.a
1.279     jmmv     1579:                LIBATF_C?=      ${DESTDIR}/usr/lib/libatf-c.a
                   1580:                LIBATF_CXX?=    ${DESTDIR}/usr/lib/libatf-c++.a
1.288     christos 1581:                LIBBIND9?=      ${DESTDIR}/usr/lib/libbind9.a
1.180     gdamore  1582:                LIBBLUETOOTH?=  ${DESTDIR}/usr/lib/libbluetooth.a
1.159     lukem    1583:                LIBBSDMALLOC?=  ${DESTDIR}/usr/lib/libbsdmalloc.a
1.99      itojun   1584:                LIBBZ2?=        ${DESTDIR}/usr/lib/libbz2.a
1.21      christos 1585:                LIBC?=          ${DESTDIR}/usr/lib/libc.a
1.288     christos 1586:                LIBCOMPAT?=     ${DESTDIR}/usr/lib/libcompat.a
1.99      itojun   1587:                LIBCOM_ERR?=    ${DESTDIR}/usr/lib/libcom_err.a
1.288     christos 1588:                LIBCRT0?=       ${DESTDIR}/usr/lib/crt0.o
1.322     joerg    1589:                LIBCRTI?=       ${DESTDIR}/usr/lib/crti.o
1.21      christos 1590:                LIBCRYPT?=      ${DESTDIR}/usr/lib/libcrypt.a
1.99      itojun   1591:                LIBCRYPTO?=     ${DESTDIR}/usr/lib/libcrypto.a
1.21      christos 1592:                LIBCURSES?=     ${DESTDIR}/usr/lib/libcurses.a
1.288     christos 1593:                LIBC_PIC?=      ${DESTDIR}/usr/lib/libc_pic.a
1.21      christos 1594:                LIBDBM?=        ${DESTDIR}/usr/lib/libdbm.a
                   1595:                LIBDES?=        ${DESTDIR}/usr/lib/libdes.a
1.288     christos 1596:                LIBDNS?=        ${DESTDIR}/usr/lib/libdns.a
1.21      christos 1597:                LIBEDIT?=       ${DESTDIR}/usr/lib/libedit.a
1.114     provos   1598:                LIBEVENT?=      ${DESTDIR}/usr/lib/libevent.a
1.315     christos 1599:                LIBEVENT_OPENSSL?=      ${DESTDIR}/usr/lib/libevent_openssl.a
                   1600:                LIBEVENT_PTHREADS?=     ${DESTDIR}/usr/lib/libevent_pthreads.a
1.347     christos 1601:                LIBEXECINFO?=   ${DESTDIR}/usr/lib/libexecinfo.a
1.294     tron     1602:                LIBEXPAT?=      ${DESTDIR}/usr/lib/libexpat.a
1.227     joerg    1603:                LIBFETCH?=      ${DESTDIR}/usr/lib/libfetch.a
1.73      blymn    1604:                LIBFORM?=       ${DESTDIR}/usr/lib/libform.a
1.288     christos 1605:                LIBFL?=         ${DESTDIR}/usr/lib/libfl.a
                   1606:                LIBG2C?=        ${DESTDIR}/usr/lib/libg2c.a
1.21      christos 1607:                LIBGCC?=        ${DESTDIR}/usr/lib/libgcc.a
                   1608:                LIBGNUMALLOC?=  ${DESTDIR}/usr/lib/libgnumalloc.a
1.99      itojun   1609:                LIBGSSAPI?=     ${DESTDIR}/usr/lib/libgssapi.a
                   1610:                LIBHDB?=        ${DESTDIR}/usr/lib/libhdb.a
1.288     christos 1611:                LIBHEIMBASE?=   ${DESTDIR}/usr/lib/libheimbase.a
                   1612:                LIBHEIMNTLM?=   ${DESTDIR}/usr/lib/libheimntlm.a
                   1613:                LIBHX500?=      ${DESTDIR}/usr/lib/libhx500.a
1.70      itojun   1614:                LIBINTL?=       ${DESTDIR}/usr/lib/libintl.a
1.49      itojun   1615:                LIBIPSEC?=      ${DESTDIR}/usr/lib/libipsec.a
1.288     christos 1616:                LIBISC?=        ${DESTDIR}/usr/lib/libisc.a
                   1617:                LIBISCCC?=      ${DESTDIR}/usr/lib/libisccc.a
                   1618:                LIBISCFG?=      ${DESTDIR}/usr/lib/libiscfg.a
1.99      itojun   1619:                LIBKADM5CLNT?=  ${DESTDIR}/usr/lib/libkadm5clnt.a
                   1620:                LIBKADM5SRV?=   ${DESTDIR}/usr/lib/libkadm5srv.a
                   1621:                LIBKAFS?=       ${DESTDIR}/usr/lib/libkafs.a
                   1622:                LIBKRB5?=       ${DESTDIR}/usr/lib/libkrb5.a
1.21      christos 1623:                LIBKVM?=        ${DESTDIR}/usr/lib/libkvm.a
                   1624:                LIBL?=          ${DESTDIR}/usr/lib/libl.a
1.208     lukem    1625:                LIBLBER?=       ${DESTDIR}/usr/lib/liblber.a
                   1626:                LIBLDAP?=       ${DESTDIR}/usr/lib/libldap.a
1.209     lukem    1627:                LIBLDAP_R?=     ${DESTDIR}/usr/lib/libldap_r.a
1.277     mbalmer  1628:                LIBLUA?=        ${DESTDIR}/usr/lib/liblua.a
1.313     jmmv     1629:                LIBLUTOK?=      ${DESTDIR}/usr/lib/liblutok.a
1.288     christos 1630:                LIBLWRES?=      ${DESTDIR}/usr/lib/liblwres.a
1.21      christos 1631:                LIBM?=          ${DESTDIR}/usr/lib/libm.a
1.288     christos 1632:                LIBMAGIC?=      ${DESTDIR}/usr/lib/libmagic.a
1.53      blymn    1633:                LIBMENU?=       ${DESTDIR}/usr/lib/libmenu.a
1.99      itojun   1634:                LIBOBJC?=       ${DESTDIR}/usr/lib/libobjc.a
                   1635:                LIBOSSAUDIO?=   ${DESTDIR}/usr/lib/libossaudio.a
1.159     lukem    1636:                LIBPAM?=        ${DESTDIR}/usr/lib/libpam.a
1.348     kamil    1637:                LIBPANEL?=      ${DESTDIR}/usr/lib/libpanel.a
1.21      christos 1638:                LIBPCAP?=       ${DESTDIR}/usr/lib/libpcap.a
1.99      itojun   1639:                LIBPCI?=        ${DESTDIR}/usr/lib/libpci.a
1.100     thorpej  1640:                LIBPMC?=        ${DESTDIR}/usr/lib/libpmc.a
1.26      kleink   1641:                LIBPOSIX?=      ${DESTDIR}/usr/lib/libposix.a
1.110     thorpej  1642:                LIBPTHREAD?=    ${DESTDIR}/usr/lib/libpthread.a
1.288     christos 1643:                LIBPUFFS?=      ${DESTDIR}/usr/lib/libpuffs.a
                   1644:                LIBQUOTA?=      ${DESTDIR}/usr/lib/libquota.a
1.163     christos 1645:                LIBRADIUS?=     ${DESTDIR}/usr/lib/libradius.a
1.365     jmcneill 1646:                LIBREFUSE?=     ${DESTDIR}/usr/lib/librefuse.a
1.21      christos 1647:                LIBRESOLV?=     ${DESTDIR}/usr/lib/libresolv.a
1.99      itojun   1648:                LIBRMT?=        ${DESTDIR}/usr/lib/librmt.a
                   1649:                LIBROKEN?=      ${DESTDIR}/usr/lib/libroken.a
1.21      christos 1650:                LIBRPCSVC?=     ${DESTDIR}/usr/lib/librpcsvc.a
1.110     thorpej  1651:                LIBRT?=         ${DESTDIR}/usr/lib/librt.a
1.288     christos 1652:                LIBRUMP?=       ${DESTDIR}/usr/lib/librump.a
1.289     christos 1653:                LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
                   1654:                LIBRUMPFS_EFS?= ${DESTDIR}/usr/lib/librumpfs_efs.a
                   1655:                LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
                   1656:                LIBRUMPFS_FFS?= ${DESTDIR}/usr/lib/librumpfs_ffs.a
                   1657:                LIBRUMPFS_HFS?= ${DESTDIR}/usr/lib/librumpfs_hfs.a
                   1658:                LIBRUMPFS_LFS?= ${DESTDIR}/usr/lib/librumpfs_lfs.a
                   1659:                LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
                   1660:                LIBRUMPFS_NFS?= ${DESTDIR}/usr/lib/librumpfs_nfs.a
                   1661:                LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
                   1662:                LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
                   1663:                LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
                   1664:                LIBRUMPFS_UDF?= ${DESTDIR}/usr/lib/librumpfs_udf.a
                   1665:                LIBRUMPFS_UFS?= ${DESTDIR}/usr/lib/librumpfs_ufs.a
1.288     christos 1666:                LIBRUMPUSER?=   ${DESTDIR}/usr/lib/librumpuser.a
                   1667:                LIBSASLC?=      ${DESTDIR}/usr/lib/libsaslc.a
1.21      christos 1668:                LIBSKEY?=       ${DESTDIR}/usr/lib/libskey.a
1.140     lukem    1669:                LIBSL?=         ${DESTDIR}/usr/lib/libsl.a
1.288     christos 1670:                LIBSQLITE3?=    ${DESTDIR}/usr/lib/libsqlite3.a
1.99      itojun   1671:                LIBSS?=         ${DESTDIR}/usr/lib/libss.a
1.159     lukem    1672:                LIBSSH?=        ${DESTDIR}/usr/lib/libssh.a
1.99      itojun   1673:                LIBSSL?=        ${DESTDIR}/usr/lib/libssl.a
1.187     christos 1674:                LIBSSP?=        ${DESTDIR}/usr/lib/libssp.a
1.140     lukem    1675:                LIBSTDCXX?=     ${DESTDIR}/usr/lib/libstdc++.a
1.186     mrg      1676:                LIBSUPCXX?=     ${DESTDIR}/usr/lib/libsupc++.a
1.264     roy      1677:                LIBTERMINFO?=   ${DESTDIR}/usr/lib/libterminfo.a
1.290     christos 1678:                LIBTRE?=        ${DESTDIR}/usr/lib/libtre.a
1.355     christos 1679:                LIBUNBOUND?=    ${DESTDIR}/usr/lib/libunbound.a
1.99      itojun   1680:                LIBUSBHID?=     ${DESTDIR}/usr/lib/libusbhid.a
1.21      christos 1681:                LIBUTIL?=       ${DESTDIR}/usr/lib/libutil.a
1.288     christos 1682:                LIBWIND?=       ${DESTDIR}/usr/lib/libwind.a
1.21      christos 1683:                LIBWRAP?=       ${DESTDIR}/usr/lib/libwrap.a
                   1684:                LIBY?=          ${DESTDIR}/usr/lib/liby.a
                   1685:                LIBZ?=          ${DESTDIR}/usr/lib/libz.a
1.1       cgd      1686:
1.288     christos 1687:                The following X-Windows libraries are predefined for DPADD:
                   1688:
                   1689:                LIBFS?=         ${DESTDIR}/usr/X11R7/lib/libFS.a
                   1690:                LIBGL?=         ${DESTDIR}/usr/X11R7/lib/libGL.a
                   1691:                LIBGLU?=        ${DESTDIR}/usr/X11R7/lib/libGLU.a
                   1692:                LIBICE?=        ${DESTDIR}/usr/X11R7/lib/libICE.a
                   1693:                LIBSM?=         ${DESTDIR}/usr/X11R7/lib/libSM.a
                   1694:                LIBX11?=        ${DESTDIR}/usr/X11R7/lib/libX11.a
1.317     mrg      1695:                LIBX11_XCB?=    ${DESTDIR}/usr/X11R7/lib/libX11-xcb.a
1.288     christos 1696:                LIBXTRAP?=      ${DESTDIR}/usr/X11R7/lib/libXTrap.a
                   1697:                LIBXAU?=        ${DESTDIR}/usr/X11R7/lib/libXau.a
                   1698:                LIBXAW?=        ${DESTDIR}/usr/X11R7/lib/libXaw.a
1.320     christos 1699:                LIBXCB?=        ${DESTDIR}/usr/X11R7/lib/libxcb.a
1.288     christos 1700:                LIBXDMCP?=      ${DESTDIR}/usr/X11R7/lib/libXdmcp.a
                   1701:                LIBXEXT?=       ${DESTDIR}/usr/X11R7/lib/libXext.a
                   1702:                LIBXFONT?=      ${DESTDIR}/usr/X11R7/lib/libXfont.a
1.369     mrg      1703:                LIBXFONT2?=     ${DESTDIR}/usr/X11R7/lib/libXfont2.a
1.288     christos 1704:                LIBXFT?=        ${DESTDIR}/usr/X11R7/lib/libXft.a
                   1705:                LIBXI?=         ${DESTDIR}/usr/X11R7/lib/libXi.a
                   1706:                LIBXINERAMA?=   ${DESTDIR}/usr/X11R7/lib/libXinerama.a
                   1707:                LIBXMU?=        ${DESTDIR}/usr/X11R7/lib/libXmu.a
                   1708:                LIBXMUU?=       ${DESTDIR}/usr/X11R7/lib/libXmuu.a
                   1709:                LIBXPM?=        ${DESTDIR}/usr/X11R7/lib/libXpm.a
                   1710:                LIBXRANDR?=     ${DESTDIR}/usr/X11R7/lib/libXrandr.a
                   1711:                LIBXRENDER?=    ${DESTDIR}/usr/X11R7/lib/libXrender.a
                   1712:                LIBXSS?=        ${DESTDIR}/usr/X11R7/lib/libXss.a
                   1713:                LIBXT?=         ${DESTDIR}/usr/X11R7/lib/libXt.a
                   1714:                LIBXTST?=       ${DESTDIR}/usr/X11R7/lib/libXtst.a
                   1715:                LIBXV?=         ${DESTDIR}/usr/X11R7/lib/libXv.a
                   1716:                LIBXXF86DGA?=   ${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
                   1717:                LIBXXF86MISC?=  ${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
                   1718:                LIBXXF86VM?=    ${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
                   1719:                LIBDPS?=        ${DESTDIR}/usr/X11R7/lib/libdps.a
                   1720:                LIBFNTSTUBS?=   ${DESTDIR}/usr/X11R7/lib/libfntstubs.a
                   1721:                LIBFONTCONFIG?= ${DESTDIR}/usr/X11R7/lib/libfontconfig.a
                   1722:                LIBFONTENC?=    ${DESTDIR}/usr/X11R7/lib/libfontenc.a
                   1723:                LIBFREETYPE?=   ${DESTDIR}/usr/X11R7/lib/libfreetype.a
                   1724:                LIBLBXUTIL?=    ${DESTDIR}/usr/X11R7/lib/liblbxutil.a
                   1725:                LIBXKBFILE?=    ${DESTDIR}/usr/X11R7/lib/libxkbfile.a
                   1726:
1.1       cgd      1727: SHAREDSTRINGS  If defined, a new .c.o rule is used that results in shared
1.12      christos 1728:                strings, using xstr(1). Note that this will not work with
                   1729:                parallel makes.
1.1       cgd      1730:
1.59      jlam     1731: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd      1732:                to be stripped.
                   1733:
                   1734: SUBDIR         A list of subdirectories that should be built as well.
                   1735:                Each of the targets will execute the same target in the
                   1736:                subdirectories.
                   1737:
1.21      christos 1738: SCRIPTS                A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
                   1739:                These are installed exactly like programs.
                   1740:
1.166     rtr      1741: SCRIPTSDIR     The location to install the scripts.  Each script can be
                   1742:                installed to a separate path by setting SCRIPTSDIR_<script>.
                   1743:
1.21      christos 1744: SCRIPTSNAME    The name that the above program will be installed as, if
                   1745:                different from ${SCRIPTS}. These can be further specialized
                   1746:                by setting SCRIPTSNAME_<script>.
                   1747:
1.124     lukem    1748: FILES          See description of <bsd.files.mk>.
1.21      christos 1749:
1.106     thorpej  1750: SHLINKDIR      Target directory for shared linker.  See description of
                   1751:                <bsd.own.mk> for additional information about this variable.
1.130     lukem    1752:
1.1       cgd      1753: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
                   1754: if it exists, as well as the include file <bsd.man.mk>.
                   1755:
                   1756: Some simple examples:
                   1757:
                   1758: To build foo from foo.c with a manual page foo.1, use:
                   1759:
                   1760:        PROG=   foo
                   1761:
                   1762:        .include <bsd.prog.mk>
                   1763:
                   1764: To build foo from foo.c with a manual page foo.2, add the line:
                   1765:
1.9       cgd      1766:        MAN=    foo.2
1.1       cgd      1767:
                   1768: If foo does not have a manual page at all, add the line:
                   1769:
1.75      agc      1770:        MKMAN=  no
1.1       cgd      1771:
                   1772: If foo has multiple source files, add the line:
                   1773:
                   1774:        SRCS=   a.c b.c c.c d.c
                   1775:
                   1776:
1.118     lukem    1777: =-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
                   1778:
                   1779: The include file <bsd.rpc.mk> contains a makefile fragment used to
                   1780: construct source files built by rpcgen.
1.72      sommerfe 1781:
1.118     lukem    1782: The following macros may be defined in makefiles which include
                   1783: <bsd.rpc.mk> in order to control which files get built and how they
                   1784: are to be built:
1.21      christos 1785:
1.118     lukem    1786: RPC_INCS:      construct .h file from .x file
1.120     lukem    1787: RPC_XDRFILES:  construct _xdr.c from .x file
1.118     lukem    1788:                (for marshalling/unmarshalling data types)
                   1789: RPC_SVCFILES:  construct _svc.c from .x file
                   1790:                (server-side stubs)
                   1791: RPC_SVCFLAGS:  Additional flags passed to builds of RPC_SVCFILES.
1.21      christos 1792:
1.118     lukem    1793: RPC_XDIR:      Directory containing .x/.h files
1.23      christos 1794:
                   1795:
1.118     lukem    1796: =-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1.21      christos 1797:
1.118     lukem    1798: The include file <bsd.shlib.mk> computes parameters for shared library
                   1799: installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1.134     lukem    1800: included before <bsd.shlib.mk>.
1.21      christos 1801:
1.134     lukem    1802: <bsd.own.mk> sets the following variables, if they are not already defined
1.118     lukem    1803: (defaults are in brackets):
1.21      christos 1804:
1.300     joerg    1805: SHLIBINSTALLDIR        If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
                   1806:                instead of ${LIBDIR} as the base path for shared library
                   1807:                installation.  [/lib]
                   1808:
1.118     lukem    1809: SHLIBDIR       The path to USE_SHLIBDIR shared libraries to use when building
                   1810:                a program.  [/lib for programs in /bin and /sbin, /usr/lib
                   1811:                for all others.]
1.81      wiz      1812:
1.300     joerg    1813: _LIBSODIR      Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1.118     lukem    1814:                otherwise set to ${LIBDIR}
1.81      wiz      1815:
1.300     joerg    1816: SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
                   1817:
1.118     lukem    1818: SHLINKDIR      Path to use for shared linker when building a program.
                   1819:                [/libexec for programs in /bin and /sbin, /usr/libexec for
                   1820:                all others.]
1.39      cgd      1821:
1.13      christos 1822:
1.118     lukem    1823: =-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1.13      christos 1824:
1.118     lukem    1825: The include file <bsd.subdir.mk> contains the default targets for building
1.120     lukem    1826: subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1.233     apb      1827: clean, cleandir, depend, includes, install, lint, and tags.  It uses the
                   1828: following variables:
                   1829:
                   1830: NOSUBDIR       If this variable is defined, then the SUBDIR variable
                   1831:                will be ignored and subdirectories will not be processed.
                   1832:
                   1833: SUBDIR         For all of the directories listed in ${SUBDIR}, the
                   1834:                specified directory will be visited and the target made.
                   1835:
                   1836:                As a special case, the use of a token .WAIT as an
                   1837:                entry in SUBDIR acts as a synchronization barrier
                   1838:                when multiple make jobs are run; subdirs before the
                   1839:                .WAIT must complete before any subdirs after .WAIT are
                   1840:                started.  See make(1) for some caveats on use of .WAIT
                   1841:                and other special sources.
1.47      tv       1842:
                   1843:
1.326     christos 1844: =-=-=-=-=   bsd.x11.mk   =-=-=-=-=
                   1845:
                   1846: The include file <bsd.x11.mk> contains parameters and targets for
1.346     mrg      1847: cross-building X11 from ${X11SRCDIR.<package>}.  It should be included
                   1848: after the general Makefile contents but before the include files such as
                   1849: <bsd.prog.mk> and <bsd.lib.mk>.
1.326     christos 1850:
                   1851: It provides the following targets:
                   1852:        .man.1 .man.3 .man.4 .man.5 .man.7:
                   1853:                If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
                   1854:                these rules convert from X11's manual page source
                   1855:                into an mdoc.old source file.
                   1856:
                   1857: It sets the following variables:
                   1858:
                   1859: BINDIR                 Set to ${X11BINDIR}.
                   1860:                        To override, define after including <bsd.x11.mk>
                   1861:
                   1862: LIBDIR                 Set to ${X11USRLIBDIR}.
                   1863:                        To override, define after including <bsd.x11.mk>
                   1864:
                   1865: MANDIR                 Set to ${X11MANDIR}.
                   1866:                        To override, define after including <bsd.x11.mk>
                   1867:
                   1868: CPPFLAGS               Appended with definitions to include from
                   1869:                        ${DESTDIR}${X11INCDIR}
                   1870:
                   1871: LDFLAGS                        Appended with definitions to link from
                   1872:                        ${DESTDIR}${X11USRLIBDIR}
                   1873:
                   1874: X11FLAGS.CONNECTION    Equivalent to X11's CONNECTION_FLAGS.
                   1875:
                   1876: X11FLAGS.EXTENSION     Equivalent to X11's EXT_DEFINES.
                   1877:
                   1878: X11FLAGS.LOADABLE      Equivalent to X11's LOADABLE.
                   1879:
                   1880: X11FLAGS.OS_DEFINES    Equivalent to X11's OS_DEFINES.
                   1881:
                   1882: X11FLAGS.SERVER                Equivalent to X11's ServerDefines.
                   1883:
                   1884: X11FLAGS.THREADLIB     Equivalent to X11's THREADS_DEFINES for libraries.
                   1885:
                   1886: X11FLAGS.THREADS       Equivalent to X11's THREADS_DEFINES.
                   1887:
                   1888: X11FLAGS.VERSION       cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
                   1889:
                   1890: X11FLAGS.DIX           Equivalent to X11's DIX_DEFINES.
                   1891:
                   1892: X11TOOL_UNXCOMM                Commandline to convert `XCOMM' comments to `#'
                   1893:
                   1894: It uses the following variables:
                   1895:
                   1896: APPDEFS                        List of app-default files to install.
                   1897:
                   1898: CPPSCRIPTS             List of files/scripts to run through cpp(1)
                   1899:                        and then ${X11TOOL_UNXCOMM}.  The source files
                   1900:                        have a `.cpp' suffix, the generated files do not.
                   1901:
                   1902: CPPSCRIPTFLAGS         Additional flags to cpp(1) when building CPPSCRIPTS.
                   1903:
                   1904: CPPSCRIPTFLAGS_<fn>    Additional flags to cpp(1) when building CPPSCRIPT <fn>.
                   1905:
                   1906:
                   1907: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
                   1908:
                   1909: The following files are described here for completion, but they are not
                   1910: supposed to be included directly from other Makefiles; they are used
                   1911: internally by other system files.
                   1912:
1.118     lukem    1913: =-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1.47      tv       1914:
1.326     christos 1915: The include file <bsd.sys.mk> is used by other system mk files and
                   1916: it is not intended to be included standalone. It contains rules and
                   1917: system build variables. It requires bsd.own.mk to be included first.
                   1918: It contains overrides that are used when building the NetBSD source tree.
1.133     lukem    1919:
                   1920: The following variables control how various files are compiled/built.
1.142     lukem    1921: (Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1.133     lukem    1922:
                   1923: AR             Create, modify, and extract from archives.  [ar]
                   1924:
                   1925: ARFLAGS                Options to ${AR}.  [rl]
                   1926:
1.151     lukem    1927: AS             Assembler.  [as]
                   1928:
1.211     lukem    1929: AFLAGS         Options to ${CC} when compiling or linking .s or .S
                   1930:                assembly source files.  []
1.151     lukem    1931:
1.217     joerg    1932: BUILDSEED      GCC uses random numbers when compiling C++ code.
                   1933:                If this option is present, seed the random number
                   1934:                generator based on the value, source file names and
                   1935:                the output file name to make builds more deterministic.
                   1936:                Additional information is available in the GCC
                   1937:                documentation of -frandom-seed.
                   1938:
1.133     lukem    1939: CC             C compiler.  [cc]
                   1940:
                   1941: CFLAGS         Options to ${CC}.  [Usually -O or -O2]
                   1942:
                   1943: CPP            C Pre-Processor.  [cpp]
                   1944:
                   1945: CPPFLAGS       Options to ${CPP}.  []
                   1946:
1.151     lukem    1947: CPUFLAGS       Optimization flags for ${CC}.  []
1.133     lukem    1948:
                   1949: CXX            C++ compiler.  [c++]
                   1950:
                   1951: CXXFLAGS       Options to ${CXX}.  [${CFLAGS}]
                   1952:
                   1953: ELF2ECOFF      Convert ELF-format executable to ECOFF.  [elf2ecoff]
                   1954:
                   1955: FC             Fortran compiler.  [f77]
                   1956:
                   1957: FFLAGS         Options to {$FC}.  [-O]
                   1958:
1.235     apb      1959: HOST_SH                Shell.  This must be an absolute path, because it may be
                   1960:                substituted into "#!" lines in scripts.  [/bin/sh]
                   1961:
1.133     lukem    1962: INSTALL                install(1) command.  [install]
                   1963:
                   1964: LEX            Lexical analyzer.  [lex]
                   1965:
                   1966: LFLAGS         Options to ${LEX}.  []
                   1967:
1.145     jwise    1968: LPREFIX                Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
                   1969:
1.133     lukem    1970: LD             Linker.  [ld]
                   1971:
1.178     lukem    1972: LDFLAGS                Options to ${CC} during the link process.  []
1.133     lukem    1973:
                   1974: LINT           C program verifier.  [lint]
                   1975:
1.330     christos 1976: LINTFLAGS      Options to ${LINT}.  [-chapbxzgFS]
1.133     lukem    1977:
                   1978: LORDER         List dependencies for object files.  [lorder]
                   1979:
                   1980: MAKE           make(1).  [make]
                   1981:
                   1982: MKDEP          Construct Makefile dependency list.  [mkdep]
                   1983:
1.321     mrg      1984: MKDEPCXX       Construct Makefile dependency list for C++ files.  [mkdep]
                   1985:
1.133     lukem    1986: NM             List symbols from object files.  [nm]
                   1987:
                   1988: PC             Pascal compiler.  [pc]  (Not present)
                   1989:
                   1990: PFLAGS         Options to ${PC}.  []
                   1991:
                   1992: OBJC           Objective C compiler.  [${CC}]
                   1993:
                   1994: OBJCFLAGS      Options to ${OBJC}.  [${CFLAGS}]
                   1995:
                   1996: OBJCOPY                Copy and translate object files.  [objcopy]
                   1997:
1.291     christos 1998: OBJCOPYLIBFLAGS        Flags to pass to objcopy when library objects are
                   1999:                being built. [${.TARGET} =~ "*.po" ? -X : -x]
                   2000:
1.168     riz      2001: OBJDUMP                Display information from object files.  [objdump]
                   2002:
1.133     lukem    2003: RANLIB         Generate index to archive.  [ranlib]
                   2004:
1.343     pooka    2005: READELF                Display information from ELF object files.  [readelf]
                   2006:
1.133     lukem    2007: SIZE           List section sizes and total size.  [size]
                   2008:
1.343     pooka    2009: STRINGS                Display printable character sequences in files.  [strings]
                   2010:
1.133     lukem    2011: STRIP          Discard symbols from object files.  [strip]
                   2012:
                   2013: TSORT          Topological sort of a directed graph.  [tsort -q]
                   2014:
                   2015: YACC           LALR(1) parser generator.  [yacc]
                   2016:
                   2017: YFLAGS         Options to ${YACC}.  []
                   2018:
                   2019: YHEADER                If defined, add "-d" to YFLAGS, and add dependencies
                   2020:                from <file>.y to <file>.h and <file>.c, and add
                   2021:                <foo>.h to CLEANFILES.
                   2022:
                   2023: YPREFIX                If defined, add "-p ${YPREFIX}" to YFLAGS.
                   2024:
1.116     lukem    2025:
1.69      sommerfe 2026: Other variables of note (incomplete list):
                   2027:
1.213     lukem    2028: NOGCCERROR     If defined, prevents passing certain ${CFLAGS} to GCC
                   2029:                that cause warnings to be fatal, such as:
                   2030:                        -Werror -Wa,--fatal-warnings
                   2031:                (The latter being for as(1).)
1.212     lukem    2032:
1.283     joerg    2033: NOCLANGERROR   If defined and clang is used as C compiler, -Werror is not
                   2034:                passed to it.
                   2035:
1.296     plunky   2036: WARNS          Crank up compiler warning options; the distinct levels are:
1.82      lukem    2037:                        WARNS=1
                   2038:                        WARNS=2
                   2039:                        WARNS=3
1.164     matt     2040:                        WARNS=4
1.296     plunky   2041:                        WARNS=5
1.336     christos 2042:                        WARNS=6
1.69      sommerfe 2043:
1.326     christos 2044: =-=-=-=-=   bsd.host.mk  =-=-=-=-=
1.144     lukem    2045:
1.326     christos 2046: This file is automatically included from bsd.own.mk. It contains settings
                   2047: for all the HOST_* variables that are used in host programs and libraries.
1.144     lukem    2048:
1.326     christos 2049: HOST_AR                        The host archive processing command
1.144     lukem    2050:
1.326     christos 2051: HOST_CC                        The host c compiler
1.144     lukem    2052:
1.326     christos 2053: HOST_CFLAGS            The host c compiler flags
1.144     lukem    2054:
1.326     christos 2055: HOST_COMPILE.c         The host c compiler line with flags
1.144     lukem    2056:
1.326     christos 2057: HOST_COMPILE.cc                The host c++ compiler line with flags
1.144     lukem    2058:
1.326     christos 2059: HOST_CPP               The host c pre-processor
1.144     lukem    2060:
1.326     christos 2061: HOST_CPPFLAGS          The cost c pre-processor flags
1.144     lukem    2062:
1.326     christos 2063: HOST_CXX               The host c++ compiler
1.144     lukem    2064:
1.326     christos 2065: HOST_CXXFLAGS          The host c++ compiler flags
1.144     lukem    2066:
1.326     christos 2067: HOST_INSTALL_DIR       The host command to install a directory
1.144     lukem    2068:
1.326     christos 2069: HOST_INSTALL_FILE      The host command to install a file
1.144     lukem    2070:
1.326     christos 2071: HOST_INSTALL_SYMLINK   The host command to install a symlink
1.144     lukem    2072:
1.326     christos 2073: HOST_LD                        The host linker command
1.144     lukem    2074:
1.326     christos 2075: HOST_LDFLAGS           The host linker flags
1.144     lukem    2076:
1.326     christos 2077: HOST_LINK.c            The host c linker line with flags
1.221     mrg      2078:
1.326     christos 2079: HOST_LINK.cc           The host c++ linker line with flags
1.144     lukem    2080:
1.326     christos 2081: HOST_LN                        The host command to link two files
1.144     lukem    2082:
1.326     christos 2083: HOST_MKDEP             The host command to create dependencies for c programs
1.144     lukem    2084:
1.326     christos 2085: HOST_MKDEPCXX          The host command to create dependencies for c++ programs
1.144     lukem    2086:
1.326     christos 2087: HOST_OSTYPE            The host OSNAME-RELEASE-ARCH tupple
1.144     lukem    2088:
1.326     christos 2089: HOST_RANLIB            The host command to create random access archives
1.144     lukem    2090:
1.326     christos 2091: HOST_SH                        The host Bourne shell interpreter name (absolute path)
1.144     lukem    2092:
1.30      agc      2093: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

CVSweb <webmaster@jp.NetBSD.org>