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

1.120   ! lukem       1: #      $NetBSD: bsd.README,v 1.119 2003/07/18 02:52:51 lukem Exp $
1.24      mikel       2: #      @(#)bsd.README  8.2 (Berkeley) 4/2/94
1.1       cgd         3:
                      4: This is the README file for the new make "include" files for the BSD
                      5: source tree.  The files are installed in /usr/share/mk, and are, by
1.11      jtc         6: 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.21      christos   59: object, and ".so" denotes a shared (position-independent) object.
1.97      itojun     60:
                     61: There are various make variables used during the build.  Basic rule for
                     62: the variable naming scheme is as follows:
                     63:
1.120   ! lukem      64: MKxxx          Can be set to "no" by a user to disable functionality.
        !            65:                Usually defaults to "yes".
1.97      itojun     66:
1.116     lukem      67: NOxxx          If defined, disables a feature.
                     68:                Not intended for users.
                     69:                This is to allow Makefiles to disable functionality
                     70:                that they don't support (such as missing man pages).
1.101     lukem      71:                NOxxx variables must be defined before <bsd.own.mk>
                     72:                is included.
1.21      christos   73:
1.45      lukem      74: The following variables that control how things are made/installed that
1.47      tv         75: are not set by default. These should not be set by Makefiles; they're for
                     76: the user to define in MAKECONF (see bsd.own.mk, below) or on the make(1)
                     77: command line:
1.21      christos   78:
1.45      lukem      79: BUILD          If defined, 'make install' checks that the targets in the
                     80:                source directories are up-to-date and remakes them if they
1.21      christos   81:                 are out of date, instead of blindly trying to install
1.79      wiz        82:                 out of date or non-existent targets.
1.21      christos   83:
1.120   ! lukem      84: MKBFD          If "no", don't build libbfd, libiberty, or any of the things
        !            85:                that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage).
        !            86:                Default: yes
        !            87:
        !            88: MKCRYPTO       If "no", no cryptography support will be built into the system,
        !            89:                and also acts as MKKERBEROS=no.
        !            90:                Default: yes
        !            91:
        !            92: MKCRYPTO_IDEA  If not "no", IDEA support will be built into libcrypto_idea.a.
        !            93:                Default: no
1.52      simonb     94:
1.120   ! lukem      95: MKCRYPTO_MDC2  If not "no", MDC2 support will be built into libcrypto_mdc2.a
        !            96:                Default: no
1.45      lukem      97:
1.120   ! lukem      98: MKCRYPTO_RC5   If not "no", RC5 support will be built into libcrypto_rc5.a.
        !            99:                Default: no
1.86      thorpej   100:
1.45      lukem     101: MKCATPAGES     If "no", don't build or install the catman pages.
1.120   ! lukem     102:                Default: yes
1.45      lukem     103:
                    104: MKDOC          If "no", don't build or install the documentation.
1.120   ! lukem     105:                Default: yes
1.86      thorpej   106:
1.104     lukem     107: MKDYNAMICROOT  If "no", build programs in /bin and /sbin statically,
                    108:                don't install certain libraries in /lib, and don't
                    109:                install the shared linker into /libexec.
1.120   ! lukem     110:                Default: yes
        !           111:
        !           112: MKGCC          If "no", don't build gcc or any of the gcc-related
        !           113:                libraries (libg2c, libgcc, libobjc, libstdc++).
        !           114:                Default: yes
1.104     lukem     115:
1.103     thorpej   116: MKGDB          If "no", don't build gdb.
1.120   ! lukem     117:                Default: yes
        !           118:
        !           119: MKHESIOD       If "no", disables building of Hesiod infrastructure
        !           120:                (libraries and support programs).
        !           121:                Default: yes
1.86      thorpej   122:
1.120   ! lukem     123: MKHTML         If "no", don't build or install the html man pages.
        !           124:                Default: yes
1.92      ross      125:
                    126: MKIEEEFP       If "no", don't add code for IEEE754/IEC60559 conformance.
                    127:                Has no effect on most platforms.
1.120   ! lukem     128:                Default: yes
1.45      lukem     129:
1.47      tv        130: MKINFO         If "no", don't build or install Info documentation from
                    131:                Texinfo source files.
1.120   ! lukem     132:                Default: yes
        !           133:
        !           134: MKKERBEROS     If "no", disables building of Kerberos (v4 or v5)
        !           135:                infrastructure (libraries and support programs).
        !           136:                Default: yes
        !           137:
        !           138: MKLINKLIB      If "no", act as "MKPICINSTALL=no MKPROFILE=no".
        !           139:                Also:
        !           140:                        - don't install the .a libraries
        !           141:                        - don't install _pic.a libraries on PIC systems
        !           142:                        - don't build .a libraries on PIC systems
        !           143:                        - don't install the .so symlink on ELF systems
        !           144:                I.e, only install the shared library (and the .so.major
        !           145:                symlink on ELF).
        !           146:                Default: yes
1.45      lukem     147:
                    148: MKLINT         If "no", don't build or install the lint libraries.
1.120   ! lukem     149:                Default: yes
1.45      lukem     150:
1.120   ! lukem     151: MKMAN          If "no", don't build or install the man or catman pages,
        !           152:                and also acts as "MKCATPAGES=no MKHTML=no"
        !           153:                Default: yes
1.45      lukem     154:
1.119     lukem     155: MKMANZ         If not "no", compress manual pages at installation time.
1.120   ! lukem     156:                Default: no
1.119     lukem     157:
1.74      itojun    158: MKNLS          If "no", don't build or install the NLS files and locale
                    159:                definition files.
1.120   ! lukem     160:                Default: yes
1.45      lukem     161:
1.120   ! lukem     162: MKOBJ          If "no", don't enable the rule which creates objdirs,
        !           163:                and also acts as "MKOBJDIRS=no"
        !           164:                Default: yes
1.55      sommerfe  165:
                    166: MKOBJDIRS      If "no", don't create objdirs during a "make build".
1.120   ! lukem     167:                Default: no
1.45      lukem     168:
1.120   ! lukem     169: MKPIC          If "no", don't build or install shared libraries, and
        !           170:                also acts as "MKPICLIB=no"
        !           171:                Default: yes
1.45      lukem     172:
                    173: MKPICINSTALL   If "no", don't install the *_pic.a libraries.
