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