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