1.120   ! lukem     174:                Default: yes
        !           175:
        !           176: MKPICLIB       If "no", don't build *_pic.a libraries, and build the
        !           177:                shared object libraries from the .a libraries.
        !           178:                A symlink is installed in ${DESTDIR}/usr/lib for the
        !           179:                _pic.a library pointing to the .a library.
        !           180:                Default: yes
1.45      lukem     181:
                    182: MKPROFILE      If "no", don't build or install the profiling libraries.
1.120   ! lukem     183:                Default: yes
        !           184:
        !           185: MKSHARE                If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
        !           186:                MKMAN=no MKNLS=no".
        !           187:                I.e, don't build catman pages, documentation, Info
        !           188:                documentation, man pages, NLS files, ...
        !           189:                Default: yes
        !           190:
        !           191: MKSKEY         If "no", disables building of S/key authentication
        !           192:                infrastructure (libraries and support programs).
        !           193:                Default: yes
        !           194:
        !           195: MKSOFTFLOAT    If not "no", build with options to enable the compiler to
        !           196:                generate output containing library calls for floating
        !           197:                point and possibly soft-float library support.
        !           198:                Default: no
        !           199:
        !           200: MKUNPRIVED     If not "no", don't set the owner/group/mode when installing
        !           201:                files or directories, and keep a metadata log of what
        !           202:                the owner/group/mode should be.  This allows a
        !           203:                non-root "make install".
        !           204:                Default: no
        !           205:
        !           206: MKUPDATE       If not "no", 'make install' only installs targets that are
        !           207:                more recently modified in the source directories that their
        !           208:                installed counterparts.
        !           209:                Default: no
1.45      lukem     210:
1.120   ! lukem     211: MKYP           If "no", disables building of YP (NIS)
        !           212:                infrastructure (libraries and support programs).
        !           213:                Default: yes
1.1       cgd       214:
1.118     lukem     215:
                    216: =-=-=-=-=   sys.mk   =-=-=-=-=
1.1       cgd       217:
                    218: The include file <sys.mk> has the default rules for all makes, in the BSD
                    219: environment or otherwise.  You probably don't want to touch this file.
1.71      itojun    220: If you intend to run a cross build, you will need to supply the following
                    221: host tools, and configure the following variables properly:
                    222:
                    223: OBJCOPY                objcopy - copy and translate object files
                    224:
                    225: STRIP          strip - Discard symbols from object files
                    226:
1.1       cgd       227:
1.118     lukem     228: =-=-=-=-=   bsd.own.mk   =-=-=-=-=
1.1       cgd       229:
1.17      thorpej   230: The include file <bsd.own.mk> contains source tree configuration parameters,
                    231: such as the owners, groups, etc. for both manual pages and binaries, and
                    232: a few global "feature configuration" parameters.
1.1       cgd       233:
                    234: It has no targets.
                    235:
1.29      cjs       236: To get system-specific configuration parameters, bsd.own.mk will try to
                    237: include the file specified by the "MAKECONF" variable.  If MAKECONF is not
                    238: set, or no such file exists, the system make configuration file, /etc/mk.conf
                    239: is included.  These files may define any of the variables described below.
1.17      thorpej   240:
                    241: bsd.own.mk sets the following variables, if they are not already defined
                    242: (defaults are in brackets):
1.15      cgd       243:
1.98      lukem     244: NETBSDSRCDIR   Top of the NetBSD source tree.
                    245:                If _SRC_TOP_ != "", that will be used as the default,
                    246:                otherwise BSDSRCDIR will be used as the default.
                    247:                Various makefiles within the NetBSD source tree will
                    248:                use this to reference the top level of the source tree.
                    249:
1.95      lukem     250: _SRC_TOP_      Top of the system source tree, as determined by <bsd.own.mk>
1.98      lukem     251:                based on the presence of tools/ and build.sh.  This variable
                    252:                is "internal" to <bsd.own.mk>, although its value is only
                    253:                determined once and then propagated to all sub-makes.
1.95      lukem     254:
1.15      cgd       255: BSDSRCDIR      The real path to the system sources, so that 'make obj'
1.116     lukem     256:                will work correctly.  [/usr/src]
1.15      cgd       257:
                    258: BSDOBJDIR      The real path to the system 'obj' tree, so that 'make obj'
1.116     lukem     259:                will work correctly.  [/usr/obj]
1.15      cgd       260:
1.116     lukem     261: BINGRP         Binary group.  [wheel]
1.15      cgd       262:
1.116     lukem     263: BINOWN         Binary owner.  [root]
1.15      cgd       264:
1.116     lukem     265: BINMODE                Binary mode.  [555]
1.15      cgd       266:
1.116     lukem     267: NONBINMODE     Mode for non-executable files.  [444]
1.15      cgd       268:
1.116     lukem     269: MANDIR         Base path for manual installation.  [/usr/share/man/cat]
1.15      cgd       270:
1.116     lukem     271: MANGRP         Manual group.  [wheel]
1.15      cgd       272:
1.116     lukem     273: MANOWN         Manual owner.  [root]
1.15      cgd       274:
1.116     lukem     275: MANMODE                Manual mode.  [${NONBINMODE}]
1.15      cgd       276:
1.21      christos  277: MANINSTALL     Manual installation type: maninstall, catinstall, or both
1.76      fair      278:
                    279: LDSTATIC       Control program linking; if set blank, link everything
                    280:                dynamically. If set to "-static", link everything statically.
                    281:                If not set, programs link according to their makefile.
1.21      christos  282:
1.116     lukem     283: LIBDIR         Base path for library installation.  [/usr/lib]
1.15      cgd       284:
1.116     lukem     285: LINTLIBDIR     Base path for lint(1) library installation.  [/usr/libdata/lint]
1.15      cgd       286:
1.116     lukem     287: LIBGRP         Library group.  [${BINGRP}]
1.15      cgd       288:
1.116     lukem     289: LIBOWN         Library owner.  [${BINOWN}]
1.15      cgd       290:
1.116     lukem     291: LIBMODE                Library mode.  [${NONBINMODE}]
1.15      cgd       292:
                    293: DOCDIR         Base path for system documentation (e.g. PSD, USD, etc.)
1.116     lukem     294:                installation.  [/usr/share/doc]
1.62      simonb    295:
                    296: HTMLDOCDIR     Base path for html system documentation installation.
                    297:                [/usr/share/doc/html]
