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.crunchgen.mk - building crunched binaries using crunchgen(1)
24 bsd.dep.mk - handle Makefile dependencies
25 bsd.doc.mk - building troff system documents
26 bsd.files.mk - install of general purpose files
29 bsd.incs.mk - install of include files
30 bsd.init.mk - initialization for the make include files
31 bsd.kmod.mk - building loadable kernel modules
32 bsd.lib.mk - support for building libraries
33 bsd.libnames.mk - define library names
34 bsd.links.mk - install of links (sym/hard)
35 bsd.man.mk - install of manual pages and their links
36 bsd.nls.mk - build and install of NLS catalogs
37 bsd.obj.mk - creating 'obj' directories and cleaning up
38 bsd.own.mk - define common variables
40 bsd.prog.mk - building programs from source files
41 bsd.subdir.mk - targets for building subdirectories
42 bsd.sys.mk - common settings used for building DragonFly sources
43 sys.mk - default rules for all makes
46 See also make(1), mkdep(1) and `PMake - A Tutorial',
47 located in /usr/src/share/doc/psd/12.make.
49 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
51 Random things worth knowing about this document:
53 If appropriate when documenting the variables the default value is
54 indicated using square brackets e.g. [gzip].
55 In some cases the default value depend on other values (e.g. system
56 architecture). In these cases the most common value is indicated.
58 This document contains some simple examples of the usage of the BSD make
59 include files. For more examples look at the makefiles in the DragonFly
62 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
64 RANDOM THINGS WORTH KNOWING:
66 The files are like C-style #include files, and pretty much behave like
67 you'd expect. The syntax is slightly different in that a single '.' is
68 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
70 One difference that will save you lots of debugging time is that inclusion
71 of the file is normally done at the *end* of the Makefile. The reason for
72 this is because .mk files often modify variables and behavior based on the
73 values of variables set in the Makefile. To make this work, remember that
74 the FIRST target found is the target that is used, i.e. if the Makefile has:
81 the command "make a" will echo "a". To make things confusing, the SECOND
82 variable assignment is the overriding one, i.e. if the Makefile has:
90 the command "make b" will echo "bar". This is for compatibility with the
91 way the V7 make behaved.
93 It's fairly difficult to make the BSD .mk files work when you're building
94 multiple programs in a single directory. It's a lot easier split up the
95 programs than to deal with the problem. Most of the agony comes from making
96 the "obj" directory stuff work right, not because we switch to a new version
97 of make. So, don't get mad at us, figure out a better way to handle multiple
98 architectures so we can quit using the symbolic link stuff. (Imake doesn't
101 The file .depend in the source directory is expected to contain dependencies
102 for the source files. This file is read automatically by make after reading
105 The variable DESTDIR works as before. It's not set anywhere but will change
106 the tree where the file gets installed.
108 The profiled libraries are no longer built in a different directory than
109 the regular libraries. A new suffix, ".po", is used to denote a profiled
112 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
114 The include file <sys.mk> has the default rules for all makes, in the BSD
115 environment or otherwise. You probably don't want to touch this file.
117 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
119 The include file <bsd.man.mk> handles installing manual pages and their
122 It has three targets:
127 install the manual pages and their links.
129 verify the validity of manual pages.
131 It sets/uses the following variables:
133 MANDIR Base path for manual installation.
141 MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
142 or "/tahoe" for machine specific manual pages.
144 MAN The manual pages to be installed (use a .1 - .9 suffix).
146 MANINSTALLFLAGS Additional flags to pass to install(1).
148 MLINKS List of manual page links (using a .1 - .9 suffix). The
149 linked-to file must come first, the linked file second,
150 and there may be multiple pairs. The files are soft-linked.
152 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
155 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
157 The include file <bsd.own.mk> contains the owners, groups, etc. for both
158 manual pages and binaries.
162 It sets/uses the following variables:
170 STRIP The flag passed to the install program to cause the binary
171 to be stripped. This is to be used when building your
172 own install script so that the entire system can be made
173 stripped/not-stripped using a single knob.
175 MANDIR Base path for manual installation.
183 This file is generally useful when building your own Makefiles so that
184 they use the same default owners etc. as the rest of the tree.
186 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
188 The include file <bsd.prog.mk> handles building programs from one or
189 more source files, along with their manual pages. It has a limited number
190 of suffixes, consistent with the current needs of the BSD tree.
192 It has seven targets:
195 build the program and its manual page
197 remove the program and any object files.
199 remove all of the files removed by the target clean, as
200 well as .depend, tags, and any manual pages.
202 make the dependencies for the source files, and store
203 them in the file .depend.
205 install the program and its manual pages; if the Makefile
206 does not itself define the target install, the targets
207 beforeinstall and afterinstall may also be used to cause
208 actions immediately before and after the install target
211 run lint on the source files
213 create a tags file for the source files.
215 It sets/uses the following variables:
223 CLEANFILES Additional files to remove and
224 CLEANDIRS additional directories to remove during clean and cleandir
225 targets. "rm -f" and "rm -rf" used respectively.
227 COPTS Additional flags to the compiler when creating C objects.
229 FILES A list of non-executable files.
230 The installation is controlled by the FILESNAME, FILESOWN,
231 FILESGRP, FILESMODE, FILESDIR variables that can be
232 further specialized by <VAR>_<file>.
234 HIDEGAME If HIDEGAME is defined, the binary is installed in
235 /usr/games/hide, and a symbolic link is created to
238 LDADD Additional loader objects. Usually used for libraries.
239 For example, to load with the compatibility and utility
242 LDFILES=-lutil -lcompat
244 LDFLAGS Additional loader flags.
246 LINKS The list of binary links; should be full pathnames, the
247 linked-to file coming first, followed by the linked
248 file. The files are hard-linked. For example, to link
249 /bin/test and /bin/[, use:
251 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
253 MAN Manual pages (should end in .1 - .9). If no MAN variable
254 is defined, "MAN=${PROG}.1" is assumed.
256 PROG The name of the program to build. If not supplied, nothing
259 PROG_CXX If defined, the name of the program to build. Also
260 causes <bsd.prog.mk> to link the program with the
261 standard C++ library. PROG_CXX overrides the value
262 of PROG if PROG is also set.
264 PROGNAME The name that the above program will be installed as, if
265 different from ${PROG}.
267 SRCS List of source files to build the program. If SRCS is not
268 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
269 defined, ${PROG_CXX}.cc.
271 DPADD Additional dependencies for the program. Usually used for
272 libraries. For example, to depend on the compatibility and
273 utility libraries use:
275 DPADD= ${LIBCOMPAT} ${LIBUTIL}
277 There is a predefined identifier for each (non-profiled,
278 non-shared) library and object. Library file names are
279 transformed to identifiers by removing the extension and
280 converting to upper case.
282 There are no special identifiers for profiled or shared
283 libraries or objects. The identifiers for the standard
284 libraries are used in DPADD. This works correctly iff all
285 the libraries are built at the same time. Unfortunately,
286 it causes unnecessary relinks to shared libraries when
287 only the static libraries have changed. Dependencies on
288 shared libraries should be only on the library version
291 STRIP The flag passed to the install program to cause the binary
292 to be stripped. This is to be used when building your
293 own install script so that the entire system can be made
294 stripped/not-stripped using a single knob.
296 SUBDIR A list of subdirectories that should be built as well.
297 Each of the targets will execute the same target in the
300 SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
301 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
302 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
303 further specialized by SCRIPTS<VAR>_<script>.
305 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
306 if it exists, as well as the include file <bsd.man.mk>.
308 Some simple examples:
310 To build foo from foo.c with a manual page foo.1, use:
314 .include <bsd.prog.mk>
316 To build foo from foo.c with a manual page foo.2, add the line:
320 If foo does not have a manual page at all, add the line:
324 If foo has multiple source files, add the line:
326 SRCS= a.c b.c c.c d.c
328 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
330 The include file <bsd.subdir.mk> contains the default targets for building
331 subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
332 cleandir, depend, install, lint, and tags. For all of the directories
333 listed in the variable SUBDIRS, the specified directory will be visited
334 and the target made. There is also a default target which allows the
335 command "make subdir" where subdir is any directory listed in the variable
338 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
340 The include file <bsd.lib.mk> has support for building libraries. It has
341 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
342 install, lint, and tags. It has a limited number of suffixes, consistent
343 with the current needs of the BSD tree.
345 It sets/uses the following variables:
347 LIBDIR Target directory for libraries.
349 LINTLIBDIR Target directory for lint libraries.
351 LIBGRP Library group.
353 LIBOWN Library owner.
355 LIBMODE Library mode.
357 LDADD Additional loader objects.
359 MAN The manual pages to be installed (use a .1 - .9 suffix).
361 SRCS List of source files to build the library. Suffix types
362 .s, .c, and .f are supported. Note, .s files are preferred
363 to .c files of the same name. (This is not the default for
366 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
367 if it exists, as well as the include file <bsd.man.mk>.
369 It has rules for building profiled objects; profiled libraries are
372 Libraries are ranlib'd before installation.