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