Annotation of src/share/mk/bsd.README, Revision 1.41
1.41 ! jmc 1: # $OpenBSD: bsd.README,v 1.40 2007/11/03 10:30:40 espie Exp $
1.8 deraadt 2: # $NetBSD: bsd.README,v 1.17 1996/04/13 02:08:08 thorpej Exp $
1.1 deraadt 3: # @(#)bsd.README 5.1 (Berkeley) 5/11/90
4:
5: This is the README file for the new make "include" files for the BSD
6: source tree. The files are installed in /usr/share/mk, and are, by
7: convention, named with the suffix ".mk".
1.17 espie 8:
9: bsd.dep.mk - handle Makefile dependencies
10: bsd.doc.mk - building troff system documents
11: bsd.lib.mk - support for building libraries
12: bsd.lkm.mk - building loadable kernel modules
13: bsd.man.mk - installing manual pages and their links
14: bsd.nls.mk - National Language Support
15: bsd.obj.mk - creating 'obj' directories and cleaning up
16: bsd.own.mk - define common variables
17: bsd.port.mk - building ports
18: bsd.port.subdir.mk - targets for building subdirectories for ports
19: bsd.prog.mk - building programs from source files
1.30 provos 20: bsd.regress.mk - regression tests
21: bsd.subdir.mk - targets for building subdirectories
1.17 espie 22: bsd.sys.mk - building bsd from the source tree
1.1 deraadt 23:
24: Note, this file is not intended to replace reading through the .mk
25: files for anything tricky.
26:
27: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
28:
29: RANDOM THINGS WORTH KNOWING:
30:
31: The files are simply C-style #include files, and pretty much behave like
32: you'd expect. The syntax is slightly different in that a single '.' is
33: used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
34:
35: One difference that will save you lots of debugging time is that inclusion
36: of the file is normally done at the *end* of the Makefile. The reason for
37: this is because .mk files often modify variables and behavior based on the
38: values of variables set in the Makefile. To make this work, remember that
39: the FIRST target found is the target that is used, i.e. if the Makefile has:
40:
41: a:
42: echo a
43: a:
44: echo a number two
45:
46: the command "make a" will echo "a". To make things confusing, the SECOND
47: variable assignment is the overriding one, i.e. if the Makefile has:
48:
49: a= foo
50: a= bar
51:
52: b:
53: echo ${a}
54:
55: the command "make b" will echo "bar". This is for compatibility with the
56: way the V7 make behaved.
57:
1.23 espie 58: To make things even more confusing, make uses lazy evaluation. All
59: variables are expanded only when needed. Which means that, in
60:
61: a= foo
62:
63: b: $(a)
64: echo $(.ALLSRC)
65: echo $(a)
66:
67: foo:
68: touch foo
69:
70: a= bar
71:
72: the command "make b" will echo "foo"; echo "bar". The first $(a) means
73: "foo", because it's needed to generate the dependency rule when it's read,
74: but the second $(a) is only expanded when needed, at which point a contains
75: bar.
76:
1.1 deraadt 77: It's fairly difficult to make the BSD .mk files work when you're building
1.16 espie 78: multiple programs in a single directory. It's a lot easier to split up the
1.1 deraadt 79: programs than to deal with the problem. Most of the agony comes from making
1.16 espie 80: the "obj" directory stuff work right, not because we switched to a new version
1.1 deraadt 81: of make. So, don't get mad at us, figure out a better way to handle multiple
82: architectures so we can quit using the symbolic link stuff. (Imake doesn't
83: count.)
84:
85: The file .depend in the source directory is expected to contain dependencies
86: for the source files. This file is read automatically by make after reading
87: the Makefile.
88:
89: The variable DESTDIR works as before. It's not set anywhere but will change
90: the tree where the file gets installed.
91:
92: The profiled libraries are no longer built in a different directory than
93: the regular libraries. A new suffix, ".po", is used to denote a profiled
94: object.
95:
96: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
97:
98: The include file <sys.mk> has the default rules for all makes, in the BSD
99: environment or otherwise. You probably don't want to touch this file.
100:
101: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
102:
103: The include file <bsd.man.mk> handles installing manual pages and their
104: links.
105:
106: It has a single target:
107:
108: maninstall:
109: Install the manual pages and their links.
110:
111: It sets/uses the following variables:
112:
113: MANDIR Base path for manual installation.
114:
115: MANGRP Manual group.
116:
117: MANOWN Manual owner.
118:
119: MANMODE Manual mode.
120:
1.24 mpech 121: MANSUBDIR Subdirectory under the manual page section, i.e. "vax"
122: or "tahoe" for machine specific manual pages.
1.1 deraadt 123:
1.4 niklas 124: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 deraadt 125:
1.4 niklas 126: MLINKS List of manual page links (using a .1 - .9 suffix). The
1.1 deraadt 127: linked-to file must come first, the linked file second,
128: and there may be multiple pairs. The files are soft-linked.
1.40 espie 129:
130: BEFOREMAN List of extra targets that must be already built before the
131: man target can be run. Those targets must be real files (and
132: not .PHONY targets).
1.1 deraadt 133:
134: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
135: it exists.
136:
137: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
138:
1.8 deraadt 139: The include file <bsd.own.mk> contains source tree configuration parameters,
140: such as the owners, groups, etc. for both manual pages and binaries, and
141: a few global "feature configuration" parameters.
1.1 deraadt 142:
143: It has no targets.
144:
1.8 deraadt 145: To get system-specific configuration parameters, bsd.own.mk will try to
146: include the file specified by the "MAKECONF" variable. If MAKECONF is not
147: set, or no such file exists, the system make configuration file, /etc/mk.conf
148: is included. These files may define any of the variables described below.
149:
150: bsd.own.mk sets the following variables, if they are not already defined
151: (defaults are in brackets):
1.4 niklas 152:
153: BSDSRCDIR The real path to the system sources, so that 'make obj'
154: will work correctly. [/usr/src]
155:
156: BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj'
157: will work correctly. [/usr/obj]
158:
159: BINGRP Binary group. [bin]
160:
1.10 deraadt 161: BINOWN Binary owner. [root]
1.4 niklas 162:
163: BINMODE Binary mode. [555]
164:
165: NONBINMODE Mode for non-executable files. [444]
166:
1.23 espie 167: DIRMODE Mode for new directories. [755]
168:
1.4 niklas 169: MANDIR Base path for manual installation. [/usr/share/man/cat]
170:
171: MANGRP Manual group. [bin]
172:
1.18 millert 173: MANOWN Manual owner. [root]
1.4 niklas 174:
175: MANMODE Manual mode. [${NONBINMODE}]
176:
177: LIBDIR Base path for library installation. [/usr/lib]
178:
179: LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint]
180:
181: LIBGRP Library group. [${BINGRP}]
182:
183: LIBOWN Library owner. [${BINOWN}]
184:
185: LIBMODE Library mode. [${NONBINMODE}]
186:
187: DOCDIR Base path for system documentation (e.g. PSD, USD, etc.)
188: installation. [/usr/share/doc]
189:
190: DOCGRP Documentation group. [bin]
191:
1.18 millert 192: DOCOWN Documentation owner. [root]
1.4 niklas 193:
194: DOCMODE Documentation mode. [${NONBINMODE}]
195:
196: NLSDIR Base path for National Language Support files installation.
197: [/usr/share/nls]
1.1 deraadt 198:
1.4 niklas 199: NLSGRP National Language Support files group. [bin]
1.1 deraadt 200:
1.18 millert 201: NLSOWN National Language Support files owner. [root]
1.1 deraadt 202:
1.4 niklas 203: NLSMODE National Language Support files mode. [${NONBINMODE}]
1.1 deraadt 204:
1.15 millert 205: INSTALL_STRIP The flag passed to the install program to cause the binary
1.1 deraadt 206: to be stripped. This is to be used when building your
207: own install script so that the entire system can be made
1.15 millert 208: stripped/not-stripped using a single knob. Note that
209: INSTALL_STRIP is not set if ${DEBUG} is defined. [-s]
1.1 deraadt 210:
1.15 millert 211: INSTALL_COPY The old usage of this flag is obsolescent since install(1)
212: now copies by default. However, it can also be used to
213: specify that a file not be copied unless it is different
214: (via the -p option). See install(1) for details. This
215: is to be used when building our own install script so
216: that the entire system can either be installed with copies,
217: or copy-if-different using a single knob. [-c]
1.4 niklas 218:
1.8 deraadt 219: Additionally, the following variables may be set by bsd.own.mk or in a
220: make configuration file to modify the behaviour of the system build
221: process (default values are in brackets along with comments, if set by
222: bsd.own.mk):
1.4 niklas 223:
1.23 espie 224: AFS Compile support for AFS.
225:
1.4 niklas 226: SKEY Compile in support for S/key authentication. [yes, set
227: unconditionally]
228:
229: KERBEROS5 Compile in support for Kerberos 5 authentication.
230:
231: MANZ Compress manual pages at installation time.
232:
1.23 espie 233: MANPS Define to have PostScript manual pages generated.
234:
1.4 niklas 235: SYS_INCLUDE Copy or symlink kernel include files into /usr/include.
236: Possible values are "symlinks" or "copies" (which is
237: the same as the variable being unset).
1.1 deraadt 238:
1.28 brad 239: NOPROFILE Do not build profiled versions of system libraries.
1.1 deraadt 240:
1.4 niklas 241: NOPIC Do not build PIC versions of system libraries, and
1.28 brad 242: do not build shared libraries.
1.1 deraadt 243:
1.39 jmc 244: WANTLINT Build lint libraries.
1.11 niklas 245:
1.22 niklas 246: DEBUG Add -g to assembly, C compiler and linking passes. Also
247: doesn't set STRIP to -s per default if defined.
248:
249: DEBUGLIBS Create libraries with -g debug information, and install
250: them in /usr/lib/debug.
1.27 espie 251:
252: WARNINGS Adds appropriate warning flags (defined in CDIAGFLAGS,
253: e.g., -Wall...) to compiles. [no]
1.19 millert 254:
255: SUDO Command to run when doing "make install" portion of
256: "make build". If set to sudo, this allows one to run
257: "make build" as a user other than root (assuming sudo
258: is setup for that user).
259:
260: PIPE If set to "-pipe" gcc will be given the -pipe option
261: which can speed up compiles on machines with memory
262: to spare. Instead of using temp files, gcc uses pipes
263: for the temporary data.
1.20 kstailey 264:
265: GLOBAL_AUTOCONF_CACHE
266: Set to the name of a file that all cached GNU autoconf
267: test results will be saved in. Reduces redundant tests.
1.23 espie 268: Be careful! Redundant tests may not be redundant if you
269: are installing substantially updated gnu programs.
1.1 deraadt 270:
1.8 deraadt 271: bsd.own.mk is generally useful when building your own Makefiles so that
1.1 deraadt 272: they use the same default owners etc. as the rest of the tree.
273:
274: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
275:
276: The include file <bsd.prog.mk> handles building programs from one or
277: more source files, along with their manual pages. It has a limited number
278: of suffixes, consistent with the current needs of the BSD tree.
279:
1.8 deraadt 280: It has eight targets:
1.1 deraadt 281:
282: all:
283: build the program and its manual page
284: clean:
285: remove the program, any object files and the files a.out,
286: Errs, errs, mklog, and core.
287: cleandir:
288: remove all of the files removed by the target clean, as
289: well as .depend, tags, and any manual pages.
290: depend:
291: make the dependencies for the source files, and store
292: them in the file .depend.
1.8 deraadt 293: includes:
294: install any header files.
1.1 deraadt 295: install:
296: install the program and its manual pages; if the Makefile
297: does not itself define the target install, the targets
298: beforeinstall and afterinstall may also be used to cause
299: actions immediately before and after the install target
300: is executed.
301: lint:
302: run lint on the source files
303: tags:
304: create a tags file for the source files.
305:
306: It sets/uses the following variables:
307:
308: BINGRP Binary group.
309:
310: BINOWN Binary owner.
311:
312: BINMODE Binary mode.
313:
314: CLEANFILES Additional files to remove for the clean and cleandir targets.
315:
316: COPTS Additional flags to the compiler when creating C objects.
317:
318: LDADD Additional loader objects. Usually used for libraries.
319: For example, to load with the compatibility and utility
320: libraries, use:
321:
322: LDADD+=-lutil -lcompat
323:
324: LDFLAGS Additional loader flags.
325:
326: LINKS The list of binary links; should be full pathnames, the
327: linked-to file coming first, followed by the linked
328: file. The files are hard-linked. For example, to link
329: /bin/test and /bin/[, use:
330:
331: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
332:
1.4 niklas 333: MAN Manual pages (should end in .1 - .9). If no MAN variable is
1.1 deraadt 334: defined, "MAN=${PROG}.1" is assumed.
335:
336: PROG The name of the program to build. If not supplied, nothing
337: is built.
338:
1.6 mickey 339: SRCS List of source files to build the program. If it's not
1.1 deraadt 340: defined, it's assumed to be ${PROG}.c.
341:
342: DPADD Additional dependencies for the program. Usually used for
343: libraries. For example, to depend on the compatibility and
344: utility libraries use:
345:
346: DPADD+=${LIBCOMPAT} ${LIBUTIL}
347:
348: The following libraries are predefined for DPADD:
349:
1.31 espie 350: LIB45 /usr/lib/lib45.a
351: LIBASN1 /usr/lib/libasn1.a
352: LIBC /usr/lib/libc.a
1.1 deraadt 353: LIBCOMPAT /usr/lib/libcompat.a
1.31 espie 354: LIBCRYPTO /usr/lib/libcrypto.a
1.1 deraadt 355: LIBCURSES /usr/lib/libcurses.a
356: LIBDES /usr/lib/libdes.a
1.26 millert 357: LIBEDIT /usr/lib/libedit.a
1.32 millert 358: LIBEVENT /usr/lib/libevent.a
1.26 millert 359: LIBGCC /usr/lib/libgcc.a
1.35 jakob 360: LIBGSSAPI /usr/lib/libgssapi.a
1.31 espie 361: LIBHDB /usr/lib/libhdb.a
362: LIBKADM /usr/lib/libkadm.a
363: LIBKADM5CLNT /usr/lib/libkadm5clnt.a
364: LIBKADM5SRV /usr/lib/libkadm5srv.a
365: LIBKAFS /usr/lib/libkafs.a
1.26 millert 366: LIBKDB /usr/lib/libkdb.a
367: LIBKEYNOTE /usr/lib/libkeynote.a
1.1 deraadt 368: LIBKRB /usr/lib/libkrb.a
1.31 espie 369: LIBKRB5 /usr/lib/libkrb5.a
1.1 deraadt 370: LIBKVM /usr/lib/libkvm.a
1.26 millert 371: LIBL /usr/lib/libl.a
1.1 deraadt 372: LIBM /usr/lib/libm.a
1.26 millert 373: LIBOLDCURSES /usr/lib/libocurses.a
1.31 espie 374: LIBPCAP /usr/lib/libpcap.a
1.21 millert 375: LIBPERL /usr/lib/libperl.a
1.26 millert 376: LIBRPCSVC /usr/lib/librpcsvc.a
1.31 espie 377: LIBSECTOK /usr/lib/libsectok.a
1.26 millert 378: LIBSKEY /usr/lib/libskey.a
379: LIBSSL /usr/lib/libssl.a
380: LIBTELNET /usr/lib/libtelnet.a
1.9 tholo 381: LIBTERMCAP /usr/lib/libtermcap.a
382: LIBTERMLIB /usr/lib/libtermlib.a
1.31 espie 383: LIBUSB /usr/lib/libusbhid.a
1.1 deraadt 384: LIBUTIL /usr/lib/libutil.a
1.26 millert 385: LIBWRAP /usr/lib/libwrap.a
1.31 espie 386: LIBY /usr/lib/liby.a
1.13 deraadt 387: LIBZ /usr/lib/libz.a
1.31 espie 388: LIBARCH arch-dependent stuff
1.1 deraadt 389:
390: STRIP The flag passed to the install program to cause the binary
391: to be stripped.
392:
393: SUBDIR A list of subdirectories that should be built as well.
394: Each of the targets will execute the same target in the
395: subdirectories.
396:
397: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
398: if it exists, as well as the include file <bsd.man.mk>.
399:
400: Some simple examples:
401:
402: To build foo from foo.c with a manual page foo.1, use:
403:
404: PROG= foo
405:
406: .include <bsd.prog.mk>
407:
408: To build foo from foo.c with a manual page foo.2, add the line:
409:
410: MAN= foo.2
411:
412: If foo does not have a manual page at all, add the line:
413:
414: NOMAN= noman
415:
416: If foo has multiple source files, add the line:
417:
418: SRCS= a.c b.c c.c d.c
419:
420: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
421:
422: The include file <bsd.subdir.mk> contains the default targets for building
1.8 deraadt 423: subdirectories. It has the same eight targets as <bsd.prog.mk>: all,
424: clean, cleandir, depend, includes, install, lint, and tags. For all of
1.41 ! jmc 425: the directories listed in the variable SUBDIR, the specified directory
1.8 deraadt 426: will be visited and the target made. There is also a default target which
427: allows the command "make subdir" where subdir is any directory listed in
1.41 ! jmc 428: the variable SUBDIR.
1.2 deraadt 429:
430: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
431:
432: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.3 deraadt 433: <bsd.lib.mk>. It contains overrides that are used when building
1.14 millert 434: the OpenBSD source tree. For instance, if "PARALLEL" is defined by
1.3 deraadt 435: the program/library Makefile, it includes a set of rules for lex and
436: yacc that allow multiple lex and yacc targets to be built in parallel.
1.1 deraadt 437:
438: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
439:
440: The include file <bsd.lib.mk> has support for building libraries. It has
1.8 deraadt 441: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
442: includes, install, lint, and tags. It has a limited number of suffixes,
443: consistent with the current needs of the BSD tree.
1.1 deraadt 444:
445: It sets/uses the following variables:
446:
447: LIB The name of the library to build.
448:
449: LIBDIR Target directory for libraries.
450:
451: LINTLIBDIR Target directory for lint libraries.
452:
453: LIBGRP Library group.
454:
455: LIBOWN Library owner.
456:
457: LIBMODE Library mode.
458:
459: LDADD Additional loader objects.
460:
1.4 niklas 461: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 deraadt 462:
463: SRCS List of source files to build the library. Suffix types
464: .s, .c, and .f are supported. Note, .s files are preferred
465: to .c files of the same name. (This is not the default for
466: versions of make.)
467:
468: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
469: if it exists, as well as the include file <bsd.man.mk>.
470:
471: It has rules for building profiled objects; profiled libraries are
472: built by default.
473:
474: Libraries are ranlib'd when made.
1.6 mickey 475:
476: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
477:
478: The include file <bsd.lkm.mk> has support for building the LKM's. It has
479: the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
480: install, lint, and tags. In addition two targets are made available
481: that is specific to the LKM's: load, unload.
482:
483: It sets/uses the following variables (in addition to the <bsd.prog.mk>'s):
484:
485: LKM LKM name to build.
486:
487: LKMGRP Module group.
488:
489: LKMOWN Module owner.
490:
491: LKMMODE Module mode.
1.7 mickey 492:
493: POSTINSTALL Program to pass with '-p' flag to the modload.
494: If not defined,
495: POSTINSTALL=${LKM}install
496: is assumed.
1.6 mickey 497:
498: The include file <bsd.lkm.mk> includes the file named "../Makefile.inc"
499: if it exists, as well as the include file <bsd.man.mk>.
![[BACK]](/icons/back.gif){kind=icon}
Return to bsd.README CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / share / mk