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