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