Annotation of src/share/mk/bsd.README, Revision 1.40
1.40 ! perry 1: # $NetBSD: bsd.README,v 1.39 1998/06/12 23:28:53 cgd 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
43: multiple programs in a single directory. It's a lot easier split up the
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.
60:
61: There are two variables that control how things are made/installed that
62: are not set by default:
63:
64: BUILD If set 'make install' checks that the targets in the source
65: directories are up-to-date and remakes them if they
66: are out of date, instead of blindly trying to install
67: out of date or non-existant targets.
68:
69: UPDATE 'make install' only installs targets that are more recently
70: modified in the source directories that their installed
71: counterparts.
1.1 cgd 72:
73: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
74:
75: The include file <sys.mk> has the default rules for all makes, in the BSD
76: environment or otherwise. You probably don't want to touch this file.
77:
78: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
79:
80: The include file <bsd.man.mk> handles installing manual pages and their
81: links.
82:
1.21 christos 83: It has a two targets:
1.1 cgd 84:
85: maninstall:
1.21 christos 86: Install the manual page sources and their links.
87: catinstall:
88: Install the preformatted manual pages and their links.
1.1 cgd 89:
90: It sets/uses the following variables:
91:
92: MANDIR Base path for manual installation.
93:
94: MANGRP Manual group.
95:
96: MANOWN Manual owner.
97:
98: MANMODE Manual mode.
99:
100: MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
101: or "/tahoe" for machine specific manual pages.
102:
1.15 cgd 103: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 cgd 104:
1.15 cgd 105: MLINKS List of manual page links (using a .1 - .9 suffix). The
1.1 cgd 106: linked-to file must come first, the linked file second,
107: and there may be multiple pairs. The files are soft-linked.
108:
109: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
110: it exists.
111:
112: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
113:
1.17 thorpej 114: The include file <bsd.own.mk> contains source tree configuration parameters,
115: such as the owners, groups, etc. for both manual pages and binaries, and
116: a few global "feature configuration" parameters.
1.1 cgd 117:
118: It has no targets.
119:
1.29 cjs 120: To get system-specific configuration parameters, bsd.own.mk will try to
121: include the file specified by the "MAKECONF" variable. If MAKECONF is not
122: set, or no such file exists, the system make configuration file, /etc/mk.conf
123: is included. These files may define any of the variables described below.
1.17 thorpej 124:
125: bsd.own.mk sets the following variables, if they are not already defined
126: (defaults are in brackets):
1.15 cgd 127:
1.21 christos 128:
129:
1.15 cgd 130: BSDSRCDIR The real path to the system sources, so that 'make obj'
131: will work correctly. [/usr/src]
132:
133: BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj'
134: will work correctly. [/usr/obj]
135:
1.34 lukem 136: BINGRP Binary group. [wheel]
1.15 cgd 137:
1.34 lukem 138: BINOWN Binary owner. [root]
1.15 cgd 139:
140: BINMODE Binary mode. [555]
141:
142: NONBINMODE Mode for non-executable files. [444]
143:
144: MANDIR Base path for manual installation. [/usr/share/man/cat]
145:
1.34 lukem 146: MANGRP Manual group. [wheel]
1.15 cgd 147:
1.34 lukem 148: MANOWN Manual owner. [root]
1.15 cgd 149:
150: MANMODE Manual mode. [${NONBINMODE}]
151:
1.21 christos 152: MANINSTALL Manual installation type: maninstall, catinstall, or both
153:
1.15 cgd 154: LIBDIR Base path for library installation. [/usr/lib]
155:
156: LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint]
157:
158: LIBGRP Library group. [${BINGRP}]
159:
160: LIBOWN Library owner. [${BINOWN}]
161:
162: LIBMODE Library mode. [${NONBINMODE}]
163:
164: DOCDIR Base path for system documentation (e.g. PSD, USD, etc.)
165: installation. [/usr/share/doc]
166:
1.34 lukem 167: DOCGRP Documentation group. [wheel]
1.15 cgd 168:
1.34 lukem 169: DOCOWN Documentation owner. [root]
1.15 cgd 170:
171: DOCMODE Documentation mode. [${NONBINMODE}]
172:
173: NLSDIR Base path for National Language Support files installation.
174: [/usr/share/nls]
1.1 cgd 175:
1.34 lukem 176: NLSGRP National Language Support files group. [wheel]
1.1 cgd 177:
1.34 lukem 178: NLSOWN National Language Support files owner. [root]
1.1 cgd 179:
1.15 cgd 180: NLSMODE National Language Support files mode. [${NONBINMODE}]
1.1 cgd 181:
1.32 mikel 182: STRIPFLAG The flag passed to the install program to cause the binary
1.1 cgd 183: to be stripped. This is to be used when building your
184: own install script so that the entire system can be made
1.15 cgd 185: stripped/not-stripped using a single knob. [-s]
1.1 cgd 186:
1.2 cgd 187: COPY The flag passed to the install program to cause the binary
188: to be copied rather than moved. This is to be used when
189: building our own install script so that the entire system
190: can either be installed with copies, or with moves using
1.15 cgd 191: a single knob. [-c]
192:
1.17 thorpej 193: Additionally, the following variables may be set by bsd.own.mk or in a
194: make configuration file to modify the behaviour of the system build
195: process (default values are in brackets along with comments, if set by
196: bsd.own.mk):
1.15 cgd 197:
198: EXPORTABLE_SYSTEM
199: Do not build /usr/src/domestic, even if it is present.
1.2 cgd 200:
1.15 cgd 201: SKEY Compile in support for S/key authentication. [yes, set
202: unconditionally]
203:
204: KERBEROS Compile in support for Kerberos 4 authentication.
205:
206: KERBEROS5 Compile in support for Kerberos 5 authentication.
207:
208: MANZ Compress manual pages at installation time.
209:
210: SYS_INCLUDE Copy or symlink kernel include files into /usr/include.
211: Possible values are "symlinks" or "copies" (which is
212: the same as the variable being unset).
1.1 cgd 213:
1.15 cgd 214: NOPROFILE Do not build profiled versions of system libraries
1.1 cgd 215:
1.15 cgd 216: NOPIC Do not build PIC versions of system libraries, and
217: do not build shared libraries. [set if ${MACHINE_ARCH}
1.33 jonathan 218: is "vax" "powerpc", unset otherwise.]
1.1 cgd 219:
1.40 ! perry 220: NOLINT Do not build lint libraries.
1.33 jonathan 221:
222: NOSHLIB Do not build shared libraries [set if ${MACHINE_ARCH}
223: is "powerpc", unset otherwise].
224:
1.38 simonb 225: OBJECT_FMT Object file format. [set to "ELF" on ports that use
1.33 jonathan 226: ELF -- currently if ${MACHINE_ARCH} is "alpha", "mips"
227: or "powerpc" or set to "a.out" on other ports].
228:
1.1 cgd 229:
1.17 thorpej 230: bsd.own.mk is generally useful when building your own Makefiles so that
1.1 cgd 231: they use the same default owners etc. as the rest of the tree.
232:
233: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
234:
235: The include file <bsd.prog.mk> handles building programs from one or
236: more source files, along with their manual pages. It has a limited number
237: of suffixes, consistent with the current needs of the BSD tree.
238:
1.16 jtc 239: It has eight targets:
1.1 cgd 240:
241: all:
242: build the program and its manual page
243: clean:
244: remove the program, any object files and the files a.out,
1.24 mikel 245: Errs, errs, mklog, and ${PROG}.core.
1.1 cgd 246: cleandir:
247: remove all of the files removed by the target clean, as
248: well as .depend, tags, and any manual pages.
249: depend:
250: make the dependencies for the source files, and store
251: them in the file .depend.
1.16 jtc 252: includes:
253: install any header files.
1.1 cgd 254: install:
255: install the program and its manual pages; if the Makefile
256: does not itself define the target install, the targets
257: beforeinstall and afterinstall may also be used to cause
258: actions immediately before and after the install target
259: is executed.
260: lint:
261: run lint on the source files
262: tags:
263: create a tags file for the source files.
264:
265: It sets/uses the following variables:
266:
267: BINGRP Binary group.
268:
269: BINOWN Binary owner.
270:
271: BINMODE Binary mode.
272:
273: CLEANFILES Additional files to remove for the clean and cleandir targets.
274:
275: COPTS Additional flags to the compiler when creating C objects.
1.35 lukem 276:
277: CPPFLAGS Additional flags to the C pre-processor
1.1 cgd 278:
279: LDADD Additional loader objects. Usually used for libraries.
280: For example, to load with the compatibility and utility
281: libraries, use:
282:
1.5 jtc 283: LDADD+=-lutil -lcompat
1.1 cgd 284:
285: LDFLAGS Additional loader flags.
286:
287: LINKS The list of binary links; should be full pathnames, the
288: linked-to file coming first, followed by the linked
289: file. The files are hard-linked. For example, to link
290: /bin/test and /bin/[, use:
291:
292: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
1.19 perry 293:
294: SYMLINKS The list of symbolic links; should be full pathnames.
1.20 perry 295: Syntax is identical to LINKS. Note that DESTDIR is not
296: automatically included in the link.
1.1 cgd 297:
1.15 cgd 298: MAN Manual pages (should end in .1 - .9). If no MAN variable is
1.8 cgd 299: defined, "MAN=${PROG}.1" is assumed.
1.1 cgd 300:
301: PROG The name of the program to build. If not supplied, nothing
302: is built.
303:
1.21 christos 304: PROGNAME The name that the above program will be installed as, if
305: different from ${PROG}.
306:
1.37 tv 307: SRCS List of source files to build the program. If SRCS is not
1.1 cgd 308: defined, it's assumed to be ${PROG}.c.
309:
310: DPADD Additional dependencies for the program. Usually used for
311: libraries. For example, to depend on the compatibility and
312: utility libraries use:
313:
1.5 jtc 314: DPADD+=${LIBCOMPAT} ${LIBUTIL}
1.1 cgd 315:
316: The following libraries are predefined for DPADD:
317:
1.21 christos 318: LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o
319: LIBC?= ${DESTDIR}/usr/lib/libc.a
320: LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a
321: LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a
322: LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a
323: LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a
324: LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a
325: LIBDES?= ${DESTDIR}/usr/lib/libdes.a
326: LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a
327: LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a
328: LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a
329: LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a
330: LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a
331: LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a
332: LIBL?= ${DESTDIR}/usr/lib/libl.a
333: LIBM?= ${DESTDIR}/usr/lib/libm.a
334: LIBMP?= ${DESTDIR}/usr/lib/libmp.a
1.25 christos 335: LIBNTP?= ${DESTDIR}/usr/lib/libntp.a
1.21 christos 336: LIBPC?= ${DESTDIR}/usr/lib/libpc.a
337: LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a
338: LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a
1.26 kleink 339: LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a
1.21 christos 340: LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a
341: LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a
342: LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a
343: LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a
344: LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a
345: LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a
346: LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a
347: LIBY?= ${DESTDIR}/usr/lib/liby.a
348: LIBZ?= ${DESTDIR}/usr/lib/libz.a
349:
1.1 cgd 350:
351: SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared
1.12 christos 352: strings, using xstr(1). Note that this will not work with
353: parallel makes.
1.1 cgd 354:
355: STRIP The flag passed to the install program to cause the binary
356: to be stripped.
357:
358: SUBDIR A list of subdirectories that should be built as well.
359: Each of the targets will execute the same target in the
360: subdirectories.
361:
1.21 christos 362: SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
363: These are installed exactly like programs.
364:
365: SCRIPTSNAME The name that the above program will be installed as, if
366: different from ${SCRIPTS}. These can be further specialized
367: by setting SCRIPTSNAME_<script>.
368:
369: FILES A list of files to install. The installation is controlled
370: by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR
371: variables that can be further specialized by FILES<VAR>_<file>
372:
1.1 cgd 373: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
374: if it exists, as well as the include file <bsd.man.mk>.
375:
376: Some simple examples:
377:
378: To build foo from foo.c with a manual page foo.1, use:
379:
380: PROG= foo
381:
382: .include <bsd.prog.mk>
383:
384: To build foo from foo.c with a manual page foo.2, add the line:
385:
1.9 cgd 386: MAN= foo.2
1.1 cgd 387:
388: If foo does not have a manual page at all, add the line:
389:
390: NOMAN= noman
391:
392: If foo has multiple source files, add the line:
393:
394: SRCS= a.c b.c c.c d.c
395:
396: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
397:
398: The include file <bsd.subdir.mk> contains the default targets for building
1.16 jtc 399: subdirectories. It has the same eight targets as <bsd.prog.mk>: all,
400: clean, cleandir, depend, includes, install, lint, and tags. For all of
401: the directories listed in the variable SUBDIRS, the specified directory
402: will be visited and the target made. There is also a default target which
403: allows the command "make subdir" where subdir is any directory listed in
404: the variable SUBDIRS.
1.21 christos 405:
406: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
407:
1.23 christos 408: The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
409: and is included from from bsd.lib.mk and bsd.prog.mk.
410:
411: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
412:
413: The include file <bsd.files.mk> handles the FILES variables and is included
414: from bsd.lib.mk and bsd.prog.mk.
1.21 christos 415:
416: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
417:
1.29 cjs 418: The include file <bsd.inc.mk> defines the includes target and uses two
419: variables:
1.21 christos 420:
1.29 cjs 421: INCS The list of include files
1.21 christos 422:
1.29 cjs 423: INCSDIR The location to install the include files.
1.39 cgd 424:
425: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
426:
427: The include file <bsd.kinc.mk> defines the many targets (includes,
428: subdirectories, etc.), and is used by kernel makefiles to handle
429: include file installation. It is intended to be included alone, by
430: kernel Makefiles. Please see bsd.kinc.mk for more details, and keep
431: the documentation in that file up to date.
1.13 christos 432:
433: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
434:
435: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.14 cgd 436: <bsd.lib.mk>. It contains overrides that are used when building
437: the NetBSD source tree. For instance, if "PARALLEL" is defined by
438: the program/library Makefile, it includes a set of rules for lex and
439: yacc that allow multiple lex and yacc targets to be built in parallel.
1.1 cgd 440:
441: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
442:
443: The include file <bsd.lib.mk> has support for building libraries. It has
1.16 jtc 444: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
445: includes, install, lint, and tags. It has a limited number of suffixes,
446: consistent with the current needs of the BSD tree.
1.1 cgd 447:
448: It sets/uses the following variables:
1.10 cgd 449:
450: LIB The name of the library to build.
1.1 cgd 451:
452: LIBDIR Target directory for libraries.
453:
454: LINTLIBDIR Target directory for lint libraries.
455:
456: LIBGRP Library group.
457:
458: LIBOWN Library owner.
459:
460: LIBMODE Library mode.
461:
462: LDADD Additional loader objects.
463:
1.15 cgd 464: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 cgd 465:
466: SRCS List of source files to build the library. Suffix types
467: .s, .c, and .f are supported. Note, .s files are preferred
468: to .c files of the same name. (This is not the default for
469: versions of make.)
470:
471: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
472: if it exists, as well as the include file <bsd.man.mk>.
473:
474: It has rules for building profiled objects; profiled libraries are
475: built by default.
476:
1.4 cgd 477: Libraries are ranlib'd when made.
1.30 agc 478:
479: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
480:
481: The include file <bsd.port.mk> is used in the FreeBSD ports system.
482: Various common definitions for use in the FreeBSD ports are specified
483: here. The only main changes between the NetBSD version and the
484: original FreeBSD version are that some NetBSD paths have been
1.31 hubertf 485: changed (PORTSDIR is now /usr/pkgsrc, rather than the /usr/ports
1.30 agc 486: directory used in FreeBSD, and PREFIX is now /usr/pkg, rather than
487: /usr/local directory used in FreeBSD).
488:
489: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
490:
491: The include file <bsd.port.subdir.mk> is used in the FreeBSD ports
492: system, and controls the sub-directory usage in the system. Once
1.31 hubertf 493: again, the only change is the PORTSDIR veriable (now /usr/pkgsrc
1.30 agc 494: rather than the /usr/ports used in FreeBSD).
CVSweb <webmaster@jp.NetBSD.org>