[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.269

1.269   ! jmmv        1: #      $NetBSD: bsd.README,v 1.268 2010/05/26 14:52:10 njoly 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.210     gmcgarry  116: MKATF          If "no", don't build libatf-c, libatf-c++ libraries associated
                    117:                with the Automated Testing Framework (ATF).
                    118:                Default: yes
                    119:
1.252     skrll     120: MKBFD          Obsolete, use MKBINUTILS
                    121:
1.266     joerg     122: MKBINUTILS     If "no", don't build binutils (gas, ld, etc and libbfd,
                    123:                libopcodes)
1.172     hubertf   124:                Default: yes
                    125:
1.266     joerg     126: MKBSDTAR       If "yes", use the libarchive based cpio and tar instead of
                    127:                the pax frontends.
                    128:                Default: no
                    129:
1.172     hubertf   130: MKCATPAGES     If "no", don't build or install the catman pages.
                    131:                Default: yes
                    132:
1.234     mrg       133: MKCOMPAT       If "no", don't build or install the src/compat.
                    134:                Default: yes on amd64/sparc64, no elsewhere.
                    135:
1.210     gmcgarry  136: MKCOMPLEX      If "no", don't build libm support for <complex.h>
                    137:                Default: yes
                    138:
1.172     hubertf   139: MKCRYPTO       If "no", no cryptography support will be built into the system,
1.174     christos  140:                and also acts as "MKKERBEROS=no".
1.172     hubertf   141:                Default: yes
                    142:
                    143: MKCRYPTO_IDEA  If not "no", IDEA support will be built into libcrypto_idea.a.
                    144:                Default: no
                    145:
                    146: MKCRYPTO_MDC2  If not "no", MDC2 support will be built into libcrypto_mdc2.a
                    147:                Default: no
                    148:
                    149: MKCRYPTO_RC5   If not "no", RC5 support will be built into libcrypto_rc5.a.
                    150:                Default: no
                    151:
                    152: MKCVS          If "no", don't build or install cvs(1).
                    153:                Default: yes
                    154:
1.184     lukem     155: MKDEBUG                If "no", don't build and install separate debugging symbols
                    156:                into /usr/libdata/debug.
                    157:                Default: no
                    158:
1.219     lukem     159: MKDEBUGLIB     Build *_g.a debugging libraries, which are compiled
                    160:                with -DDEBUG.
1.176     christos  161:                Default: no
                    162:
1.172     hubertf   163: MKDOC          If "no", don't build or install the documentation.
                    164:                Default: yes
                    165:
                    166: MKDYNAMICROOT  If "no", build programs in /bin and /sbin statically,
                    167:                don't install certain libraries in /lib, and don't
                    168:                install the shared linker into /libexec.
                    169:                Default: yes
                    170:
1.260     uebayasi  171: MKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
                    172:                to cross-build programs and libraries externally added by
                    173:                users, and automatically enables creation of those sets.
                    174:                Default: no
                    175:
1.201     lukem     176: MKGCC          If "no", don't build gcc(1) or any of the GCC-related
1.186     mrg       177:                libraries (libgcc, libobjc, libstdc++).
1.172     hubertf   178:                Default: yes
                    179:
1.201     lukem     180: MKGCCCMDS      If "no", don't build gcc(1), but do build the GCC-related
                    181:                libraries (libgcc, libobjc, libstdc++).
1.172     hubertf   182:                Default: yes
                    183:
                    184: MKGDB          If "no", don't build gdb(1).
                    185:                Default: yes
                    186:
                    187: MKHESIOD       If "no", disables building of Hesiod infrastructure
                    188:                (libraries and support programs).
                    189:                Default: yes
                    190:
                    191: MKHOSTOBJ      If not "no", for programs intended to be run on the compile
                    192:                host, the name, release, and architecture of the host
                    193:                operating system will be suffixed to the name of the object
                    194:                directory created by "make obj".
                    195:                Default: no
                    196:
1.222     lukem     197: MKHTML         If "no", don't build or install the HTML man pages.
                    198:                Default: yes
1.172     hubertf   199:
                    200: MKIEEEFP       If "no", don't add code for IEEE754/IEC60559 conformance.
                    201:                Has no effect on most platforms.
                    202:                Default: yes
                    203:
1.225     joerg     204: MKSTRIPIDENT   Strip the RCS IDs from program binaries and shared libraries.
                    205:                Default: no
                    206:
1.172     hubertf   207: MKINET6                If "no", disables building of INET6 (IPv6) infrastructure
                    208:                (libraries and support programs).
                    209:                Default: yes
                    210:
                    211: MKINFO         If "no", don't build or install Info documentation from
                    212:                Texinfo source files.
                    213:                Default: yes
                    214:
                    215: MKIPFILTER     If "no", don't build or install the IP Filter programs and LKM.
                    216:                Default: yes
                    217:
1.208     lukem     218: MKISCSI                If "no", don't build or install iSCSI library or applications
1.181     mrg       219:                (depends on libpthread.)
                    220:                Default: yes
                    221:
1.172     hubertf   222: MKKERBEROS     If "no", disables building of Kerberos v5
                    223:                infrastructure (libraries and support programs).
                    224:                Default: yes
                    225:
1.208     lukem     226: MKLDAP         If "no", disables building of LDAP infrastructure
                    227:                (libraries and support programs).
                    228:                Default: yes
                    229:
1.206     lukem     230: MKLINKLIB      If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
1.172     hubertf   231:                Also:
                    232:                        - don't install the .a libraries
                    233:                        - don't install _pic.a libraries on PIC systems
                    234:                        - don't build .a libraries on PIC systems
                    235:                        - don't install the .so symlink on ELF systems
                    236:                I.e, only install the shared library (and the .so.major
                    237:                symlink on ELF).
                    238:                Default: yes
                    239:
                    240: MKLINT         If "no", don't build or install the lint libraries.
                    241:                Default: yes
                    242:
1.261     tron      243: MKLVM          If "no", don't build or install the logical volume manager
1.245     agc       244:                and device mapper tools and libraries
1.262     tron      245:                Default: yes
1.245     agc       246:
1.172     hubertf   247: MKMAN          If "no", don't build or install the man or catman pages,
                    248:                and also acts as "MKCATPAGES=no MKHTML=no".
                    249:                Default: yes
                    250:
1.256     joerg     251: MKMANDOC       If "yes", mandoc is built as tool and used to compile
                    252:                catman or html pages.  A directory can be exempted by
                    253:                defining NOMANDOC.  Individual man pages are exempted
                    254:                if USETBL is set or NOMANDOC.${target} is set to "yes".
                    255:                Default: no
                    256:
1.172     hubertf   257: MKMANZ         If not "no", compress manual pages at installation time.
                    258:                Default: no
                    259:
1.253     tsarna    260: MKMDNS         If "no", disables building of mDNS infrastructure
                    261:                (libraries and support programs).
                    262:                Default: yes
                    263:
1.172     hubertf   264: MKNLS          If "no", don't build or install the NLS files and locale
                    265:                definition files.
                    266:                Default: yes
                    267:
                    268: MKOBJ          If "no", don't enable the rule which creates objdirs,
                    269:                and also acts as "MKOBJDIRS=no".
                    270:                Default: yes
                    271:
                    272: MKOBJDIRS      If "no", don't create objdirs during a "make build".
                    273:                Default: no
                    274:
                    275: MKPAM          If "no", disables building of PAM authentication
                    276:                infrastructure (libraries and support programs).
1.182     peter     277:                Default: yes
1.172     hubertf   278:
1.210     gmcgarry  279: MKPCC          If "no", don't build pcc(1) or any of the PCC-related
                    280:                libraries (libpcc, libpccsoftfloat).
                    281:                Default: no
                    282:
                    283: MKPCCCMDS      If "no", don't build pcc(1), but do build the PCC-related
                    284:                libraries (libpcc, libpccsoftfloat).
                    285:                Default: no
                    286:
1.172     hubertf   287: MKPF           If "no", don't build or install the pf programs and LKM.
                    288:                Default: yes
                    289:
                    290: MKPIC          If "no", don't build or install shared libraries, and
                    291:                also acts as "MKPICLIB=no"
                    292:                Default: yes (for MACHINE_ARCHs that support it)
                    293:
                    294: MKPICINSTALL   If "no", don't install the *_pic.a libraries.
                    295:                Default: yes
                    296:
                    297: MKPICLIB       If "no", don't build *_pic.a libraries, and build the
                    298:                shared object libraries from the .a libraries.
                    299:                A symlink is installed in ${DESTDIR}/usr/lib for the
                    300:                _pic.a library pointing to the .a library.
                    301:                Default: yes
                    302:
1.198     christos  303: MKPIE          If "no", create regular executables. Otherwise create
                    304:                PIE (Position Independent Executables).
                    305:                Default: no
                    306:
1.172     hubertf   307: MKPOSTFIX      If "no", don't build or install postfix(1).
                    308:                Default: yes
                    309:
                    310: MKPROFILE      If "no", don't build or install the profiling (*_p.a) libraries.
                    311:                Default: yes
                    312:
                    313: MKSHARE                If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
                    314:                MKMAN=no MKNLS=no".
                    315:                I.e, don't build catman pages, documentation, Info
                    316:                documentation, man pages, NLS files, ...
                    317:                Default: yes
                    318:
                    319: MKSKEY         If "no", disables building of S/key authentication
                    320:                infrastructure (libraries and support programs).
                    321:                Default: yes
                    322:
                    323: MKSOFTFLOAT    If not "no", build with options to enable the compiler to
                    324:                generate output containing library calls for floating
                    325:                point and possibly soft-float library support.
                    326:                Default: no
                    327:
                    328: MKSTATICLIB    If "no", don't build or install the normal static (*.a)
                    329:                libraries.
                    330:                Default: yes
                    331:
                    332: MKUNPRIVED     If not "no", don't set the owner/group/mode when installing
                    333:                files or directories, and keep a metadata log of what
                    334:                the owner/group/mode should be.  This allows a
                    335:                non-root "make install".
                    336:                Default: no
                    337:
                    338: MKUPDATE       If not "no", 'make install' only installs targets that are
                    339:                more recently modified in the source directories that their
                    340:                installed counterparts.
                    341:                Default: no
                    342:
1.237     mrg       343: MKX11          If not "no", depending on the value of ${X11FLAVOUR},
                    344:                'make build' also descends into either src/x11 (XFree86) or
                    345:                src/external/mit/xorg (modular Xorg) to cross-build X11 and
                    346:                automatically enables creation of X sets.
1.216     mrg       347:                Default: no
                    348:
1.251     mrg       349: MKX11FONTS     If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
                    350:                install the X fonts.  The xfont set is still created but
                    351:                will be empty.
                    352:                Default: yes
                    353:
1.172     hubertf   354: MKYP           If "no", disables building of YP (NIS)
                    355:                infrastructure (libraries and support programs).
                    356:                Default: yes
                    357:
1.254     haad      358: MKZFS          If "no", do not build and install utilities and libraries
                    359:                used to manage ZFS file system. Do not build zfs and solaris
                    360:                compatibility kernel modules.
                    361:                Default: no
                    362:
1.172     hubertf   363: USE_HESIOD     If "no", disables building Hesiod support into
                    364:                various system utilities/libraries that support it.
                    365:                If ${MKHESIOD} is "no", USE_HESIOD will also be
                    366:                forced to "no".
                    367:
                    368: USE_INET6      If "no", disables building INET6 (IPv6) support into
                    369:                various system utilities/libraries that support it.
                    370:                If ${MKINET6} is "no", USE_INET6 will also be
                    371:                forced to "no".
                    372:
1.197     ad        373: USE_JEMALLOC   If "no", disables building the "jemalloc" allocator
                    374:                designed for improved performance with threaded
                    375:                applications.  The "phkmalloc" allocator as used up
                    376:                before NetBSD-5.0 will be substituted.
                    377:
1.175     christos  378: USE_KERBEROS   If "no", disables building Kerberos v5
1.172     hubertf   379:                support into various system utilities/libraries that
                    380:                support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
                    381:                will also be forced to "no".
                    382:
1.208     lukem     383: USE_LDAP       If "no", disables building LDAP support into various
                    384:                system utilities/libraries that support it.
                    385:                If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
                    386:
1.172     hubertf   387: USE_PAM                If "no", disables building PAM authentication support
                    388:                into various system utilities/libraries that support it.
                    389:                If ${MKPAM} is "no", USE_PAM will also be forced to "no".
                    390:
                    391: USE_SKEY       If "no", disables building S/key authentication
                    392:                support into various system utilities/libraries that
                    393:                support it.  If ${MKSKEY} is "no", USE_SKEY will
                    394:                also be forced to "no".
1.204     lukem     395:                Default: no
1.172     hubertf   396:
1.201     lukem     397: USE_SSP                If "no", disables GCC stack protection code, which
1.257     tron      398:                detects stack overflows and aborts the program. The
1.268     njoly     399:                stack protection code imposes a performance penalty
1.259     pgoyette  400:                of about 5%.
1.258     tron      401:                Default: "no", unless "USE_FORT" is set to "yes"
1.187     christos  402:
1.246     christos  403: USE_FORT       If "yes" turns on substitute wrappers for commonly used
                    404:                functions that do not do bounds checking regularly, but
                    405:                they could in some cases by using the gcc
                    406:                __builtin_object_size() function to determine the buffer
                    407:                size where it is known and detect buffer overflows.
                    408:                These substitute functions are in /usr/include/ssp.
1.257     tron      409:                Default: depends on the part of the source tree
1.246     christos  410:
1.172     hubertf   411: USE_YP         If "no", disables building YP (NIS) support into
                    412:                various system utilities/libraries that support it.
                    413:                If ${MKYP} is "no", USE_YP will also be forced to "no".
                    414:
1.237     mrg       415: X11FLAVOUR     Set to "Xorg" or "XFree86", depending on whether to build
                    416:                XFree86 or modular Xorg.  Only matters if MKX11!=no.
1.242     mrg       417:                Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
                    418:                "XFree86" on everything else.
1.237     mrg       419:
1.172     hubertf   420: COPTS.lib<lib>
1.177     mrg       421: OBJCOPTS.lib<lib>
1.172     hubertf   422: LDADD.lib<lib>
                    423: CPPFLAGS.lib<lib>
                    424: CXXFLAGS.lib<lib>
                    425: COPTS.<prog>
1.177     mrg       426: OBJCCOPTS.<prog>
1.172     hubertf   427: LDADD.<prog>
                    428: CPPFLAGS.<prog>
                    429: CXXFLAGS.<prog>        These provide a way to specify additions to the associated
                    430:                variables in a way that applies only to a particular library
                    431:                or program.  <lib> corresponds to the LIB variable set in
                    432:                the library's makefile.  <prog> corresponds to either PROG
                    433:                or PROG_CXX (if set).  For example, if COPTS.libcrypto is
                    434:                set to "-g", "-g" will be added to COPTS only when compiling
                    435:                the crypto library.
1.118     lukem     436:
                    437: =-=-=-=-=   sys.mk   =-=-=-=-=
1.1       cgd       438:
                    439: The include file <sys.mk> has the default rules for all makes, in the BSD
                    440: environment or otherwise.  You probably don't want to touch this file.
                    441:
1.118     lukem     442: =-=-=-=-=   bsd.own.mk   =-=-=-=-=
1.1       cgd       443:
1.17      thorpej   444: The include file <bsd.own.mk> contains source tree configuration parameters,
                    445: such as the owners, groups, etc. for both manual pages and binaries, and
                    446: a few global "feature configuration" parameters.
1.1       cgd       447:
                    448: It has no targets.
                    449:
1.134     lukem     450: To get system-specific configuration parameters, <bsd.own.mk> will try to
1.29      cjs       451: include the file specified by the "MAKECONF" variable.  If MAKECONF is not
                    452: set, or no such file exists, the system make configuration file, /etc/mk.conf
                    453: is included.  These files may define any of the variables described below.
1.17      thorpej   454:
1.134     lukem     455: <bsd.own.mk> sets the following variables, if they are not already defined
1.17      thorpej   456: (defaults are in brackets):
1.15      cgd       457:
1.98      lukem     458: NETBSDSRCDIR   Top of the NetBSD source tree.
                    459:                If _SRC_TOP_ != "", that will be used as the default,
                    460:                otherwise BSDSRCDIR will be used as the default.
                    461:                Various makefiles within the NetBSD source tree will
                    462:                use this to reference the top level of the source tree.
                    463:
1.95      lukem     464: _SRC_TOP_      Top of the system source tree, as determined by <bsd.own.mk>
1.98      lukem     465:                based on the presence of tools/ and build.sh.  This variable
                    466:                is "internal" to <bsd.own.mk>, although its value is only
                    467:                determined once and then propagated to all sub-makes.
1.95      lukem     468:
1.15      cgd       469: BSDSRCDIR      The real path to the system sources, so that 'make obj'
1.116     lukem     470:                will work correctly.  [/usr/src]
1.15      cgd       471:
                    472: BSDOBJDIR      The real path to the system 'obj' tree, so that 'make obj'
1.116     lukem     473:                will work correctly.  [/usr/obj]
1.15      cgd       474:
1.116     lukem     475: BINGRP         Binary group.  [wheel]
1.15      cgd       476:
1.116     lukem     477: BINOWN         Binary owner.  [root]
1.15      cgd       478:
1.116     lukem     479: BINMODE                Binary mode.  [555]
1.15      cgd       480:
1.116     lukem     481: NONBINMODE     Mode for non-executable files.  [444]
1.15      cgd       482:
1.116     lukem     483: MANDIR         Base path for manual installation.  [/usr/share/man/cat]
1.15      cgd       484:
1.116     lukem     485: MANGRP         Manual group.  [wheel]
1.15      cgd       486:
1.116     lukem     487: MANOWN         Manual owner.  [root]
1.15      cgd       488:
1.116     lukem     489: MANMODE                Manual mode.  [${NONBINMODE}]
1.15      cgd       490:
1.222     lukem     491: MANINSTALL     Manual installation type.  Space separated list:
                    492:                        catinstall, htmlinstall, maninstall
                    493:                [catinstall maninstall htmlinstall]
1.76      fair      494:
                    495: LDSTATIC       Control program linking; if set blank, link everything
1.129     lukem     496:                dynamically.  If set to "-static", link everything statically.
1.76      fair      497:                If not set, programs link according to their makefile.
1.21      christos  498:
1.116     lukem     499: LIBDIR         Base path for library installation.  [/usr/lib]
1.15      cgd       500:
1.116     lukem     501: LINTLIBDIR     Base path for lint(1) library installation.  [/usr/libdata/lint]
1.15      cgd       502:
1.116     lukem     503: LIBGRP         Library group.  [${BINGRP}]
1.15      cgd       504:
1.116     lukem     505: LIBOWN         Library owner.  [${BINOWN}]
1.15      cgd       506:
1.116     lukem     507: LIBMODE                Library mode.  [${NONBINMODE}]
1.15      cgd       508:
                    509: DOCDIR         Base path for system documentation (e.g. PSD, USD, etc.)
1.116     lukem     510:                installation.  [/usr/share/doc]
1.62      simonb    511:
                    512: HTMLDOCDIR     Base path for html system documentation installation.
                    513:                [/usr/share/doc/html]
