Annotation of src/share/mk/bsd.README, Revision 1.60
1.60 ! yasuoka 1: # $OpenBSD: bsd.README,v 1.59 2014/10/31 13:46:17 jsing 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.man.mk - installing manual pages and their links
12: bsd.nls.mk - National Language Support
13: bsd.obj.mk - creating 'obj' directories and cleaning up
14: bsd.own.mk - define common variables
15: bsd.port.mk - building ports
1.46 espie 16: bsd.port.arch.mk - glue for building ports with MD stuff
1.17 espie 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: LIBGRP Library group. [${BINGRP}]
179:
180: LIBOWN Library owner. [${BINOWN}]
181:
182: LIBMODE Library mode. [${NONBINMODE}]
183:
1.44 jmc 184: DOCDIR Base path for system documentation
1.4 niklas 185: installation. [/usr/share/doc]
186:
187: DOCGRP Documentation group. [bin]
188:
1.18 millert 189: DOCOWN Documentation owner. [root]
1.4 niklas 190:
191: DOCMODE Documentation mode. [${NONBINMODE}]
192:
193: NLSDIR Base path for National Language Support files installation.
194: [/usr/share/nls]
1.1 deraadt 195:
1.4 niklas 196: NLSGRP National Language Support files group. [bin]
1.1 deraadt 197:
1.18 millert 198: NLSOWN National Language Support files owner. [root]
1.1 deraadt 199:
1.4 niklas 200: NLSMODE National Language Support files mode. [${NONBINMODE}]
1.1 deraadt 201:
1.15 millert 202: INSTALL_STRIP The flag passed to the install program to cause the binary
1.1 deraadt 203: to be stripped. This is to be used when building your
204: own install script so that the entire system can be made
1.15 millert 205: stripped/not-stripped using a single knob. Note that
206: INSTALL_STRIP is not set if ${DEBUG} is defined. [-s]
1.1 deraadt 207:
1.15 millert 208: INSTALL_COPY The old usage of this flag is obsolescent since install(1)
209: now copies by default. However, it can also be used to
210: specify that a file not be copied unless it is different
211: (via the -p option). See install(1) for details. This
212: is to be used when building our own install script so
213: that the entire system can either be installed with copies,
214: or copy-if-different using a single knob. [-c]
1.4 niklas 215:
1.8 deraadt 216: Additionally, the following variables may be set by bsd.own.mk or in a
217: make configuration file to modify the behaviour of the system build
218: process (default values are in brackets along with comments, if set by
219: bsd.own.mk):
1.23 espie 220:
1.4 niklas 221: SKEY Compile in support for S/key authentication. [yes, set
222: unconditionally]
223:
224: SYS_INCLUDE Copy or symlink kernel include files into /usr/include.
225: Possible values are "symlinks" or "copies" (which is
226: the same as the variable being unset).
1.1 deraadt 227:
1.28 brad 228: NOPROFILE Do not build profiled versions of system libraries.
1.1 deraadt 229:
1.4 niklas 230: NOPIC Do not build PIC versions of system libraries, and
1.28 brad 231: do not build shared libraries.
1.48 pascal 232:
233: NOPIE Do not build PIE objects or executables.
1.1 deraadt 234:
1.22 niklas 235: DEBUG Add -g to assembly, C compiler and linking passes. Also
236: doesn't set STRIP to -s per default if defined.
237:
238: DEBUGLIBS Create libraries with -g debug information, and install
239: them in /usr/lib/debug.
1.27 espie 240:
241: WARNINGS Adds appropriate warning flags (defined in CDIAGFLAGS,
242: e.g., -Wall...) to compiles. [no]
1.19 millert 243:
244: SUDO Command to run when doing "make install" portion of
245: "make build". If set to sudo, this allows one to run
246: "make build" as a user other than root (assuming sudo
247: is setup for that user).
248:
249: PIPE If set to "-pipe" gcc will be given the -pipe option
250: which can speed up compiles on machines with memory
251: to spare. Instead of using temp files, gcc uses pipes
252: for the temporary data.
1.20 kstailey 253:
254: GLOBAL_AUTOCONF_CACHE
255: Set to the name of a file that all cached GNU autoconf
256: test results will be saved in. Reduces redundant tests.
1.23 espie 257: Be careful! Redundant tests may not be redundant if you
258: are installing substantially updated gnu programs.
1.1 deraadt 259:
1.8 deraadt 260: bsd.own.mk is generally useful when building your own Makefiles so that
1.1 deraadt 261: they use the same default owners etc. as the rest of the tree.
262:
263: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
264:
265: The include file <bsd.prog.mk> handles building programs from one or
266: more source files, along with their manual pages. It has a limited number
267: of suffixes, consistent with the current needs of the BSD tree.
268:
1.58 schwarze 269: It has seven targets:
1.1 deraadt 270:
271: all:
272: build the program and its manual page
273: clean:
274: remove the program, any object files and the files a.out,
275: Errs, errs, mklog, and core.
276: cleandir:
277: remove all of the files removed by the target clean, as
278: well as .depend, tags, and any manual pages.
279: depend:
280: make the dependencies for the source files, and store
281: them in the file .depend.
1.8 deraadt 282: includes:
283: install any header files.
1.1 deraadt 284: install:
285: install the program and its manual pages; if the Makefile
286: does not itself define the target install, the targets
287: beforeinstall and afterinstall may also be used to cause
288: actions immediately before and after the install target
289: is executed.
290: tags:
291: create a tags file for the source files.
292:
293: It sets/uses the following variables:
294:
295: BINGRP Binary group.
296:
297: BINOWN Binary owner.
298:
299: BINMODE Binary mode.
300:
301: CLEANFILES Additional files to remove for the clean and cleandir targets.
302:
303: COPTS Additional flags to the compiler when creating C objects.
304:
305: LDADD Additional loader objects. Usually used for libraries.
1.53 deraadt 306: For example, to load with the crypto and utility
1.1 deraadt 307: libraries, use:
308:
1.53 deraadt 309: LDADD+=-lutil -lcrypto
1.1 deraadt 310:
311: LDFLAGS Additional loader flags.
312:
313: LINKS The list of binary links; should be full pathnames, the
314: linked-to file coming first, followed by the linked
315: file. The files are hard-linked. For example, to link
316: /bin/test and /bin/[, use:
317:
318: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
319:
1.4 niklas 320: MAN Manual pages (should end in .1 - .9). If no MAN variable is
1.1 deraadt 321: defined, "MAN=${PROG}.1" is assumed.
322:
323: PROG The name of the program to build. If not supplied, nothing
324: is built.
325:
1.6 mickey 326: SRCS List of source files to build the program. If it's not
1.1 deraadt 327: defined, it's assumed to be ${PROG}.c.
328:
329: DPADD Additional dependencies for the program. Usually used for
1.53 deraadt 330: libraries. For example, to depend on the crypto and
1.1 deraadt 331: utility libraries use:
332:
1.53 deraadt 333: DPADD+=${LIBCRYPTO} ${LIBUTIL}
1.1 deraadt 334:
335: The following libraries are predefined for DPADD:
336:
1.31 espie 337: LIBC /usr/lib/libc.a
338: LIBCRYPTO /usr/lib/libcrypto.a
1.1 deraadt 339: LIBCURSES /usr/lib/libcurses.a
1.26 millert 340: LIBEDIT /usr/lib/libedit.a
1.32 millert 341: LIBEVENT /usr/lib/libevent.a
1.42 miod 342: LIBEXPAT /usr/lib/libexpat.a
343: LIBFORM /usr/lib/libform.a
344: LIBFORMW /usr/lib/libformw.a
1.26 millert 345: LIBKEYNOTE /usr/lib/libkeynote.a
1.1 deraadt 346: LIBKVM /usr/lib/libkvm.a
1.26 millert 347: LIBL /usr/lib/libl.a
1.1 deraadt 348: LIBM /usr/lib/libm.a
1.42 miod 349: LIBMENU /usr/lib/libmenu.a
350: LIBMENUW /usr/lib/libmenuw.a
1.60 ! yasuoka 351: LIBRADIUS /usr/lib/libradius.a
1.26 millert 352: LIBOLDCURSES /usr/lib/libocurses.a
1.42 miod 353: LIBOSSAUDIO /usr/lib/libossaudio.a
354: LIBPANEL /usr/lib/libpanel.a
355: LIBPANELW /usr/lib/libpanelw.a
1.31 espie 356: LIBPCAP /usr/lib/libpcap.a
1.21 millert 357: LIBPERL /usr/lib/libperl.a
1.42 miod 358: LIBPTHREAD /usr/lib/libpthread.a
1.26 millert 359: LIBRPCSVC /usr/lib/librpcsvc.a
360: LIBSKEY /usr/lib/libskey.a
1.42 miod 361: LIBSNDIO /usr/lib/libsndio.a
1.26 millert 362: LIBSSL /usr/lib/libssl.a
1.9 tholo 363: LIBTERMCAP /usr/lib/libtermcap.a
364: LIBTERMLIB /usr/lib/libtermlib.a
1.59 jsing 365: LIBTLS /usr/lib/libtls.a
1.31 espie 366: LIBUSB /usr/lib/libusbhid.a
1.1 deraadt 367: LIBUTIL /usr/lib/libutil.a
1.31 espie 368: LIBY /usr/lib/liby.a
1.13 deraadt 369: LIBZ /usr/lib/libz.a
1.31 espie 370: LIBARCH arch-dependent stuff
1.1 deraadt 371:
372: STRIP The flag passed to the install program to cause the binary
373: to be stripped.
374:
375: SUBDIR A list of subdirectories that should be built as well.
376: Each of the targets will execute the same target in the
377: subdirectories.
378:
379: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
380: if it exists, as well as the include file <bsd.man.mk>.
381:
382: Some simple examples:
383:
384: To build foo from foo.c with a manual page foo.1, use:
385:
386: PROG= foo
387:
388: .include <bsd.prog.mk>
389:
390: To build foo from foo.c with a manual page foo.2, add the line:
391:
392: MAN= foo.2
393:
394: If foo does not have a manual page at all, add the line:
395:
396: NOMAN= noman
397:
398: If foo has multiple source files, add the line:
399:
400: SRCS= a.c b.c c.c d.c
401:
402: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
403:
404: The include file <bsd.subdir.mk> contains the default targets for building
1.58 schwarze 405: subdirectories. It has the same seven targets as <bsd.prog.mk>: all,
1.47 jsg 406: clean, cleandir, depend, includes, install, and tags. For all of
1.41 jmc 407: the directories listed in the variable SUBDIR, the specified directory
1.8 deraadt 408: will be visited and the target made. There is also a default target which
409: allows the command "make subdir" where subdir is any directory listed in
1.41 jmc 410: the variable SUBDIR.
1.2 deraadt 411:
412: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
413:
414: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.3 deraadt 415: <bsd.lib.mk>. It contains overrides that are used when building
1.14 millert 416: the OpenBSD source tree. For instance, if "PARALLEL" is defined by
1.3 deraadt 417: the program/library Makefile, it includes a set of rules for lex and
418: yacc that allow multiple lex and yacc targets to be built in parallel.
1.1 deraadt 419:
420: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
421:
422: The include file <bsd.lib.mk> has support for building libraries. It has
1.58 schwarze 423: the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
1.47 jsg 424: includes, install, and tags. It has a limited number of suffixes,
1.8 deraadt 425: consistent with the current needs of the BSD tree.
1.1 deraadt 426:
427: It sets/uses the following variables:
428:
429: LIB The name of the library to build.
430:
431: LIBDIR Target directory for libraries.
432:
433: LIBGRP Library group.
434:
435: LIBOWN Library owner.
436:
437: LIBMODE Library mode.
438:
439: LDADD Additional loader objects.
440:
1.4 niklas 441: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 deraadt 442:
443: SRCS List of source files to build the library. Suffix types
444: .s, .c, and .f are supported. Note, .s files are preferred
445: to .c files of the same name. (This is not the default for
446: versions of make.)
447:
448: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
449: if it exists, as well as the include file <bsd.man.mk>.
450:
451: It has rules for building profiled objects; profiled libraries are
452: built by default.
453:
454: Libraries are ranlib'd when made.
1.52 guenther 455:
456: In addition, a reduced version of a library, including just specific
457: objects that are compiled with additional options to reduce their
458: size may be built. This is used by the distrib/ tree and crunchgen
459: when building ramdisks. This sets/uses the following variables:
460:
461: DIST_LIB The path of the library to build. [lib${LIB}_d.a]
462:
463: DIST_OBJS The (sub)set of .o files to include in ${DIST_LIB}. [${OBJS}]
464:
465: DIST_CFLAGS Additional flags for the C compiler and assembler.
466: [-Os]
1.6 mickey 467:
![[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