1 # @(#)bsd.README 8.2 (Berkeley) 4/2/94
2 # $FreeBSD: src/share/mk/bsd.README,v 1.25 2003/05/17 18:03:05 trhodes Exp $
4 This is the README file for the "include" files for the DragonFly
5 source tree. The files are installed in /usr/share/mk, and are, by
6 convention, named with the suffix ".mk". These files store several
7 build options and should be handled with caution.
9 Note, this file is not intended to replace reading through the .mk
10 files for anything tricky.
12 There are two main types of make include files. One type is the generally
13 usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is
14 the internal make include files, such as bsd.files.mk and bsd.man.mk, which
15 can not/should not be used directly but are used by the other make include
16 files. In most cases it is only interesting to include bsd.prog.mk or
19 bsd.cpu.custom.mk - handle CPU flags for custom compilers
20 bsd.cpu.gcc47.mk - handle GCC 4.7 specific CPU flags & variables
21 bsd.cpu.gcc50.mk - handle GCC 5.0 specific CPU flags & variables
22 bsd.cpu.mk - handle CPU flags & variables
23 bsd.dep.mk - handle Makefile dependencies
24 bsd.doc.mk - building troff system documents
25 bsd.files.mk - install of general purpose files
28 bsd.incs.mk - install of include files
29 bsd.init.mk - initialization for the make include files
30 bsd.kmod.mk - building loadable kernel modules
31 bsd.lib.mk - support for building libraries
32 bsd.libnames.mk - define library names
33 bsd.links.mk - install of links (sym/hard)
34 bsd.man.mk - install of manual pages and their links
35 bsd.nls.mk - build and install of NLS catalogs
36 bsd.obj.mk - creating 'obj' directories and cleaning up
37 bsd.own.mk - define common variables
39 bsd.prog.mk - building programs from source files
40 bsd.subdir.mk - targets for building subdirectories
41 bsd.sys.mk - common settings used for building FreeBSD sources
42 sys.mk - default rules for all makes
45 See also make(1), mkdep(1) and `PMake - A Tutorial',
46 located in /usr/src/share/doc/psd/12.make.
48 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
50 Random things worth knowing about this document:
52 If appropriate when documenting the variables the default value is
53 indicated using square brackets e.g. [gzip].
54 In some cases the default value depend on other values (e.g. system
55 architecture). In these cases the most common value is indicated.
57 This document contains some simple examples of the usage of the BSD make
58 include files. For more examples look at the makefiles in the DragonFly
61 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
63 RANDOM THINGS WORTH KNOWING:
65 The files are like C-style #include files, and pretty much behave like
66 you'd expect. The syntax is slightly different in that a single '.' is
67 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
69 One difference that will save you lots of debugging time is that inclusion
70 of the file is normally done at the *end* of the Makefile. The reason for
71 this is because .mk files often modify variables and behavior based on the
72 values of variables set in the Makefile. To make this work, remember that
73 the FIRST target found is the target that is used, i.e. if the Makefile has:
80 the command "make a" will echo "a". To make things confusing, the SECOND
81 variable assignment is the overriding one, i.e. if the Makefile has:
89 the command "make b" will echo "bar". This is for compatibility with the
90 way the V7 make behaved.
92 It's fairly difficult to make the BSD .mk files work when you're building
93 multiple programs in a single directory. It's a lot easier split up the
94 programs than to deal with the problem. Most of the agony comes from making
95 the "obj" directory stuff work right, not because we switch to a new version
96 of make. So, don't get mad at us, figure out a better way to handle multiple
97 architectures so we can quit using the symbolic link stuff. (Imake doesn't
100 The file .depend in the source directory is expected to contain dependencies
101 for the source files. This file is read automatically by make after reading
104 The variable DESTDIR works as before. It's not set anywhere but will change
105 the tree where the file gets installed.
107 The profiled libraries are no longer built in a different directory than
108 the regular libraries. A new suffix, ".po", is used to denote a profiled
111 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
113 The include file <sys.mk> has the default rules for all makes, in the BSD
114 environment or otherwise. You probably don't want to touch this file.
116 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
118 The include file <bsd.man.mk> handles installing manual pages and their
121 It has three targets:
126 install the manual pages and their links.
128 verify the validity of manual pages.
130 It sets/uses the following variables:
132 MANDIR Base path for manual installation.
140 MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
141 or "/tahoe" for machine specific manual pages.
143 MAN The manual pages to be installed (use a .1 - .9 suffix).
145 MANINSTALLFLAGS Additional flags to pass to install(1).
147 MLINKS List of manual page links (using a .1 - .9 suffix). The
148 linked-to file must come first, the linked file second,
149 and there may be multiple pairs. The files are soft-linked.
151 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
154 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
156 The include file <bsd.own.mk> contains the owners, groups, etc. for both
157 manual pages and binaries.
161 It sets/uses the following variables:
169 STRIP The flag passed to the install program to cause the binary
170 to be stripped. This is to be used when building your
171 own install script so that the entire system can be made
172 stripped/not-stripped using a single knob.
174 MANDIR Base path for manual installation.
182 This file is generally useful when building your own Makefiles so that
183 they use the same default owners etc. as the rest of the tree.
185 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
187 The include file <bsd.prog.mk> handles building programs from one or
188 more source files, along with their manual pages. It has a limited number
189 of suffixes, consistent with the current needs of the BSD tree.
191 It has seven targets:
194 build the program and its manual page
196 remove the program and any object files.
198 remove all of the files removed by the target clean, as
199 well as .depend, tags, and any manual pages.
201 make the dependencies for the source files, and store
202 them in the file .depend.
204 install the program and its manual pages; if the Makefile
205 does not itself define the target install, the targets
206 beforeinstall and afterinstall may also be used to cause
207 actions immediately before and after the install target
210 run lint on the source files
212 create a tags file for the source files.
214 It sets/uses the following variables:
222 CLEANFILES Additional files to remove and
223 CLEANDIRS additional directories to remove during clean and cleandir
224 targets. "rm -f" and "rm -rf" used respectively.
226 COPTS Additional flags to the compiler when creating C objects.
228 FILES A list of non-executable files.
229 The installation is controlled by the FILESNAME, FILESOWN,
230 FILESGRP, FILESMODE, FILESDIR variables that can be
231 further specialized by <VAR>_<file>.
233 HIDEGAME If HIDEGAME is defined, the binary is installed in
234 /usr/games/hide, and a symbolic link is created to
237 LDADD Additional loader objects. Usually used for libraries.
238 For example, to load with the compatibility and utility
241 LDFILES=-lutil -lcompat
243 LDFLAGS Additional loader flags.
245 LINKS The list of binary links; should be full pathnames, the
246 linked-to file coming first, followed by the linked
247 file. The files are hard-linked. For example, to link
248 /bin/test and /bin/[, use:
250 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
252 MAN Manual pages (should end in .1 - .9). If no MAN variable
253 is defined, "MAN=${PROG}.1" is assumed.
255 PROG The name of the program to build. If not supplied, nothing
258 PROG_CXX If defined, the name of the program to build. Also
259 causes <bsd.prog.mk> to link the program with the
260 standard C++ library. PROG_CXX overrides the value
261 of PROG if PROG is also set.
263 PROGNAME The name that the above program will be installed as, if
264 different from ${PROG}.
266 SRCS List of source files to build the program. If SRCS is not
267 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
268 defined, ${PROG_CXX}.cc.
270 DPADD Additional dependencies for the program. Usually used for
271 libraries. For example, to depend on the compatibility and
272 utility libraries use:
274 DPADD= ${LIBCOMPAT} ${LIBUTIL}
276 There is a predefined identifier for each (non-profiled,
277 non-shared) library and object. Library file names are
278 transformed to identifiers by removing the extension and
279 converting to upper case.
281 There are no special identifiers for profiled or shared
282 libraries or objects. The identifiers for the standard
283 libraries are used in DPADD. This works correctly iff all
284 the libraries are built at the same time. Unfortunately,
285 it causes unnecessary relinks to shared libraries when
286 only the static libraries have changed. Dependencies on
287 shared libraries should be only on the library version
290 STRIP The flag passed to the install program to cause the binary
291 to be stripped. This is to be used when building your
292 own install script so that the entire system can be made
293 stripped/not-stripped using a single knob.
295 SUBDIR A list of subdirectories that should be built as well.
296 Each of the targets will execute the same target in the
299 SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
300 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
301 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
302 further specialized by SCRIPTS<VAR>_<script>.
304 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
305 if it exists, as well as the include file <bsd.man.mk>.
307 Some simple examples:
309 To build foo from foo.c with a manual page foo.1, use:
313 .include <bsd.prog.mk>
315 To build foo from foo.c with a manual page foo.2, add the line:
319 If foo does not have a manual page at all, add the line:
323 If foo has multiple source files, add the line:
325 SRCS= a.c b.c c.c d.c
327 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
329 The include file <bsd.subdir.mk> contains the default targets for building
330 subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
331 cleandir, depend, install, lint, and tags. For all of the directories
332 listed in the variable SUBDIRS, the specified directory will be visited
333 and the target made. There is also a default target which allows the
334 command "make subdir" where subdir is any directory listed in the variable
337 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
339 The include file <bsd.lib.mk> has support for building libraries. It has
340 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
341 install, lint, and tags. It has a limited number of suffixes, consistent
342 with the current needs of the BSD tree.
344 It sets/uses the following variables:
346 LIBDIR Target directory for libraries.
348 LINTLIBDIR Target directory for lint libraries.
350 LIBGRP Library group.
352 LIBOWN Library owner.
354 LIBMODE Library mode.
356 LDADD Additional loader objects.
358 MAN The manual pages to be installed (use a .1 - .9 suffix).
360 SRCS List of source files to build the library. Suffix types
361 .s, .c, and .f are supported. Note, .s files are preferred
362 to .c files of the same name. (This is not the default for
365 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
366 if it exists, as well as the include file <bsd.man.mk>.
368 It has rules for building profiled objects; profiled libraries are
371 Libraries are ranlib'd before installation.