1.15      cgd       514:
1.116     lukem     515: DOCGRP         Documentation group.  [wheel]
1.15      cgd       516:
1.116     lukem     517: DOCOWN         Documentation owner.  [root]
1.15      cgd       518:
1.116     lukem     519: DOCMODE                Documentation mode.  [${NONBINMODE}]
1.15      cgd       520:
1.84      kleink    521: NLSDIR         Base path for Native Language Support files installation.
1.15      cgd       522:                [/usr/share/nls]
1.1       cgd       523:
1.116     lukem     524: NLSGRP         Native Language Support files group.  [wheel]
1.1       cgd       525:
1.116     lukem     526: NLSOWN         Native Language Support files owner.  [root]
1.1       cgd       527:
1.116     lukem     528: NLSMODE                Native Language Support files mode.  [${NONBINMODE}]
1.1       cgd       529:
1.255     apb       530: X11SRCDIR      The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
                    531:                if that exists; otherwise /usr/xsrc]
1.144     lukem     532:
1.221     mrg       533: X11SRCDIR.xc   The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
1.144     lukem     534:
1.221     mrg       535: X11SRCDIR.local        The path to the local X11 src tree.  [${X11SRCDIR}/local]
1.144     lukem     536:
1.221     mrg       537: X11SRCDIR.lib<package>
                    538: X11SRCDIR.<package>
                    539:                The path to the xorg src tree for the specificed package>.
                    540:                [${X11SRCDIR}/external/mit/xorg/<package>/dist]
                    541:
                    542: X11ROOTDIR     Root directory of the X11 installation.  [/usr/X11R6 or
                    543:                [/usr/X11R7]
1.144     lukem     544:
                    545: X11BINDIR      X11 bin directory.  [${X11ROOTDIR}/bin]
                    546:
                    547: X11FONTDIR     X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
                    548:
                    549: X11INCDIR      X11 include directory.  [${X11ROOTDIR}/include]
                    550:
                    551: X11LIBDIR      X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
                    552:
                    553: X11MANDIR      X11 manual directory.  [${X11ROOTDIR}/man]
                    554:
                    555: X11USRLIBDIR   X11 library directory.  [${X11ROOTDIR}/lib]
                    556:
1.32      mikel     557: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd       558:                to be stripped.  This is to be used when building your
                    559:                own install script so that the entire system can be made
1.146     lukem     560:                stripped/not-stripped using a single knob.  []
1.1       cgd       561:
1.2       cgd       562: COPY           The flag passed to the install program to cause the binary
                    563:                to be copied rather than moved.  This is to be used when
                    564:                building our own install script so that the entire system
                    565:                can either be installed with copies, or with moves using
1.116     lukem     566:                a single knob.  [-c]
1.15      cgd       567:
1.150     lukem     568: MAKEDIRTARGET dir target [params]
                    569:                Runs "cd $${dir} && ${MAKE} [params] $${target}",
                    570:                displaying a "pretty" message whilst doing so.
                    571:
1.152     cl        572: RELEASEMACHINEDIR
                    573:                Subdirectory used below RELEASEDIR when building
                    574:                a release.  [${MACHINE}]
                    575:
                    576: RELEASEMACHINE Subdirectory or path component used for the following
                    577:                paths:
                    578:                        distrib/${RELEASEMACHINE}
                    579:                        distrib/notes/${RELEASEMACHINE}
                    580:                        etc/etc.${RELEASEMACHINE}
                    581:                Used when building a release.  [${MACHINE}]
1.150     lukem     582:
1.134     lukem     583: Additionally, the following variables may be set by <bsd.own.mk> or in a
1.214     wiz       584: make configuration file to modify the behavior of the system build
1.17      thorpej   585: process (default values are in brackets along with comments, if set by
1.134     lukem     586: <bsd.own.mk>):
1.33      jonathan  587:
1.172     hubertf   588: USETOOLS       Indicates whether the tools specified by ${TOOLDIR} should
                    589:                be used as part of a build in progress.
                    590:                Supported values:
                    591:
                    592:                yes     Use the tools from TOOLDIR.
                    593:                        Must be set to this if cross-compiling.
                    594:
                    595:                no      Do not use the tools from TOOLDIR, but refuse to
                    596:                        build native compilation tool components that are
                    597:                        version-specific for that tool.
                    598:
                    599:                never   Do not use the tools from TOOLDIR, even when
                    600:                        building native tool components.  This is similar to
                    601:                        the traditional NetBSD build method, but does not
                    602:                        verify that the compilation tools in use are
                    603:                        up-to-date enough in order to build the tree
                    604:                        successfully.  This may cause build or runtime
                    605:                        problems when building the whole NetBSD source tree.
                    606:
                    607:                Default: "yes" if building all or part of a whole NetBSD
                    608:                source tree (detected automatically); "no" otherwise
                    609:                (to preserve traditional semantics of the <bsd.*.mk>
                    610:                make(1) include files).
1.142     lukem     611:
1.116     lukem     612: OBJECT_FMT     Object file format.  [set to "ELF" on architectures that
1.199     simonb    613:                use ELF -- currently all architectures].
1.33      jonathan  614:
1.103     thorpej   615: TOOLCHAIN_MISSING
1.142     lukem     616:                If not "no", this indicates that the platform being built
1.103     thorpej   617:                does not have a working in-tree toolchain.  If the
1.142     lukem     618:                ${MACHINE_ARCH} in question falls into this category,
                    619:                TOOLCHAIN_MISSING is conditionally assigned the value "yes".
1.103     thorpej   620:                Otherwise, the variable is unconditionally assigned the
                    621:                value "no".
1.252     skrll     622:                If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
1.142     lukem     623:                unconditionally assigned the value "no".
1.103     thorpej   624:
                    625: EXTERNAL_TOOLCHAIN
                    626:                This variable is not directly set by <bsd.own.mk>, but
                    627:                including <bsd.own.mk> is the canonical way to gain
                    628:                access to this variable.  The variable should be defined
                    629:                either in the user's environment or in the user's mk.conf
                    630:                file.  If defined, this variable indicates the root of
                    631:                an external toolchain which will be used to build the
1.142     lukem     632:                tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
1.103     thorpej   633:                platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
                    634:                cross-compile framework.
                    635:
1.142     lukem     636:                If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
                    637:                assigned the value "no", since the external version of the
                    638:                compiler may not be able to build the library components of
                    639:                the in-tree compiler.
1.103     thorpej   640:
                    641:                NOTE: This variable is not yet used in as many places as
                    642:                it should be.  Expect the exact semantics of this variable
                    643:                to change in the short term as parts of the cross-compile
                    644:                framework continue to be cleaned up.
1.1       cgd       645:
1.236     apb       646: The following variables are defined to commands to perform the
                    647: appropriate operation, with the default in [brackets].  Note that
                    648: the defaults change if USETOOLS == "yes":
                    649:
                    650: TOOL_AMIGAAOUT2BB      aout to Amiga bootblock converter.  [amiga-aout2bb]
                    651:
                    652: TOOL_AMIGAELF2BB       ELF to Amiga bootblock converter.  [amiga-elf2bb]
                    653:
                    654: TOOL_AMIGATXLT         Amige assembly language format translator.  [amiga-txlt]
                    655:
                    656: TOOL_ASN1_COMPILE      ASN1 compiler.  [asn1_compile]
                    657:
                    658: TOOL_AWK               Pattern-directed scanning/processing language.  [awk]
                    659:
                    660: TOOL_CAP_MKDB          Create capability database.  [cap_mkdb]
                    661:
                    662: TOOL_CAT               Concatenate and print files.  [cat]
                    663:
                    664: TOOL_CKSUM             Display file checksums.  [cksum]
                    665:
                    666: TOOL_COMPILE_ET                Error table compiler.  [compile_et]
                    667:
                    668: TOOL_CONFIG            Build kernel compilation directories.  [config]
                    669:
                    670: TOOL_CRUNCHGEN         Generate crunched binary build environment.  [crunchgen]
                    671:
                    672: TOOL_CTAGS             Create a tags file.  [ctags]
                    673:
                    674: TOOL_DB                        Manipulate db(3) databases.  [db]
                    675:
                    676: TOOL_DISKLABEL         Read and write disk pack label.  [disklabel]
                    677:
                    678: TOOL_EQN               Format equations for groff.  [eqn]
                    679:
                    680: TOOL_FDISK             MS-DOS partition maintenance program.  [fdisk]
                    681:
                    682: TOOL_FGEN              IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
                    683:
                    684: TOOL_GENASSYM          Generate constants for assembly files.  [genassym]
                    685:
                    686: TOOL_GENCAT            Generate NLS message catalogs.  [gencat]
                    687:
                    688: TOOL_GMAKE             GNU make utility.  [gmake]
                    689:
1.247     sketch    690: TOOL_GREP              Print lines matching a pattern.  [grep]
                    691:
1.236     apb       692: TOOL_GROFF             Front end for groff document formatting system.  [groff]
                    693:
                    694: TOOL_HEXDUMP           Ascii, decimal, hexadecimal, octal dump.  [hexdump]
                    695:
                    696: TOOL_HP300MKBOOT       Make bootable image for hp300.  [hp300-mkboot]
                    697:
                    698: TOOL_HP700MKBOOT       Make bootable image for hp700.  [hp700-mkboot]
                    699:
                    700: TOOL_INDXBIB           Make bibliographic database's inverted index.  [indxbib]
                    701:
                    702: TOOL_INSTALLBOOT       Install disk bootstrap software.  [installboot]
                    703:
                    704: TOOL_INSTALL_INFO      Update info/dir entries.  [install-info]
                    705:
                    706: TOOL_JOIN              Relational database operator.  [join]
                    707:
                    708: TOOL_M4                        M4 macro language processor.  [m4]
                    709:
                    710: TOOL_MACPPCFIXCOFF     Fix up xcoff headers for macppc.  [macppc-fixcoff]
                    711:
                    712: TOOL_MAKEFS            Create file system image from directory tree.  [makefs]
                    713:
                    714: TOOL_MAKEINFO          Translate Texinfo documents.  [makeinfo]
                    715:
                    716: TOOL_MAKEWHATIS                Create a whatis.db database.  [makewhatis]
                    717:
                    718: TOOL_MDSETIMAGE                Set kernel RAM disk image.  [mdsetimage]
                    719:
                    720: TOOL_MENUC             Menu compiler.  [menuc]
                    721:
                    722: TOOL_MIPSELF2ECOFF     Convert ELF-format executable to ECOFF for mips.
                    723:                        [mips-elf2ecoff]
                    724:
                    725: TOOL_MKCSMAPPER                Make charset mapping table.  [mkcsmapper]
                    726:
                    727: TOOL_MKESDB            Make encoding scheme database.  [mkesdb]
                    728:
                    729: TOOL_MKLOCALE          Make LC_CTYPE locale files.  [mklocale]
                    730:
                    731: TOOL_MKMAGIC           Create database for file(1).  [file]
                    732:
                    733: TOOL_MKTEMP            Make (unique) temporary file name.  [mktemp]
                    734:
                    735: TOOL_MSGC              Simple message list compiler.  [msgc]
                    736:
                    737: TOOL_MTREE             Map a directory hierarchy.  [mtree]
                    738:
                    739: TOOL_PAX               Manipulate file archives and copy directories.  [pax]
                    740:
                    741: TOOL_PIC               Compile pictures for groff.  [pic]
                    742:
                    743: TOOL_POWERPCMKBOOTIMAGE        Make bootable image for powerpc.  [powerpc-mkbootimage]
                    744:
                    745: TOOL_PWD_MKDB          Generate the password databases.  [pwd_mkdb]
                    746:
                    747: TOOL_REFER             Preprocess bibliographic references for groff.  [refer]
                    748:
                    749: TOOL_ROFF_ASCII                Generate ASCII groff output.  [nroff]
                    750:
                    751: TOOL_ROFF_DVI          Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
                    752:
                    753: TOOL_ROFF_HTML         Generate HTML groff output.
                    754:                        [${TOOL_GROFF} -Tlatin1 -mdoc2html]
                    755:
                    756: TOOL_ROFF_PS           Generate PS groff output.  [${TOOL_GROFF} -Tps]
                    757:
                    758: TOOL_ROFF_RAW          Generate "raw" groff output.  [${TOOL_GROFF} -Z]
                    759:
                    760: TOOL_RPCGEN            Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
                    761:
                    762: TOOL_SED               Stream editor.  [sed]
                    763:
                    764: TOOL_SOELIM            Eliminate .so's from groff input.  [soelim]
                    765:
                    766: TOOL_SPARKCRC          Generate a crc suitable for use in a sparkive file.
                    767:                        [sparkcrc]
                    768:
                    769: TOOL_STAT              Display file status.  [stat]
                    770:
                    771: TOOL_STRFILE           Create a random access file for storing strings.
                    772:                        [strfile]
                    773:
                    774: TOOL_SUNLABEL          Read or modify a SunOS disk label.  [sunlabel]
                    775:
                    776: TOOL_TBL               Format tables for groff.  [tbl]
                    777:
                    778: TOOL_UUDECODE          Uudecode a binary file.  [uudecode]
                    779:
                    780: TOOL_VGRIND            Grind nice listings of programs.  [vgrind -f]
                    781:
                    782: TOOL_ZIC               Time zone compiler.  [zic]
                    783:
1.134     lukem     784: <bsd.own.mk> is generally useful when building your own Makefiles so that
1.1       cgd       785: they use the same default owners etc. as the rest of the tree.
1.131     lukem     786:
                    787:
                    788: =-=-=-=-=   bsd.dep.mk   =-=-=-=-=
                    789:
                    790: The include file <bsd.dep.mk> contains the default targets for building
1.133     lukem     791: .depend files.  It creates .d files from entries in SRCS and DPSRCS
                    792: that are C, C++, or Objective C source files, and builds .depend from the
                    793: .d files.  All other files in SRCS and all of DPSRCS will be used as
                    794: dependencies for the .d files.  In order for this to function correctly,
1.132     lukem     795: it should be .included after all other .mk files and directives that may
                    796: modify SRCS or DPSRCS.  It uses the following variables:
                    797:
                    798: SRCS           List of source files to build the program.
                    799:
                    800: DPSRCS         List of source files which are needed for generating
                    801:                dependencies, but are not needed in ${SRCS}.
1.1       cgd       802:
                    803:
1.118     lukem     804: =-=-=-=-=   bsd.files.mk   =-=-=-=-=
1.106     thorpej   805:
1.118     lukem     806: The include file <bsd.files.mk> handles the FILES variables and is included
1.134     lukem     807: from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
1.124     lukem     808:
                    809: FILES          The list of files to install.
                    810:
1.153     lukem     811: CONFIGFILES    Similar semantics to FILES, except that the files
                    812:                are installed by the `configinstall' target,
                    813:                not the `install' target.
                    814:                The FILES* variables documented below also apply.
                    815:
1.124     lukem     816: FILESOWN       File owner.  [${BINOWN}]
                    817:
                    818: FILESGRP       File group.  [${BINGRP}]
                    819:
1.203     dholland  820: FILESMODE      File mode.  [${NONBINMODE}]
1.124     lukem     821:
                    822: FILESDIR       The location to install the files.
                    823:
                    824: FILESNAME      Optional name to install each file as.
                    825:
1.153     lukem     826: FILESOWN_<fn>  File owner of the specific file <fn>.
                    827:
                    828: FILESGRP_<fn>  File group of the specific file <fn>.
                    829:
                    830: FILESMODE_<fn> File mode of the specific file <fn>.
                    831:
1.202     uwe       832: FILESDIR_<fn>  The location to install the specific file <fn>.
1.153     lukem     833:
                    834: FILESNAME_<fn> Optional name to install <fn> as.
1.124     lukem     835:
1.243     cube      836: FILESBUILD_<fn>        A value different from "no" will add the file to the list of
                    837:                targets to be built by `realall'.  Users of that variable
                    838:                should provide a target to build the file.
                    839:
1.135     lukem     840:
1.139     lukem     841: BUILDSYMLINKS  List of two word items:
1.135     lukem     842:                        lnsrc lntgt
                    843:                For each lnsrc item, create a symlink named lntgt.
                    844:                The lntgt symlinks are removed by the cleandir target.
1.106     thorpej   845:
1.148     jmc       846: UUDECODE_FILES List of files which are stored as <file>.uue in the source
                    847:                tree. Each one will be decoded with ${TOOL_UUDECODE}.
                    848:                The source files have a `.uue' suffix, the generated files do
                    849:                not.
1.149     jmc       850:
1.202     uwe       851: UUDECODE_FILES_RENAME_<fn>
                    852:                Rename the output from the decode to the provided name.
1.148     jmc       853:
                    854:                *NOTE: These files are simply decoded, with no install or other
                    855:                       rule applying implicitly except being added to the clean
                    856:                       target.
1.106     thorpej   857:
1.118     lukem     858: =-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
1.113     thorpej   859:
                    860: The include file <bsd.gcc.mk> computes various parameters related to GCC
                    861: support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
1.134     lukem     862: before <bsd.gcc.mk>.
1.113     thorpej   863:
1.134     lukem     864: The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
1.113     thorpej   865: of which need to know where to find certain GCC support libraries.
                    866:
1.134     lukem     867: The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
1.113     thorpej   868: which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
                    869: the compiler is asked where to find the support libraries, otherwise the
                    870: support libraries are found in ${DESTDIR}/usr/lib.
                    871:
1.134     lukem     872: <bsd.gcc.mk> sets the following variables:
1.113     thorpej   873:
1.118     lukem     874: _GCC_CRTBEGIN  The full path name to crtbegin.o.
                    875:
                    876: _GCC_CRTBEGINS The full path name to crtbeginS.o.
                    877:
                    878: _GCC_CRTEND    The full path name to crtend.o.
                    879:
                    880: _GCC_CRTENDS   The full path name to crtendS.o.
                    881:
                    882: _GCC_LIBGCCDIR The directory where libgcc.a is located.
                    883:
                    884:
                    885: =-=-=-=-=   bsd.inc.mk   =-=-=-=-=
                    886:
1.134     lukem     887: The include file <bsd.inc.mk> defines the includes target and uses the
1.118     lukem     888: variables:
                    889:
1.124     lukem     890: INCS           The list of include files.
1.118     lukem     891:
                    892: INCSDIR                The location to install the include files.
                    893:
                    894: INCSNAME       Target name of the include file, if only one; same as
                    895:                FILESNAME, but for include files.
                    896:
1.134     lukem     897: INCSYMLINKS    Similar to SYMLINKS in <bsd.links.mk>, except that these
                    898:                are installed in the 'includes' target and not the
                    899:                (much later) 'install' target.
                    900:
1.118     lukem     901: INCSNAME_<file>        The name file <file> should be installed as, if not <file>,
                    902:                same as FILESNAME_<file>, but for include files.
                    903:
                    904:
                    905: =-=-=-=-=   bsd.info.mk   =-=-=-=-=
                    906:
                    907: The include file <bsd.info.mk> is used to generate and install GNU Info
                    908: documentation from respective Texinfo source files.  It defines three
                    909: implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
                    910: following variables:
                    911:
                    912: TEXINFO                List of Texinfo source files.  Info documentation will
                    913:                consist of single files with the extension replaced by
                    914:                .info.
                    915:
                    916: INFOFLAGS      Flags to pass to makeinfo.  []
                    917:
                    918:
                    919: =-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
                    920:
                    921: The include file <bsd.kernobj.mk> defines variables related to the
                    922: location of kernel sources and object directories.
                    923:
                    924: KERNSRCDIR     Is the location of the top of the kernel src.
1.124     lukem     925:                [${_SRC_TOP_}/sys]
1.118     lukem     926:
1.124     lukem     927: KERNARCHDIR    Is the location of the machine dependent kernel sources.
                    928:                [arch/${MACHINE}]
1.120     lukem     929:
1.124     lukem     930: KERNCONFDIR    Is where the configuration files for kernels are found.
                    931:                [${KERNSRCDIR}/${KERNARCHDIR}/conf]
1.118     lukem     932:
                    933: KERNOBJDIR     Is the kernel build directory.  The kernel GENERIC for
                    934:                instance will be compiled in ${KERNOBJDIR}/GENERIC.
                    935:                The default value is
                    936:                ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
                    937:                if it exists or the target 'obj' is being made.
                    938:                Otherwise the default is
                    939:                ${KERNSRCDIR}/${KERNARCHDIR}/compile.
                    940:
                    941: It is important that Makefiles (such as those under src/distrib) that
1.134     lukem     942: wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
1.118     lukem     943: rather than make assumptions about the location of the compiled kernel.
                    944:
                    945:
                    946: =-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
                    947:
                    948: The include file <bsd.kinc.mk> defines the many targets (includes,
                    949: subdirectories, etc.), and is used by kernel makefiles to handle
                    950: include file installation.  It is intended to be included alone, by
1.134     lukem     951: kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
                    952: Please see <bsd.kinc.mk> for more details, and keep the documentation
                    953: in that file up to date.
1.118     lukem     954:
                    955:
                    956: =-=-=-=-=   bsd.lib.mk   =-=-=-=-=
                    957:
                    958: The include file <bsd.lib.mk> has support for building libraries.  It has
                    959: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
                    960: includes, install, lint, and tags.  Additionally, it has a checkver target
                    961: which checks for installed shared object libraries whose version is greater
                    962: that the version of the source. It has a limited number of suffixes,
1.134     lukem     963: consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
1.118     lukem     964: <bsd.shlib.mk> to get shared library parameters.
                    965:
                    966: It sets/uses the following variables:
                    967:
                    968: LIB            The name of the library to build.
                    969:
                    970: LIBDIR         Target directory for libraries.
                    971:
1.248     perry     972: MKARZERO       Normally, ar(1) sets the timestamps, uid, gid and
                    973:                permissions in files inside its archives to those of
                    974:                the file it was fed. This leads to non-reproduceable
                    975:                builds. If MKARZERO is set to "yes" (default is "no")
                    976:                then the "D" flag is passed to ar, causing the
                    977:                timestamp, uid and gid to be zeroed and the file
                    978:                permissions to be set to 644. This allows .a files
                    979:                from different builds to be bit identical.
                    980:
1.118     lukem     981: SHLIBINSTALLDIR        Target directory for shared libraries if ${USE_SHLIBDIR}
1.142     lukem     982:                is not "no".
1.118     lukem     983:
1.263     abs       984: SHLIB_MAJOR
                    985: SHLIB_MINOR
                    986: SHLIB_TEENY    Major, minor, and teeny version numbers of shared library
                    987:
1.142     lukem     988: USE_SHLIBDIR   If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
1.118     lukem     989:                as the path to install shared libraries to.
                    990:                USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
1.130     lukem     991:                Default: no
1.118     lukem     992:
1.218     lukem     993: LIBISMODULE    If not "no", install as ${LIB}.so (without the "lib" prefix),
                    994:                and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
                    995:                MKPROFILE=no MKSTATICLIB=no".
                    996:                Default: no
                    997:
1.211     lukem     998: LIBISPRIVATE   If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
                    999:                MKPROFILE=no", and don't install the (.a) library.
1.154     lukem    1000:                This is useful for "build only" helper libraries.
                   1001:                Default: no
                   1002:
1.244     mrg      1003: LIBISCXX       If not "no", Use ${CXX} instead of ${CC} to link
                   1004:                shared libraries.
                   1005:                This is useful for C++ libraries.
                   1006:                Default: no
                   1007:
1.118     lukem    1008: LINTLIBDIR     Target directory for lint libraries.
                   1009:
                   1010: LIBGRP         Library group.
                   1011:
                   1012: LIBOWN         Library owner.
                   1013:
                   1014: LIBMODE                Library mode.
                   1015:
                   1016: LDADD          Additional loader objects.
                   1017:
                   1018: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                   1019:
                   1020: NOCHECKVER_<library>
                   1021: NOCHECKVER     If set, disables checking for installed shared object
                   1022:                libraries with versions greater than the source.  A
                   1023:                particular library name, without the "lib" prefix, may
                   1024:                be appended to the variable name to disable the check for
                   1025:                only that library.
                   1026:
                   1027: SRCS           List of source files to build the library.  Suffix types
                   1028:                .s, .c, and .f are supported.  Note, .s files are preferred
                   1029:                to .c files of the same name.  (This is not the default for
                   1030:                versions of make.)
                   1031:
1.157     lukem    1032: LIBDPLIBS      A list of the tuples:
                   1033:                        libname  path-to-srcdir-of-libname
                   1034:
                   1035:                For each tuple;
                   1036:                     *  LIBDO.libname contains the .OBJDIR of the library
                   1037:                        `libname', and if it is not set it is determined
                   1038:                        from the srcdir and added to MAKEOVERRIDES (the
                   1039:                        latter is to allow for build time optimization).
                   1040:                     *  LDADD gets  -L${LIBDO.libname} -llibname    added.
                   1041:                     *  DPADD gets  ${LIBDO.libname}/liblibname.so  or
                   1042:                                    ${LIBDO.libname}/liblibname.a   added.
                   1043:
                   1044:                This variable may be used for individual libraries, as
                   1045:                well as in parent directories to cache common libraries
                   1046:                as a build-time optimization.
                   1047:
1.118     lukem    1048: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
                   1049: if it exists, as well as the include file <bsd.man.mk>.
                   1050:
                   1051: It has rules for building profiled objects; profiled libraries are
                   1052: built by default.
                   1053:
                   1054: Libraries are ranlib'd when made.
                   1055:
                   1056:
                   1057: =-=-=-=-=   bsd.links.mk   =-=-=-=-=
                   1058:
                   1059: The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
1.134     lukem    1060: and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
                   1061:
1.249     apb      1062: LINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
                   1063: is used. The defaults may be modified by other bsd.*.mk files which
                   1064: include bsd.links.mk.  In the future, these variables may be replaced
                   1065: by a method for explicitly recording hard links in a metadata log.
                   1066:
1.134     lukem    1067: LINKS          The list of hard links, consisting of pairs of paths:
                   1068:                        source-file target-file
                   1069:                ${DESTDIR} is prepended to both paths before linking.
                   1070:                For example, to link /bin/test and /bin/[, use:
                   1071:                        LINKS=/bin/test /bin/[
                   1072:
1.153     lukem    1073: CONFIGLINKS    Similar semantics to LINKS, except that the links
                   1074:                are installed by the `configinstall' target,
                   1075:                not the `install' target.
                   1076:
1.134     lukem    1077: SYMLINKS       The list of symbolic links, consisting of pairs of paths:
                   1078:                        source-file target-file
                   1079:                ${DESTDIR} is only prepended to target-file before linking.
                   1080:                For example, to symlink /usr/bin/tar to /bin/tar resulting
                   1081:                in ${DESTDIR}/usr/bin/tar -> /bin/tar:
                   1082:                        SYMLINKS=/bin/tar /usr/bin/tar
1.118     lukem    1083:
1.153     lukem    1084: CONFIGSYMLINKS Similar semantics to SYMLINKS, except that the symbolic links
                   1085:                are installed by the `configinstall' target,
                   1086:                not the `install' target.
                   1087:
1.249     apb      1088: LINKSOWN       Link owner.  [${BINOWN}]
                   1089:
                   1090: LINKSGRP       Link group.  [${BINGRP}]
                   1091:
                   1092: LINKSMODE      Link mode.  [${NONBINMODE}]
                   1093:
                   1094: LINKSOWN_<fn>  Link owner of the specific file <fn>.
                   1095:
                   1096: LINKSGRP_<fn>  Link group of the specific file <fn>.
                   1097:
                   1098: LINKSMODE_<fn> Link mode of the specific file <fn>.
                   1099:
1.118     lukem    1100:
                   1101: =-=-=-=-=   bsd.man.mk   =-=-=-=-=
                   1102:
                   1103: The include file <bsd.man.mk> handles installing manual pages and their
                   1104: links.
                   1105:
1.222     lukem    1106: It has a three targets:
1.118     lukem    1107:
1.222     lukem    1108:        catinstall:
                   1109:                Install the preformatted manual pages and their links.
                   1110:        htmlinstall:
                   1111:                Install the HTML manual pages and their links.
1.118     lukem    1112:        maninstall:
                   1113:                Install the manual page sources and their links.
                   1114:
                   1115: It sets/uses the following variables:
                   1116:
                   1117: MANDIR         Base path for manual installation.
                   1118:
                   1119: MANGRP         Manual group.
                   1120:
                   1121: MANOWN         Manual owner.
                   1122:
                   1123: MANMODE                Manual mode.
                   1124:
                   1125: MANSUBDIR      Subdirectory under the manual page section, i.e. "/vax"
                   1126:                or "/tahoe" for machine specific manual pages.
                   1127:
                   1128: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                   1129:
                   1130: MLINKS         List of manual page links (using a .1 - .9 suffix).  The
                   1131:                linked-to file must come first, the linked file second,
                   1132:                and there may be multiple pairs.  The files are soft-linked.
                   1133:
                   1134: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
                   1135: it exists.
                   1136:
                   1137:
                   1138: =-=-=-=-=   bsd.obj.mk   =-=-=-=-=
                   1139:
                   1140: The include file <bsd.obj.mk> defines targets related to the creation
                   1141: and use of separated object and source directories.
                   1142:
                   1143: If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
                   1144: ${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
                   1145: it exists.  Otherwise make(1) looks for the existence of a
                   1146: subdirectory (or a symlink to a directory) of the source directory
                   1147: into which built targets should be placed.  If an environment variable
                   1148: named MAKEOBJDIR is set, make(1) uses its value as the name of the
                   1149: object directory; failing that, make first looks for a subdirectory
                   1150: named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
                   1151:
                   1152: Object directories are not created automatically by make(1) if they
                   1153: don't exist; you need to run a separate "make obj".  (This will happen
                   1154: during a top-level build if "MKOBJDIRS" is set to a value other than
                   1155: "no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
                   1156: and this is determined by a simple string prefix comparison -- object
                   1157: directories are created in a separate object directory tree, and a
                   1158: symlink to the object directory in that tree is created in the source
                   1159: directory; otherwise, "make obj" assumes that you're not in the main
                   1160: source tree and that it's not safe to use a separate object tree.
                   1161:
                   1162: Several variables used by <bsd.obj.mk> control exactly what
                   1163: directories and links get created during a "make obj":
                   1164:
                   1165: MAKEOBJDIR     If set, this is the component name of the object
                   1166:                directory.
                   1167:
                   1168: OBJMACHINE     If this is set but MAKEOBJDIR is not set, creates
                   1169:                object directories or links named "obj.${MACHINE}";
                   1170:                otherwise, just creates ones named "obj".
                   1171:
                   1172: USR_OBJMACHINE  If set, and the current directory is a subdirectory of
                   1173:                ${BSDSRCDIR}, create object directory in the
                   1174:                corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
                   1175:                otherwise, create it in the corresponding subdirectory
                   1176:                of ${BSDOBJDIR}
1.113     thorpej  1177:
1.118     lukem    1178: BUILDID                If set, the contents of this variable are appended
                   1179:                to the object directory name.  If OBJMACHINE is also
                   1180:                set, ".${BUILDID}" is added after ".${MACHINE}".
1.113     thorpej  1181:
1.106     thorpej  1182:
1.118     lukem    1183: =-=-=-=-=   bsd.prog.mk   =-=-=-=-=
1.106     thorpej  1184:
1.1       cgd      1185: The include file <bsd.prog.mk> handles building programs from one or
                   1186: more source files, along with their manual pages.  It has a limited number
1.134     lukem    1187: of suffixes, consistent with the current needs of the BSD tree.
                   1188: <bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
1.1       cgd      1189:
1.16      jtc      1190: It has eight targets:
1.1       cgd      1191:
                   1192:        all:
1.102     thorpej  1193:                build the program and its manual page.  This also
                   1194:                creates a GDB initialization file (.gdbinit) in
                   1195:                the objdir.  The .gdbinit file sets the shared library
                   1196:                prefix to ${DESTDIR} to facilitate cross-debugging.
1.1       cgd      1197:        clean:
                   1198:                remove the program, any object files and the files a.out,
1.24      mikel    1199:                Errs, errs, mklog, and ${PROG}.core.
1.1       cgd      1200:        cleandir:
                   1201:                remove all of the files removed by the target clean, as
                   1202:                well as .depend, tags, and any manual pages.
1.42      lukem    1203:                `distclean' is a synonym for `cleandir'.
1.1       cgd      1204:        depend:
                   1205:                make the dependencies for the source files, and store
                   1206:                them in the file .depend.
1.16      jtc      1207:        includes:
                   1208:                install any header files.
1.1       cgd      1209:        install:
                   1210:                install the program and its manual pages; if the Makefile
                   1211:                does not itself define the target install, the targets
                   1212:                beforeinstall and afterinstall may also be used to cause
                   1213:                actions immediately before and after the install target
                   1214:                is executed.
                   1215:        lint:
                   1216:                run lint on the source files
                   1217:        tags:
                   1218:                create a tags file for the source files.
                   1219:
                   1220: It sets/uses the following variables:
                   1221:
                   1222: BINGRP         Binary group.
                   1223:
                   1224: BINOWN         Binary owner.
                   1225:
                   1226: BINMODE                Binary mode.
                   1227:
                   1228: CLEANFILES     Additional files to remove for the clean and cleandir targets.
                   1229:
                   1230: COPTS          Additional flags to the compiler when creating C objects.
1.112     thorpej  1231:
1.125     lukem    1232: COPTS.<fn>     Additional flags to the compiler when creating the
                   1233:                C objects for <fn>.
                   1234:                For <fn>.[ly], "<fn>.c" must be used.
                   1235:
1.112     thorpej  1236: CPUFLAGS       Additional flags to the compiler/assembler to select
                   1237:                CPU instruction set options, CPU tuning options, etc.
1.35      lukem    1238:
1.125     lukem    1239: CPUFLAGS.<fn>  Additional flags to the compiler/assembler for <fn>.
                   1240:                For <fn>.[ly], "<fn>.c" must be used.
                   1241:
1.124     lukem    1242: CPPFLAGS       Additional flags to the C pre-processor.
1.125     lukem    1243:
                   1244: CPPFLAGS.<fn>  Additional flags to the C pre-processor for <fn>.
                   1245:                For <fn>.[ly], "<fn>.c" must be used.
1.102     thorpej  1246:
                   1247: GDBINIT                List of GDB initialization files to add to "source"
                   1248:                directives in the .gdbinit file that is created in the
                   1249:                objdir.
1.1       cgd      1250:
                   1251: LDADD          Additional loader objects.  Usually used for libraries.
                   1252:                For example, to load with the compatibility and utility
                   1253:                libraries, use:
                   1254:
1.5       jtc      1255:                        LDADD+=-lutil -lcompat
1.1       cgd      1256:
1.178     lukem    1257: LDFLAGS                Additional linker flags (passed to ${CC} during link).
1.1       cgd      1258:
1.134     lukem    1259: LINKS          See <bsd.links.mk>
                   1260:
1.177     mrg      1261: OBJCOPTS       Additional flags to the compiler when creating ObjC objects.
                   1262:
                   1263: OBJCOPTS.<fn>  Additional flags to the compiler when creating the
                   1264:                ObjC objects for <fn>.
                   1265:                For <fn>.[ly], "<fn>.c" must be used.
                   1266:
1.134     lukem    1267: SYMLINKS       See <bsd.links.mk>
1.1       cgd      1268:
1.15      cgd      1269: MAN            Manual pages (should end in .1 - .9).  If no MAN variable is
1.8       cgd      1270:                defined, "MAN=${PROG}.1" is assumed.
1.1       cgd      1271:
1.214     wiz      1272: PAXCTL_FLAGS   If defined, run paxctl(1) on the program binary after link
1.212     lukem    1273:                time, with the value of this variable as args to paxctl(1).
1.193     perry    1274:
                   1275: PAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
                   1276:
1.1       cgd      1277: PROG           The name of the program to build.  If not supplied, nothing
                   1278:                is built.
                   1279:
1.88      thorpej  1280: PROG_CXX       If defined, the name of the program to build.  Also
                   1281:                causes <bsd.prog.mk> to link the program with the C++
                   1282:                compiler rather than the C compiler.  PROG_CXX overrides
                   1283:                the value of PROG if PROG is also set.
1.87      thorpej  1284:
1.21      christos 1285: PROGNAME       The name that the above program will be installed as, if
                   1286:                different from ${PROG}.
                   1287:
1.37      tv       1288: SRCS           List of source files to build the program.  If SRCS is not
1.1       cgd      1289:                defined, it's assumed to be ${PROG}.c.
1.108     jwise    1290:
                   1291: DPSRCS         List of source files which are needed for generating
                   1292:                dependencies, but are not needed in ${SRCS}.
1.1       cgd      1293:
                   1294: DPADD          Additional dependencies for the program.  Usually used for
                   1295:                libraries.  For example, to depend on the compatibility and
                   1296:                utility libraries use:
                   1297:
1.5       jtc      1298:                        DPADD+=${LIBCOMPAT} ${LIBUTIL}
1.1       cgd      1299:
                   1300:                The following libraries are predefined for DPADD:
                   1301:
1.21      christos 1302:                LIBCRT0?=       ${DESTDIR}/usr/lib/crt0.o
1.196     joerg    1303:                LIBARCHIVE?=    ${DESTDIR}/usr/lib/libarchive.a
1.159     lukem    1304:                LIBASN1?=       ${DESTDIR}/usr/lib/libasn1.a
1.180     gdamore  1305:                LIBBLUETOOTH?=  ${DESTDIR}/usr/lib/libbluetooth.a
1.159     lukem    1306:                LIBBSDMALLOC?=  ${DESTDIR}/usr/lib/libbsdmalloc.a
1.99      itojun   1307:                LIBBZ2?=        ${DESTDIR}/usr/lib/libbz2.a
1.21      christos 1308:                LIBC?=          ${DESTDIR}/usr/lib/libc.a
                   1309:                LIBC_PIC?=      ${DESTDIR}/usr/lib/libc_pic.a
1.99      itojun   1310:                LIBCOM_ERR?=    ${DESTDIR}/usr/lib/libcom_err.a
1.21      christos 1311:                LIBCOMPAT?=     ${DESTDIR}/usr/lib/libcompat.a
                   1312:                LIBCRYPT?=      ${DESTDIR}/usr/lib/libcrypt.a
1.99      itojun   1313:                LIBCRYPTO?=     ${DESTDIR}/usr/lib/libcrypto.a
                   1314:                LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
1.105     itojun   1315:                LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
1.99      itojun   1316:                LIBCRYPTO_RC5?= ${DESTDIR}/usr/lib/libcrypto_rc5.a
1.21      christos 1317:                LIBCURSES?=     ${DESTDIR}/usr/lib/libcurses.a
                   1318:                LIBDBM?=        ${DESTDIR}/usr/lib/libdbm.a
                   1319:                LIBDES?=        ${DESTDIR}/usr/lib/libdes.a
                   1320:                LIBEDIT?=       ${DESTDIR}/usr/lib/libedit.a
1.114     provos   1321:                LIBEVENT?=      ${DESTDIR}/usr/lib/libevent.a
1.227     joerg    1322:                LIBFETCH?=      ${DESTDIR}/usr/lib/libfetch.a
1.73      blymn    1323:                LIBFORM?=       ${DESTDIR}/usr/lib/libform.a
1.21      christos 1324:                LIBGCC?=        ${DESTDIR}/usr/lib/libgcc.a
                   1325:                LIBGNUMALLOC?=  ${DESTDIR}/usr/lib/libgnumalloc.a
1.99      itojun   1326:                LIBGSSAPI?=     ${DESTDIR}/usr/lib/libgssapi.a
                   1327:                LIBHDB?=        ${DESTDIR}/usr/lib/libhdb.a
1.70      itojun   1328:                LIBINTL?=       ${DESTDIR}/usr/lib/libintl.a
1.49      itojun   1329:                LIBIPSEC?=      ${DESTDIR}/usr/lib/libipsec.a
1.99      itojun   1330:                LIBKADM5CLNT?=  ${DESTDIR}/usr/lib/libkadm5clnt.a
                   1331:                LIBKADM5SRV?=   ${DESTDIR}/usr/lib/libkadm5srv.a
                   1332:                LIBKAFS?=       ${DESTDIR}/usr/lib/libkafs.a
                   1333:                LIBKRB5?=       ${DESTDIR}/usr/lib/libkrb5.a
1.21      christos 1334:                LIBKVM?=        ${DESTDIR}/usr/lib/libkvm.a
                   1335:                LIBL?=          ${DESTDIR}/usr/lib/libl.a
1.208     lukem    1336:                LIBLBER?=       ${DESTDIR}/usr/lib/liblber.a
                   1337:                LIBLDAP?=       ${DESTDIR}/usr/lib/libldap.a
1.209     lukem    1338:                LIBLDAP_R?=     ${DESTDIR}/usr/lib/libldap_r.a
1.21      christos 1339:                LIBM?=          ${DESTDIR}/usr/lib/libm.a
1.53      blymn    1340:                LIBMENU?=       ${DESTDIR}/usr/lib/libmenu.a
1.99      itojun   1341:                LIBOBJC?=       ${DESTDIR}/usr/lib/libobjc.a
                   1342:                LIBOSSAUDIO?=   ${DESTDIR}/usr/lib/libossaudio.a
1.159     lukem    1343:                LIBPAM?=        ${DESTDIR}/usr/lib/libpam.a
1.21      christos 1344:                LIBPCAP?=       ${DESTDIR}/usr/lib/libpcap.a
1.99      itojun   1345:                LIBPCI?=        ${DESTDIR}/usr/lib/libpci.a
1.100     thorpej  1346:                LIBPMC?=        ${DESTDIR}/usr/lib/libpmc.a
1.26      kleink   1347:                LIBPOSIX?=      ${DESTDIR}/usr/lib/libposix.a
1.110     thorpej  1348:                LIBPTHREAD?=    ${DESTDIR}/usr/lib/libpthread.a
                   1349:                LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
1.163     christos 1350:                LIBRADIUS?=     ${DESTDIR}/usr/lib/libradius.a
1.21      christos 1351:                LIBRESOLV?=     ${DESTDIR}/usr/lib/libresolv.a
1.99      itojun   1352:                LIBRMT?=        ${DESTDIR}/usr/lib/librmt.a
                   1353:                LIBROKEN?=      ${DESTDIR}/usr/lib/libroken.a
1.21      christos 1354:                LIBRPCSVC?=     ${DESTDIR}/usr/lib/librpcsvc.a
1.110     thorpej  1355:                LIBRT?=         ${DESTDIR}/usr/lib/librt.a
1.21      christos 1356:                LIBSKEY?=       ${DESTDIR}/usr/lib/libskey.a
1.140     lukem    1357:                LIBSL?=         ${DESTDIR}/usr/lib/libsl.a
1.99      itojun   1358:                LIBSS?=         ${DESTDIR}/usr/lib/libss.a
1.159     lukem    1359:                LIBSSH?=        ${DESTDIR}/usr/lib/libssh.a
1.99      itojun   1360:                LIBSSL?=        ${DESTDIR}/usr/lib/libssl.a
1.187     christos 1361:                LIBSSP?=        ${DESTDIR}/usr/lib/libssp.a
1.140     lukem    1362:                LIBSTDCXX?=     ${DESTDIR}/usr/lib/libstdc++.a
1.186     mrg      1363:                LIBSUPCXX?=     ${DESTDIR}/usr/lib/libsupc++.a
1.264     roy      1364:                LIBTERMINFO?=   ${DESTDIR}/usr/lib/libterminfo.a
1.99      itojun   1365:                LIBUSBHID?=     ${DESTDIR}/usr/lib/libusbhid.a
1.21      christos 1366:                LIBUTIL?=       ${DESTDIR}/usr/lib/libutil.a
                   1367:                LIBWRAP?=       ${DESTDIR}/usr/lib/libwrap.a
                   1368:                LIBY?=          ${DESTDIR}/usr/lib/liby.a
                   1369:                LIBZ?=          ${DESTDIR}/usr/lib/libz.a
1.1       cgd      1370:
                   1371: SHAREDSTRINGS  If defined, a new .c.o rule is used that results in shared
1.12      christos 1372:                strings, using xstr(1). Note that this will not work with
                   1373:                parallel makes.
1.1       cgd      1374:
1.59      jlam     1375: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd      1376:                to be stripped.
                   1377:
                   1378: SUBDIR         A list of subdirectories that should be built as well.
                   1379:                Each of the targets will execute the same target in the
                   1380:                subdirectories.
                   1381:
1.21      christos 1382: SCRIPTS                A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
                   1383:                These are installed exactly like programs.
                   1384:
1.166     rtr      1385: SCRIPTSDIR     The location to install the scripts.  Each script can be
                   1386:                installed to a separate path by setting SCRIPTSDIR_<script>.
                   1387:
1.21      christos 1388: SCRIPTSNAME    The name that the above program will be installed as, if
                   1389:                different from ${SCRIPTS}. These can be further specialized
                   1390:                by setting SCRIPTSNAME_<script>.
                   1391:
1.124     lukem    1392: FILES          See description of <bsd.files.mk>.
1.21      christos 1393:
1.106     thorpej  1394: SHLINKDIR      Target directory for shared linker.  See description of
                   1395:                <bsd.own.mk> for additional information about this variable.
1.130     lukem    1396:
1.1       cgd      1397: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
                   1398: if it exists, as well as the include file <bsd.man.mk>.
                   1399:
                   1400: Some simple examples:
                   1401:
                   1402: To build foo from foo.c with a manual page foo.1, use:
                   1403:
                   1404:        PROG=   foo
                   1405:
                   1406:        .include <bsd.prog.mk>
                   1407:
                   1408: To build foo from foo.c with a manual page foo.2, add the line:
                   1409:
1.9       cgd      1410:        MAN=    foo.2
1.1       cgd      1411:
                   1412: If foo does not have a manual page at all, add the line:
                   1413:
1.75      agc      1414:        MKMAN=  no
1.1       cgd      1415:
                   1416: If foo has multiple source files, add the line:
                   1417:
                   1418:        SRCS=   a.c b.c c.c d.c
                   1419:
                   1420:
1.118     lukem    1421: =-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
                   1422:
                   1423: The include file <bsd.rpc.mk> contains a makefile fragment used to
                   1424: construct source files built by rpcgen.
1.72      sommerfe 1425:
1.118     lukem    1426: The following macros may be defined in makefiles which include
                   1427: <bsd.rpc.mk> in order to control which files get built and how they
                   1428: are to be built:
1.21      christos 1429:
1.118     lukem    1430: RPC_INCS:      construct .h file from .x file
1.120     lukem    1431: RPC_XDRFILES:  construct _xdr.c from .x file
1.118     lukem    1432:                (for marshalling/unmarshalling data types)
                   1433: RPC_SVCFILES:  construct _svc.c from .x file
                   1434:                (server-side stubs)
                   1435: RPC_SVCFLAGS:  Additional flags passed to builds of RPC_SVCFILES.
1.21      christos 1436:
1.118     lukem    1437: RPC_XDIR:      Directory containing .x/.h files
1.23      christos 1438:
                   1439:
1.118     lukem    1440: =-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1.21      christos 1441:
1.118     lukem    1442: The include file <bsd.shlib.mk> computes parameters for shared library
                   1443: installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1.134     lukem    1444: included before <bsd.shlib.mk>.
1.21      christos 1445:
1.134     lukem    1446: <bsd.own.mk> sets the following variables, if they are not already defined
1.118     lukem    1447: (defaults are in brackets):
1.21      christos 1448:
1.142     lukem    1449: SHLIBINSTALLDIR        If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
                   1450:                instead of ${LIBDIR} as the base path for shared library
                   1451:                installation.  [/lib]
1.21      christos 1452:
1.118     lukem    1453: SHLIBDIR       The path to USE_SHLIBDIR shared libraries to use when building
                   1454:                a program.  [/lib for programs in /bin and /sbin, /usr/lib
                   1455:                for all others.]
1.81      wiz      1456:
1.142     lukem    1457: _LIBSODIR      Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1.118     lukem    1458:                otherwise set to ${LIBDIR}
1.81      wiz      1459:
1.118     lukem    1460: SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1.39      cgd      1461:
1.118     lukem    1462: SHLINKDIR      Path to use for shared linker when building a program.
                   1463:                [/libexec for programs in /bin and /sbin, /usr/libexec for
                   1464:                all others.]
1.39      cgd      1465:
1.13      christos 1466:
1.118     lukem    1467: =-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1.13      christos 1468:
1.118     lukem    1469: The include file <bsd.subdir.mk> contains the default targets for building
1.120     lukem    1470: subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1.233     apb      1471: clean, cleandir, depend, includes, install, lint, and tags.  It uses the
                   1472: following variables:
                   1473:
                   1474: NOSUBDIR       If this variable is defined, then the SUBDIR variable
                   1475:                will be ignored and subdirectories will not be processed.
                   1476:
                   1477: SUBDIR         For all of the directories listed in ${SUBDIR}, the
                   1478:                specified directory will be visited and the target made.
                   1479:
                   1480:                As a special case, the use of a token .WAIT as an
                   1481:                entry in SUBDIR acts as a synchronization barrier
                   1482:                when multiple make jobs are run; subdirs before the
                   1483:                .WAIT must complete before any subdirs after .WAIT are
                   1484:                started.  See make(1) for some caveats on use of .WAIT
                   1485:                and other special sources.
1.47      tv       1486:
                   1487:
1.118     lukem    1488: =-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1.47      tv       1489:
1.13      christos 1490: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.14      cgd      1491: <bsd.lib.mk>.  It contains overrides that are used when building
1.133     lukem    1492: the NetBSD source tree.
                   1493:
                   1494: The following variables control how various files are compiled/built.
1.142     lukem    1495: (Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1.133     lukem    1496:
                   1497: AR             Create, modify, and extract from archives.  [ar]
                   1498:
                   1499: ARFLAGS                Options to ${AR}.  [rl]
                   1500:
1.151     lukem    1501: AS             Assembler.  [as]
                   1502:
1.211     lukem    1503: AFLAGS         Options to ${CC} when compiling or linking .s or .S
                   1504:                assembly source files.  []
1.151     lukem    1505:
1.217     joerg    1506: BUILDSEED      GCC uses random numbers when compiling C++ code.
                   1507:                If this option is present, seed the random number
                   1508:                generator based on the value, source file names and
                   1509:                the output file name to make builds more deterministic.
                   1510:                Additional information is available in the GCC
                   1511:                documentation of -frandom-seed.
                   1512:
1.133     lukem    1513: CC             C compiler.  [cc]
                   1514:
                   1515: CFLAGS         Options to ${CC}.  [Usually -O or -O2]
                   1516:
                   1517: CPP            C Pre-Processor.  [cpp]
                   1518:
                   1519: CPPFLAGS       Options to ${CPP}.  []
                   1520:
1.151     lukem    1521: CPUFLAGS       Optimization flags for ${CC}.  []
1.133     lukem    1522:
                   1523: CXX            C++ compiler.  [c++]
                   1524:
                   1525: CXXFLAGS       Options to ${CXX}.  [${CFLAGS}]
                   1526:
                   1527: ELF2ECOFF      Convert ELF-format executable to ECOFF.  [elf2ecoff]
                   1528:
                   1529: FC             Fortran compiler.  [f77]
                   1530:
                   1531: FFLAGS         Options to {$FC}.  [-O]
                   1532:
1.235     apb      1533: HOST_SH                Shell.  This must be an absolute path, because it may be
                   1534:                substituted into "#!" lines in scripts.  [/bin/sh]
                   1535:
1.133     lukem    1536: INSTALL                install(1) command.  [install]
                   1537:
                   1538: LEX            Lexical analyzer.  [lex]
                   1539:
                   1540: LFLAGS         Options to ${LEX}.  []
                   1541:
1.145     jwise    1542: LPREFIX                Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
                   1543:
1.133     lukem    1544: LD             Linker.  [ld]
                   1545:
1.178     lukem    1546: LDFLAGS                Options to ${CC} during the link process.  []
1.133     lukem    1547:
                   1548: LINT           C program verifier.  [lint]
                   1549:
1.173     perry    1550: LINTFLAGS      Options to ${LINT}.  [-chapbxzFS]
1.133     lukem    1551:
                   1552: LORDER         List dependencies for object files.  [lorder]
                   1553:
                   1554: MAKE           make(1).  [make]
                   1555:
                   1556: MKDEP          Construct Makefile dependency list.  [mkdep]
                   1557:
                   1558: NM             List symbols from object files.  [nm]
                   1559:
                   1560: PC             Pascal compiler.  [pc]  (Not present)
                   1561:
                   1562: PFLAGS         Options to ${PC}.  []
                   1563:
                   1564: OBJC           Objective C compiler.  [${CC}]
                   1565:
                   1566: OBJCFLAGS      Options to ${OBJC}.  [${CFLAGS}]
                   1567:
                   1568: OBJCOPY                Copy and translate object files.  [objcopy]
                   1569:
1.168     riz      1570: OBJDUMP                Display information from object files.  [objdump]
                   1571:
1.133     lukem    1572: RANLIB         Generate index to archive.  [ranlib]
                   1573:
                   1574: SIZE           List section sizes and total size.  [size]
                   1575:
                   1576: STRIP          Discard symbols from object files.  [strip]
                   1577:
                   1578: TSORT          Topological sort of a directed graph.  [tsort -q]
                   1579:
                   1580: YACC           LALR(1) parser generator.  [yacc]
                   1581:
                   1582: YFLAGS         Options to ${YACC}.  []
                   1583:
                   1584: YHEADER                If defined, add "-d" to YFLAGS, and add dependencies
                   1585:                from <file>.y to <file>.h and <file>.c, and add
                   1586:                <foo>.h to CLEANFILES.
                   1587:
                   1588: YPREFIX                If defined, add "-p ${YPREFIX}" to YFLAGS.
                   1589:
1.116     lukem    1590:
1.69      sommerfe 1591: Other variables of note (incomplete list):
                   1592:
1.213     lukem    1593: NOGCCERROR     If defined, prevents passing certain ${CFLAGS} to GCC
                   1594:                that cause warnings to be fatal, such as:
                   1595:                        -Werror -Wa,--fatal-warnings
                   1596:                (The latter being for as(1).)
1.212     lukem    1597:
                   1598: WARNS          Crank up GCC warning options; the distinct levels are:
1.82      lukem    1599:                        WARNS=1
                   1600:                        WARNS=2
                   1601:                        WARNS=3
1.164     matt     1602:                        WARNS=4
1.69      sommerfe 1603:
1.144     lukem    1604: =-=-=-=-=   bsd.x11.mk   =-=-=-=-=
                   1605:
                   1606: The include file <bsd.x11.mk> contains parameters and targets for
1.221     mrg      1607: cross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
1.144     lukem    1608: It should be included after the general Makefile contents but before
                   1609: the include files such as <bsd.prog.mk> and <bsd.lib.mk>.
                   1610:
                   1611: It provides the following targets:
                   1612:        .man.1 .man.3 .man.4 .man.5 .man.7:
                   1613:                If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1.221     mrg      1614:                these rules convert from X11's manual page source
1.144     lukem    1615:                into an mdoc.old source file.
                   1616:        cleanx11man:
                   1617:                Clean up the mdoc.old files generated by the above.
                   1618:
                   1619: It sets the following variables:
                   1620:
                   1621: BINDIR                 Set to ${X11BINDIR}.
                   1622:                        To override, define after including <bsd.x11.mk>
                   1623:
                   1624: LIBDIR                 Set to ${X11USRLIBDIR}.
                   1625:                        To override, define after including <bsd.x11.mk>
                   1626:
                   1627: MANDIR                 Set to ${X11MANDIR}.
                   1628:                        To override, define after including <bsd.x11.mk>
                   1629:
                   1630: CPPFLAGS               Appended with definitions to include from
                   1631:                        ${DESTDIR}${X11INCDIR}
                   1632:
                   1633: LDFLAGS                        Appended with definitions to link from
                   1634:                        ${DESTDIR}${X11USRLIBDIR}
                   1635:
1.221     mrg      1636: X11FLAGS.CONNECTION    Equivalent to X11's CONNECTION_FLAGS.
1.144     lukem    1637:
1.221     mrg      1638: X11FLAGS.EXTENSION     Equivalent to X11's EXT_DEFINES.
1.144     lukem    1639:
1.221     mrg      1640: X11FLAGS.LOADABLE      Equivalent to X11's LOADABLE.
1.144     lukem    1641:
1.221     mrg      1642: X11FLAGS.OS_DEFINES    Equivalent to X11's OS_DEFINES.
1.144     lukem    1643:
1.221     mrg      1644: X11FLAGS.SERVER                Equivalent to X11's ServerDefines.
1.144     lukem    1645:
1.221     mrg      1646: X11FLAGS.THREADLIB     Equivalent to X11's THREADS_DEFINES for libraries.
1.144     lukem    1647:
1.221     mrg      1648: X11FLAGS.THREADS       Equivalent to X11's THREADS_DEFINES.
1.144     lukem    1649:
                   1650: X11FLAGS.VERSION       cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
                   1651:
1.221     mrg      1652: X11FLAGS.DIX           Equivalent to X11's DIX_DEFINES.
                   1653:
1.144     lukem    1654: X11TOOL_UNXCOMM                Commandline to convert `XCOMM' comments to `#'
                   1655:
                   1656: It uses the following variables:
                   1657:
                   1658: APPDEFS                        List of app-default files to install.
                   1659:
                   1660: CPPSCRIPTS             List of files/scripts to run through cpp(1)
                   1661:                        and then ${X11TOOL_UNXCOMM}.  The source files
                   1662:                        have a `.cpp' suffix, the generated files do not.
                   1663:
                   1664: CPPSCRIPTFLAGS         Additional flags to cpp(1) when building CPPSCRIPTS.
                   1665:
                   1666: CPPSCRIPTFLAGS_<fn>    Additional flags to cpp(1) when building CPPSCRIPT <fn>.
                   1667:
                   1668:
1.30      agc      1669: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

CVSweb <webmaster@jp.NetBSD.org>