1.15      cgd       298:
1.116     lukem     299: DOCGRP         Documentation group.  [wheel]
1.15      cgd       300:
1.116     lukem     301: DOCOWN         Documentation owner.  [root]
1.15      cgd       302:
1.116     lukem     303: DOCMODE                Documentation mode.  [${NONBINMODE}]
1.15      cgd       304:
1.84      kleink    305: NLSDIR         Base path for Native Language Support files installation.
1.15      cgd       306:                [/usr/share/nls]
1.1       cgd       307:
1.116     lukem     308: NLSGRP         Native Language Support files group.  [wheel]
1.1       cgd       309:
1.116     lukem     310: NLSOWN         Native Language Support files owner.  [root]
1.1       cgd       311:
1.116     lukem     312: NLSMODE                Native Language Support files mode.  [${NONBINMODE}]
1.1       cgd       313:
1.32      mikel     314: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd       315:                to be stripped.  This is to be used when building your
                    316:                own install script so that the entire system can be made
1.116     lukem     317:                stripped/not-stripped using a single knob.  [-s]
1.1       cgd       318:
1.2       cgd       319: COPY           The flag passed to the install program to cause the binary
                    320:                to be copied rather than moved.  This is to be used when
                    321:                building our own install script so that the entire system
                    322:                can either be installed with copies, or with moves using
1.116     lukem     323:                a single knob.  [-c]
1.15      cgd       324:
1.17      thorpej   325: Additionally, the following variables may be set by bsd.own.mk or in a
                    326: make configuration file to modify the behaviour of the system build
                    327: process (default values are in brackets along with comments, if set by
                    328: bsd.own.mk):
1.111     thorpej   329:
1.94      thorpej   330: USE_HESIOD     If set to "no", disables building Hesiod support into
                    331:                various system utilities/libraries that support it.
                    332:                If MKHESIOD is set to "no", USE_HESIOD will also be
                    333:                forced to "no".
                    334:
                    335: USE_KERBEROS   If set to "no", disables building Kerberos (v4 or v5)
                    336:                support into various system utilities/libraries that
                    337:                support it.  If MKKERBEROS is set to "no", USE_KERBEROS
                    338:                will also be forced to "no".
                    339:
                    340: USE_SKEY       If set to "no", disables building S/key authentication
                    341:                support into various system utilities/libraries that
                    342:                support it.  If MKSKEY is set to "no", USE_SKEY will
                    343:                also be forced to "no".
                    344:
                    345: USE_YP         If set to "no", disables building YP (NIS) support into
                    346:                various system utilities/libraries that support it.  If
                    347:                MKYP is set to "no", USE_YP will also be forced to "no".
1.15      cgd       348:
                    349: NOPROFILE      Do not build profiled versions of system libraries
