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