1.1       cgd       350:
1.15      cgd       351: NOPIC          Do not build PIC versions of system libraries, and
                    352:                do not build shared libraries.  [set if ${MACHINE_ARCH}
1.65      jlam      353:                is "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.]
1.1       cgd       354:
1.40      perry     355: NOLINT         Do not build lint libraries.
1.33      jonathan  356:
1.116     lukem     357: OBJECT_FMT     Object file format.  [set to "ELF" on architectures that
1.50      thorpej   358:                use ELF -- currently if ${MACHINE_ARCH} is "alpha",
                    359:                "mipsel", "mipseb", "powerpc", "sparc", "sparc64",
1.77      simonb    360:                "i386" and some m68k machines, or set to "a.out" on
                    361:                other architectures].
1.33      jonathan  362:
1.103     thorpej   363: TOOLCHAIN_MISSING
                    364:                If "yes", this indicates that the platform being built
                    365:                does not have a working in-tree toolchain.  If the
                    366:                MACHINE_ARCH in question falls into this category, the
                    367:                variable is conditionally assigned the value "yes".
                    368:                Otherwise, the variable is unconditionally assigned the
                    369:                value "no".
                    370:
                    371:                If TOOLCHAIN_MISSING is "yes", the variables MKBFD, MKGCC,
                    372:                and MKGDB are unconditionally assigned the value "no".
                    373:
                    374: EXTERNAL_TOOLCHAIN
                    375:                This variable is not directly set by <bsd.own.mk>, but
                    376:                including <bsd.own.mk> is the canonical way to gain
                    377:                access to this variable.  The variable should be defined
                    378:                either in the user's environment or in the user's mk.conf
                    379:                file.  If defined, this variable indicates the root of
                    380:                an external toolchain which will be used to build the
                    381:                tree.  For example, if a platform is a TOOLCHAIN_MISSING
                    382:                platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
                    383:                cross-compile framework.
                    384:
                    385:                If EXTERNAL_TOOLCHAIN is defined, the variable MKGCC is
                    386:                unconditionally assigned the value "no", since the external
                    387:                version of the compiler may not be able to build the library
                    388:                components of the in-tree compiler.
                    389:
                    390:                NOTE: This variable is not yet used in as many places as
                    391:                it should be.  Expect the exact semantics of this variable
                    392:                to change in the short term as parts of the cross-compile
                    393:                framework continue to be cleaned up.
1.1       cgd       394:
1.17      thorpej   395: bsd.own.mk is generally useful when building your own Makefiles so that
1.1       cgd       396: they use the same default owners etc. as the rest of the tree.
                    397:
                    398:
1.118     lukem     399: =-=-=-=-=   bsd.files.mk   =-=-=-=-=
1.106     thorpej   400:
1.118     lukem     401: The include file <bsd.files.mk> handles the FILES variables and is included
                    402: from bsd.lib.mk and bsd.prog.mk.
1.106     thorpej   403:
                    404:
1.118     lukem     405: =-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
1.113     thorpej   406:
                    407: The include file <bsd.gcc.mk> computes various parameters related to GCC
                    408: support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
                    409: before bsd.gcc.mk.
                    410:
                    411: The primary users of bsd.gcc.mk are <bsd.prog.mk> and <bsd.lib.mk>, each
                    412: of which need to know where to find certain GCC support libraries.
                    413:
                    414: The behavior of bsd.gcc.mk is influenced by the EXTERNAL_TOOLCHAIN variable,
                    415: which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
                    416: the compiler is asked where to find the support libraries, otherwise the
                    417: support libraries are found in ${DESTDIR}/usr/lib.
                    418:
                    419: bsd.gcc.mk sets the following variables:
                    420:
1.118     lukem     421: _GCC_CRTBEGIN  The full path name to crtbegin.o.
                    422:
                    423: _GCC_CRTBEGINS The full path name to crtbeginS.o.
                    424:
                    425: _GCC_CRTEND    The full path name to crtend.o.
                    426:
                    427: _GCC_CRTENDS   The full path name to crtendS.o.
                    428:
                    429: _GCC_LIBGCCDIR The directory where libgcc.a is located.
                    430:
                    431:
                    432: =-=-=-=-=   bsd.inc.mk   =-=-=-=-=
                    433:
                    434: The include file <bsd.inc.mk> defines the includes target and uses two
                    435: variables:
                    436:
                    437: INCS           The list of include files
                    438:
                    439: INCSDIR                The location to install the include files.
                    440:
                    441: INCSNAME       Target name of the include file, if only one; same as
                    442:                FILESNAME, but for include files.
                    443:
                    444: INCSNAME_<file>        The name file <file> should be installed as, if not <file>,
                    445:                same as FILESNAME_<file>, but for include files.
                    446:
                    447:
                    448: =-=-=-=-=   bsd.info.mk   =-=-=-=-=
                    449:
                    450: The include file <bsd.info.mk> is used to generate and install GNU Info
                    451: documentation from respective Texinfo source files.  It defines three
                    452: implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
                    453: following variables:
                    454:
                    455: TEXINFO                List of Texinfo source files.  Info documentation will
                    456:                consist of single files with the extension replaced by
                    457:                .info.
                    458:
                    459: INFOFLAGS      Flags to pass to makeinfo.  []
                    460:
                    461:
                    462: =-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
                    463:
                    464: The include file <bsd.kernobj.mk> defines variables related to the
                    465: location of kernel sources and object directories.
                    466:
                    467: KERNSRCDIR     Is the location of the top of the kernel src.
                    468:                It defaults to ${_SRC_TOP_}/sys
                    469:
                    470: KERNARCHDIR    Is the location of the machine dependent kernel
                    471:                sources.  It defaults to arch/${MACHINE}
1.120   ! lukem     472:
1.118     lukem     473: KERNCONFDIR    Is where the configuration files for kernels are
                    474:                found; default is ${KERNSRCDIR}/${KERNARCHDIR}/conf.
                    475:
                    476: KERNOBJDIR     Is the kernel build directory.  The kernel GENERIC for
                    477:                instance will be compiled in ${KERNOBJDIR}/GENERIC.
                    478:                The default value is
                    479:                ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
                    480:                if it exists or the target 'obj' is being made.
                    481:                Otherwise the default is
                    482:                ${KERNSRCDIR}/${KERNARCHDIR}/compile.
                    483:
                    484: It is important that Makefiles (such as those under src/distrib) that
                    485: wish to find compiled kernels use bsd.kernobj.mk and ${KERNOBJDIR}
                    486: rather than make assumptions about the location of the compiled kernel.
                    487:
                    488:
                    489: =-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
                    490:
                    491: The include file <bsd.kinc.mk> defines the many targets (includes,
                    492: subdirectories, etc.), and is used by kernel makefiles to handle
                    493: include file installation.  It is intended to be included alone, by
                    494: kernel Makefiles.  Please see bsd.kinc.mk for more details, and keep
                    495: the documentation in that file up to date.
                    496:
                    497:
                    498: =-=-=-=-=   bsd.lib.mk   =-=-=-=-=
                    499:
                    500: The include file <bsd.lib.mk> has support for building libraries.  It has
                    501: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
                    502: includes, install, lint, and tags.  Additionally, it has a checkver target
                    503: which checks for installed shared object libraries whose version is greater
                    504: that the version of the source. It has a limited number of suffixes,
                    505: consistent with the current needs of the BSD tree.  bsd.lib.mk includes
                    506: <bsd.shlib.mk> to get shared library parameters.
                    507:
                    508: It sets/uses the following variables:
                    509:
                    510: LIB            The name of the library to build.
                    511:
                    512: LIBDIR         Target directory for libraries.
                    513:
                    514: SHLIBINSTALLDIR        Target directory for shared libraries if ${USE_SHLIBDIR}
                    515:                is "yes".
                    516:
                    517: USE_SHLIBDIR   If "yes", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
                    518:                as the path to install shared libraries to.
                    519:                USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
                    520:
                    521: LINTLIBDIR     Target directory for lint libraries.
                    522:
                    523: LIBGRP         Library group.
                    524:
                    525: LIBOWN         Library owner.
                    526:
                    527: LIBMODE                Library mode.
                    528:
                    529: LDADD          Additional loader objects.
                    530:
                    531: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                    532:
                    533: NOCHECKVER_<library>
                    534: NOCHECKVER     If set, disables checking for installed shared object
                    535:                libraries with versions greater than the source.  A
                    536:                particular library name, without the "lib" prefix, may
                    537:                be appended to the variable name to disable the check for
                    538:                only that library.
                    539:
                    540: SRCS           List of source files to build the library.  Suffix types
                    541:                .s, .c, and .f are supported.  Note, .s files are preferred
                    542:                to .c files of the same name.  (This is not the default for
                    543:                versions of make.)
                    544:
                    545: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
                    546: if it exists, as well as the include file <bsd.man.mk>.
                    547:
                    548: It has rules for building profiled objects; profiled libraries are
                    549: built by default.
                    550:
                    551: Libraries are ranlib'd when made.
                    552:
                    553:
                    554: =-=-=-=-=   bsd.links.mk   =-=-=-=-=
                    555:
                    556: The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
                    557: and is included from from bsd.lib.mk and bsd.prog.mk.
                    558:
                    559:
                    560: =-=-=-=-=   bsd.man.mk   =-=-=-=-=
                    561:
                    562: The include file <bsd.man.mk> handles installing manual pages and their
                    563: links.
                    564:
                    565: It has a two targets:
                    566:
                    567:        maninstall:
                    568:                Install the manual page sources and their links.
                    569:        catinstall:
                    570:                Install the preformatted manual pages and their links.
                    571:
                    572: It sets/uses the following variables:
                    573:
                    574: MANDIR         Base path for manual installation.
                    575:
                    576: MANGRP         Manual group.
                    577:
                    578: MANOWN         Manual owner.
                    579:
                    580: MANMODE                Manual mode.
                    581:
                    582: MANSUBDIR      Subdirectory under the manual page section, i.e. "/vax"
                    583:                or "/tahoe" for machine specific manual pages.
                    584:
                    585: MAN            The manual pages to be installed (use a .1 - .9 suffix).
                    586:
                    587: MLINKS         List of manual page links (using a .1 - .9 suffix).  The
                    588:                linked-to file must come first, the linked file second,
                    589:                and there may be multiple pairs.  The files are soft-linked.
                    590:
                    591: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
                    592: it exists.
                    593:
                    594:
                    595: =-=-=-=-=   bsd.obj.mk   =-=-=-=-=
                    596:
                    597: The include file <bsd.obj.mk> defines targets related to the creation
                    598: and use of separated object and source directories.
                    599:
                    600: If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
                    601: ${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
                    602: it exists.  Otherwise make(1) looks for the existence of a
                    603: subdirectory (or a symlink to a directory) of the source directory
                    604: into which built targets should be placed.  If an environment variable
                    605: named MAKEOBJDIR is set, make(1) uses its value as the name of the
                    606: object directory; failing that, make first looks for a subdirectory
                    607: named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
                    608:
                    609: Object directories are not created automatically by make(1) if they
                    610: don't exist; you need to run a separate "make obj".  (This will happen
                    611: during a top-level build if "MKOBJDIRS" is set to a value other than
                    612: "no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
                    613: and this is determined by a simple string prefix comparison -- object
                    614: directories are created in a separate object directory tree, and a
                    615: symlink to the object directory in that tree is created in the source
                    616: directory; otherwise, "make obj" assumes that you're not in the main
                    617: source tree and that it's not safe to use a separate object tree.
                    618:
                    619: Several variables used by <bsd.obj.mk> control exactly what
                    620: directories and links get created during a "make obj":
                    621:
                    622: MAKEOBJDIR     If set, this is the component name of the object
                    623:                directory.
                    624:
                    625: OBJMACHINE     If this is set but MAKEOBJDIR is not set, creates
                    626:                object directories or links named "obj.${MACHINE}";
                    627:                otherwise, just creates ones named "obj".
                    628:
                    629: USR_OBJMACHINE  If set, and the current directory is a subdirectory of
                    630:                ${BSDSRCDIR}, create object directory in the
                    631:                corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
                    632:                otherwise, create it in the corresponding subdirectory
                    633:                of ${BSDOBJDIR}
1.113     thorpej   634:
1.118     lukem     635: BUILDID                If set, the contents of this variable are appended
                    636:                to the object directory name.  If OBJMACHINE is also
                    637:                set, ".${BUILDID}" is added after ".${MACHINE}".
1.113     thorpej   638:
1.106     thorpej   639:
1.118     lukem     640: =-=-=-=-=   bsd.prog.mk   =-=-=-=-=
1.106     thorpej   641:
1.1       cgd       642: The include file <bsd.prog.mk> handles building programs from one or
                    643: more source files, along with their manual pages.  It has a limited number
1.106     thorpej   644: of suffixes, consistent with the current needs of the BSD tree.  bsd.prog.mk
                    645: includes <bsd.shlib.mk> to get shared library parameters.
1.1       cgd       646:
1.16      jtc       647: It has eight targets:
1.1       cgd       648:
                    649:        all:
1.102     thorpej   650:                build the program and its manual page.  This also
                    651:                creates a GDB initialization file (.gdbinit) in
                    652:                the objdir.  The .gdbinit file sets the shared library
                    653:                prefix to ${DESTDIR} to facilitate cross-debugging.
1.1       cgd       654:        clean:
                    655:                remove the program, any object files and the files a.out,
1.24      mikel     656:                Errs, errs, mklog, and ${PROG}.core.
1.1       cgd       657:        cleandir:
                    658:                remove all of the files removed by the target clean, as
                    659:                well as .depend, tags, and any manual pages.
1.42      lukem     660:                `distclean' is a synonym for `cleandir'.
1.1       cgd       661:        depend:
                    662:                make the dependencies for the source files, and store
                    663:                them in the file .depend.
1.16      jtc       664:        includes:
                    665:                install any header files.
1.1       cgd       666:        install:
                    667:                install the program and its manual pages; if the Makefile
                    668:                does not itself define the target install, the targets
                    669:                beforeinstall and afterinstall may also be used to cause
                    670:                actions immediately before and after the install target
                    671:                is executed.
                    672:        lint:
                    673:                run lint on the source files
                    674:        tags:
                    675:                create a tags file for the source files.
                    676:
                    677: It sets/uses the following variables:
                    678:
                    679: BINGRP         Binary group.
                    680:
                    681: BINOWN         Binary owner.
                    682:
                    683: BINMODE                Binary mode.
                    684:
                    685: CLEANFILES     Additional files to remove for the clean and cleandir targets.
                    686:
                    687: COPTS          Additional flags to the compiler when creating C objects.
1.112     thorpej   688:
                    689: CPUFLAGS       Additional flags to the compiler/assembler to select
                    690:                CPU instruction set options, CPU tuning options, etc.
1.35      lukem     691:
                    692: CPPFLAGS       Additional flags to the C pre-processor
1.102     thorpej   693:
                    694: GDBINIT                List of GDB initialization files to add to "source"
                    695:                directives in the .gdbinit file that is created in the
                    696:                objdir.
1.1       cgd       697:
                    698: LDADD          Additional loader objects.  Usually used for libraries.
                    699:                For example, to load with the compatibility and utility
                    700:                libraries, use:
                    701:
1.5       jtc       702:                        LDADD+=-lutil -lcompat
1.1       cgd       703:
                    704: LDFLAGS                Additional loader flags.
                    705:
                    706: LINKS          The list of binary links; should be full pathnames, the
                    707:                linked-to file coming first, followed by the linked
                    708:                file.  The files are hard-linked.  For example, to link
                    709:                /bin/test and /bin/[, use:
                    710:
                    711:                        LINKS=  ${DESTDIR}/bin/test ${DESTDIR}/bin/[
1.19      perry     712:
                    713: SYMLINKS       The list of symbolic links; should be full pathnames.
1.20      perry     714:                 Syntax is identical to LINKS. Note that DESTDIR is not
                    715:                automatically included in the link.
1.1       cgd       716:
1.15      cgd       717: MAN            Manual pages (should end in .1 - .9).  If no MAN variable is
1.8       cgd       718:                defined, "MAN=${PROG}.1" is assumed.
1.1       cgd       719:
                    720: PROG           The name of the program to build.  If not supplied, nothing
                    721:                is built.
                    722:
1.88      thorpej   723: PROG_CXX       If defined, the name of the program to build.  Also
                    724:                causes <bsd.prog.mk> to link the program with the C++
                    725:                compiler rather than the C compiler.  PROG_CXX overrides
                    726:                the value of PROG if PROG is also set.
1.87      thorpej   727:
1.21      christos  728: PROGNAME       The name that the above program will be installed as, if
                    729:                different from ${PROG}.
                    730:
1.37      tv        731: SRCS           List of source files to build the program.  If SRCS is not
1.1       cgd       732:                defined, it's assumed to be ${PROG}.c.
1.108     jwise     733:
                    734: DPSRCS         List of source files which are needed for generating
                    735:                dependencies, but are not needed in ${SRCS}.
1.1       cgd       736:
                    737: DPADD          Additional dependencies for the program.  Usually used for
                    738:                libraries.  For example, to depend on the compatibility and
                    739:                utility libraries use:
                    740:
1.5       jtc       741:                        DPADD+=${LIBCOMPAT} ${LIBUTIL}
1.1       cgd       742:
                    743:                The following libraries are predefined for DPADD:
                    744:
1.21      christos  745:                LIBCRT0?=       ${DESTDIR}/usr/lib/crt0.o
1.99      itojun    746:                LIBBZ2?=        ${DESTDIR}/usr/lib/libbz2.a
1.21      christos  747:                LIBC?=          ${DESTDIR}/usr/lib/libc.a
                    748:                LIBC_PIC?=      ${DESTDIR}/usr/lib/libc_pic.a
1.99      itojun    749:                LIBCDK?=        ${DESTDIR}/usr/lib/libcdk.a
                    750:                LIBCOM_ERR?=    ${DESTDIR}/usr/lib/libcom_err.a
1.21      christos  751:                LIBCOMPAT?=     ${DESTDIR}/usr/lib/libcompat.a
                    752:                LIBCRYPT?=      ${DESTDIR}/usr/lib/libcrypt.a
1.99      itojun    753:                LIBCRYPTO?=     ${DESTDIR}/usr/lib/libcrypto.a
                    754:                LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
1.105     itojun    755:                LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
1.99      itojun    756:                LIBCRYPTO_RC5?= ${DESTDIR}/usr/lib/libcrypto_rc5.a
1.21      christos  757:                LIBCURSES?=     ${DESTDIR}/usr/lib/libcurses.a
                    758:                LIBDBM?=        ${DESTDIR}/usr/lib/libdbm.a
                    759:                LIBDES?=        ${DESTDIR}/usr/lib/libdes.a
                    760:                LIBEDIT?=       ${DESTDIR}/usr/lib/libedit.a
1.114     provos    761:                LIBEVENT?=      ${DESTDIR}/usr/lib/libevent.a
1.73      blymn     762:                LIBFORM?=       ${DESTDIR}/usr/lib/libform.a
1.21      christos  763:                LIBGCC?=        ${DESTDIR}/usr/lib/libgcc.a
                    764:                LIBGNUMALLOC?=  ${DESTDIR}/usr/lib/libgnumalloc.a
1.99      itojun    765:                LIBGSSAPI?=     ${DESTDIR}/usr/lib/libgssapi.a
                    766:                LIBHDB?=        ${DESTDIR}/usr/lib/libhdb.a
1.70      itojun    767:                LIBINTL?=       ${DESTDIR}/usr/lib/libintl.a
1.49      itojun    768:                LIBIPSEC?=      ${DESTDIR}/usr/lib/libipsec.a
1.99      itojun    769:                LIBKADM?=       ${DESTDIR}/usr/lib/libkadm.a
                    770:                LIBKADM5CLNT?=  ${DESTDIR}/usr/lib/libkadm5clnt.a
                    771:                LIBKADM5SRV?=   ${DESTDIR}/usr/lib/libkadm5srv.a
                    772:                LIBKAFS?=       ${DESTDIR}/usr/lib/libkafs.a
1.21      christos  773:                LIBKDB?=        ${DESTDIR}/usr/lib/libkdb.a
                    774:                LIBKRB?=        ${DESTDIR}/usr/lib/libkrb.a
1.99      itojun    775:                LIBKRB5?=       ${DESTDIR}/usr/lib/libkrb5.a
                    776:                LIBKSTREAM?=    ${DESTDIR}/usr/lib/libkstream.a
1.21      christos  777:                LIBKVM?=        ${DESTDIR}/usr/lib/libkvm.a
                    778:                LIBL?=          ${DESTDIR}/usr/lib/libl.a
                    779:                LIBM?=          ${DESTDIR}/usr/lib/libm.a
1.53      blymn     780:                LIBMENU?=       ${DESTDIR}/usr/lib/libmenu.a
1.21      christos  781:                LIBMP?=         ${DESTDIR}/usr/lib/libmp.a
1.25      christos  782:                LIBNTP?=        ${DESTDIR}/usr/lib/libntp.a
1.99      itojun    783:                LIBOBJC?=       ${DESTDIR}/usr/lib/libobjc.a
                    784:                LIBOSSAUDIO?=   ${DESTDIR}/usr/lib/libossaudio.a
1.21      christos  785:                LIBPC?=         ${DESTDIR}/usr/lib/libpc.a
                    786:                LIBPCAP?=       ${DESTDIR}/usr/lib/libpcap.a
1.99      itojun    787:                LIBPCI?=        ${DESTDIR}/usr/lib/libpci.a
1.21      christos  788:                LIBPLOT?=       ${DESTDIR}/usr/lib/libplot.a
1.100     thorpej   789:                LIBPMC?=        ${DESTDIR}/usr/lib/libpmc.a
1.26      kleink    790:                LIBPOSIX?=      ${DESTDIR}/usr/lib/libposix.a
1.110     thorpej   791:                LIBPTHREAD?=    ${DESTDIR}/usr/lib/libpthread.a
                    792:                LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
1.21      christos  793:                LIBRESOLV?=     ${DESTDIR}/usr/lib/libresolv.a
1.99      itojun    794:                LIBRMT?=        ${DESTDIR}/usr/lib/librmt.a
                    795:                LIBROKEN?=      ${DESTDIR}/usr/lib/libroken.a
1.21      christos  796:                LIBRPCSVC?=     ${DESTDIR}/usr/lib/librpcsvc.a
1.110     thorpej   797:                LIBRT?=         ${DESTDIR}/usr/lib/librt.a
1.21      christos  798:                LIBSKEY?=       ${DESTDIR}/usr/lib/libskey.a
1.99      itojun    799:                LIBSS?=         ${DESTDIR}/usr/lib/libss.a
                    800:                LIBSSL?=        ${DESTDIR}/usr/lib/libssl.a
                    801:                LIBSKEY?=       ${DESTDIR}/usr/lib/libskey.a
                    802:                LIBSL?=         ${DESTDIR}/usr/lib/libsl.a
1.21      christos  803:                LIBTERMCAP?=    ${DESTDIR}/usr/lib/libtermcap.a
1.99      itojun    804:                LIBUSBHID?=     ${DESTDIR}/usr/lib/libusbhid.a
1.21      christos  805:                LIBUTIL?=       ${DESTDIR}/usr/lib/libutil.a
                    806:                LIBWRAP?=       ${DESTDIR}/usr/lib/libwrap.a
                    807:                LIBY?=          ${DESTDIR}/usr/lib/liby.a
                    808:                LIBZ?=          ${DESTDIR}/usr/lib/libz.a
1.1       cgd       809:
                    810: SHAREDSTRINGS  If defined, a new .c.o rule is used that results in shared
1.12      christos  811:                strings, using xstr(1). Note that this will not work with
                    812:                parallel makes.
1.1       cgd       813:
1.59      jlam      814: STRIPFLAG      The flag passed to the install program to cause the binary
1.1       cgd       815:                to be stripped.
                    816:
                    817: SUBDIR         A list of subdirectories that should be built as well.
                    818:                Each of the targets will execute the same target in the
                    819:                subdirectories.
                    820:
1.21      christos  821: SCRIPTS                A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
                    822:                These are installed exactly like programs.
                    823:
                    824: SCRIPTSNAME    The name that the above program will be installed as, if
                    825:                different from ${SCRIPTS}. These can be further specialized
                    826:                by setting SCRIPTSNAME_<script>.
                    827:
                    828: FILES          A list of files to install. The installation is controlled
                    829:                by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR
                    830:                variables that can be further specialized by FILES<VAR>_<file>
                    831:
1.106     thorpej   832: SHLINKDIR      Target directory for shared linker.  See description of
                    833:                <bsd.own.mk> for additional information about this variable.
1.85      lukem     834:
1.1       cgd       835: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
                    836: if it exists, as well as the include file <bsd.man.mk>.
                    837:
                    838: Some simple examples:
                    839:
                    840: To build foo from foo.c with a manual page foo.1, use:
                    841:
                    842:        PROG=   foo
                    843:
                    844:        .include <bsd.prog.mk>
                    845:
                    846: To build foo from foo.c with a manual page foo.2, add the line:
                    847:
1.9       cgd       848:        MAN=    foo.2
1.1       cgd       849:
                    850: If foo does not have a manual page at all, add the line:
                    851:
1.75      agc       852:        MKMAN=  no
1.1       cgd       853:
                    854: If foo has multiple source files, add the line:
                    855:
                    856:        SRCS=   a.c b.c c.c d.c
                    857:
                    858:
1.118     lukem     859: =-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
                    860:
                    861: The include file <bsd.rpc.mk> contains a makefile fragment used to
                    862: construct source files built by rpcgen.
1.72      sommerfe  863:
1.118     lukem     864: The following macros may be defined in makefiles which include
                    865: <bsd.rpc.mk> in order to control which files get built and how they
                    866: are to be built:
1.21      christos  867:
1.118     lukem     868: RPC_INCS:      construct .h file from .x file
1.120   ! lukem     869: RPC_XDRFILES:  construct _xdr.c from .x file
1.118     lukem     870:                (for marshalling/unmarshalling data types)
                    871: RPC_SVCFILES:  construct _svc.c from .x file
                    872:                (server-side stubs)
                    873: RPC_SVCFLAGS:  Additional flags passed to builds of RPC_SVCFILES.
1.21      christos  874:
1.118     lukem     875: RPC_XDIR:      Directory containing .x/.h files
1.23      christos  876:
                    877:
1.118     lukem     878: =-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1.21      christos  879:
1.118     lukem     880: The include file <bsd.shlib.mk> computes parameters for shared library
                    881: installation and use.  It defines no targets.  <bsd.own.mk> MUST be
                    882: included before bsd.shlib.mk.
1.21      christos  883:
1.118     lukem     884: bsd.own.mk sets the following variables, if they are not already defined
                    885: (defaults are in brackets):
1.21      christos  886:
1.118     lukem     887: SHLIBINSTALLDIR        If ${USE_SHLIBDIR} is "yes", use ${SHLIBINSTALLDIR} instead of
                    888:                ${LIBDIR} as the base path for shared library installation.
                    889:                [/lib]
1.21      christos  890:
1.118     lukem     891: SHLIBDIR       The path to USE_SHLIBDIR shared libraries to use when building
                    892:                a program.  [/lib for programs in /bin and /sbin, /usr/lib
                    893:                for all others.]
1.81      wiz       894:
1.118     lukem     895: _LIBSODIR      Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is "yes",
                    896:                otherwise set to ${LIBDIR}
1.81      wiz       897:
1.118     lukem     898: SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1.39      cgd       899:
1.118     lukem     900: SHLINKDIR      Path to use for shared linker when building a program.
                    901:                [/libexec for programs in /bin and /sbin, /usr/libexec for
                    902:                all others.]
1.39      cgd       903:
1.13      christos  904:
1.118     lukem     905: =-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1.13      christos  906:
1.118     lukem     907: The include file <bsd.subdir.mk> contains the default targets for building
1.120   ! lukem     908: subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1.118     lukem     909: clean, cleandir, depend, includes, install, lint, and tags.  For all of
1.120   ! lukem     910: the directories listed in the variable SUBDIR, the specified directory
1.118     lukem     911: will be visited and the target made.  There is also a default target which
                    912: allows the command "make subdir" where subdir is any directory listed in
                    913: the variable SUBDIR.
1.47      tv        914:
1.118     lukem     915: As a special case, the use of a token .WAIT as an entry in SUBDIR acts
                    916: as a synchronization barrier when multiple make jobs are run; subdirs
                    917: before the .WAIT must complete before any subdirs after .WAIT are
                    918: started.  See make(1) for some caveats on use of .WAIT and other
                    919: special sources.
1.47      tv        920:
                    921:
1.118     lukem     922: =-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1.47      tv        923:
1.13      christos  924: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.14      cgd       925: <bsd.lib.mk>.  It contains overrides that are used when building
                    926: the NetBSD source tree.  For instance, if "PARALLEL" is defined by
                    927: the program/library Makefile, it includes a set of rules for lex and
                    928: yacc that allow multiple lex and yacc targets to be built in parallel.
1.116     lukem     929:
                    930: The following variables are defined to commands to perform the
                    931: appropriate operation, with the default in [brackets].
                    932: (Note that these are overridden in <bsd.own.mk> if USETOOLS=yes):
                    933:
                    934: TOOL_ASN1_COMPILE      ASN1 compiler.  [asn1_compile]
                    935:
                    936: TOOL_CAP_MKDB          Create capability database.  [cap_mkdb]
                    937:
                    938: TOOL_CAT               Concatenate and print files.  [cat]
                    939:
                    940: TOOL_CKSUM             Display file checksums.  [cksum]
                    941:
                    942: TOOL_COMPILE_ET                Error table compiler.  [compile_et]
                    943:
                    944: TOOL_CONFIG            Build kernel compilation directories.  [config]
                    945:
                    946: TOOL_CRUNCHGEN         Generate crunched binary build environment.  [crunchgen]
                    947:
                    948: TOOL_CTAGS             Create a tags file.  [ctags]
                    949:
                    950: TOOL_DB                        Manipulate db(3) databases.  [db]
                    951:
                    952: TOOL_EQN               Format equations for groff.  [eqn]
                    953:
                    954: TOOL_FGEN              IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
                    955:
                    956: TOOL_GENCAT            Generate NLS message catalogs.  [gencat]
                    957:
                    958: TOOL_GROFF             Front end for groff document formatting system.  [groff]
                    959:
                    960: TOOL_HEXDUMP           Ascii, decimal, hexadecimal, octal dump.  [hexdump]
                    961:
                    962: TOOL_INDXBIB           Make bibliographic database's inverted index.  [indxbib]
                    963:
                    964: TOOL_INSTALLBOOT       Install disk bootstrap software.  [installboot]
                    965:
                    966: TOOL_INSTALL_INFO      Update info/dir entries.  [install-info]
                    967:
                    968: TOOL_M4                        M4 macro language processor.  [m4]
                    969:
                    970: TOOL_MAKEFS            Create file system image from directory tree.  [makefs]
                    971:
                    972: TOOL_MAKEINFO          Translate Texinfo documents.  [makeinfo]
                    973:
                    974: TOOL_MAKEWHATIS                Create a whatis.db database.  [makewhatis]
                    975:
                    976: TOOL_MDSETIMAGE                Set kernel RAM disk image.  [mdsetimage]
                    977:
                    978: TOOL_MENUC             Menu compiler.  [menuc]
                    979:
                    980: TOOL_MKCSMAPPER                Make charset mapping table.  [mkcsmapper]
                    981:
                    982: TOOL_MKESDB            Make encoding scheme database.  [mkesdb]
                    983:
                    984: TOOL_MKLOCALE          Make LC_CTYPE locale files.  [mklocale]
                    985:
                    986: TOOL_MKMAGIC           Create database for file(1).  [file]
                    987:
                    988: TOOL_MKTEMP            Make (unique) temporary file name.  [mktemp]
                    989:
                    990: TOOL_MSGC              Simple message list compiler.  [msgc]
                    991:
                    992: TOOL_MTREE             Map a directory hierarchy.  [mtree]
                    993:
                    994: TOOL_PAX               Manipulate file archives and copy directories.  [pax]
                    995:
                    996: TOOL_PIC               Compile pictures for groff.  [pic]
                    997:
                    998: TOOL_PREPMKBOOTIMAGE   prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
                    999:
                   1000: TOOL_PWD_MKDB          Generate the password databases.  [pwd_mkdb]
                   1001:
                   1002: TOOL_REFER             Preprocess bibliographic references for groff.  [refer]
                   1003:
                   1004: TOOL_ROFF_ASCII                Generate ASCII groff output.  [nroff]
                   1005:
                   1006: TOOL_ROFF_DVI          Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
                   1007:
                   1008: TOOL_ROFF_HTML         Generate HTML groff output.
1.119     lukem    1009:                        [${TOOL_GROFF} -Tlatin1 -mdoc2html]
1.116     lukem    1010:
                   1011: TOOL_ROFF_PS           Generate PS groff output.  [${TOOL_GROFF} -Tps]
                   1012:
                   1013: TOOL_ROFF_RAW          Generate "raw" groff output.  [${TOOL_GROFF} -Z]
                   1014:
                   1015: TOOL_RPCGEN            Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
                   1016:
                   1017: TOOL_SOELIM            Eliminate .so's from groff input.  [soelim]
                   1018:
                   1019: TOOL_SUNLABEL          Read or modify a SunOS disk label.  [sunlabel]
                   1020:
                   1021: TOOL_TBL               Format tables for groff.  [tbl]
                   1022:
                   1023: TOOL_UUDECODE          Uudecode a binary file.  [uudecode]
                   1024:
                   1025: TOOL_VGRIND            Grind nice listings of programs.  [vgrind -f]
                   1026:
                   1027: TOOL_ZIC               Time zone compiler.  [zic]
                   1028:
1.69      sommerfe 1029:
                   1030: Other variables of note (incomplete list):
                   1031:
1.82      lukem    1032: WARNS          Crank up gcc warning options; the distinct levels are:
                   1033:                        WARNS=1
                   1034:                        WARNS=2
                   1035:                        WARNS=3
1.69      sommerfe 1036:
                   1037: FORMAT_AUDIT   If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
                   1038: WFORMAT        -Wnetbsd-format-audit for extra-stringent format checking.
1.75      agc      1039:                WFORMAT belongs in individual makefiles and/or
                   1040:                Makefile.inc files.  (set WFORMAT=1 in individual
                   1041:                makefiles if a program is not security critical and is
                   1042:                doing bizarre things with format strings which would
                   1043:                be even uglier if rewritten) FORMAT_AUDIT should go in
1.120   ! lukem    1044:                mk.conf if you're doing format-string auditing.
1.69      sommerfe 1045:                FORMAT_AUDIT may go away in time.
1.30      agc      1046:
                   1047: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

CVSweb <webmaster@jp.NetBSD.org>