1 # @(#)bsd.README 8.2 (Berkeley) 4/2/94
2 # $FreeBSD: src/share/mk/bsd.README,v 1.15.2.6 2002/07/19 08:34:07 ru Exp $
3 # $DragonFly: src/share/mk/bsd.README,v 1.5 2006/08/12 07:42:26 swildner Exp $
5 XXX This document is seriously out of date, it is currenly being revised.
7 This is the README file for the new make "include" files for the BSD
8 source tree. The files are installed in /usr/share/mk, and are, by
9 convention, named with the suffix ".mk".
11 bsd.cpu.gcc34.mk - handle GCC 3.4 specific CPU flags & variables
12 bsd.cpu.gcc40.mk - handle GCC 4.0 specific CPU flags & variables
13 bsd.cpu.mk - handle CPU flags & variables
14 bsd.dep.mk - handle Makefile dependencies
15 bsd.doc.mk - building troff system documents
20 bsd.info.mk - building GNU Info hypertext system
22 bsd.kmod.mk - building loadable kernel modules
23 bsd.lib.mk - support for building libraries
24 bsd.libnames.mk - define library names
26 bsd.man.mk - installing manual pages and their links
28 bsd.obj.mk - creating 'obj' directories and cleaning up
29 bsd.own.mk - define common variables
31 bsd.prog.mk - building programs from source files
32 bsd.subdir.mk - targets for building subdirectories
37 Note, this file is not intended to replace reading through the .mk
38 files for anything tricky.
40 See also make(1), mkdep(1) and `PMake - A Tutorial',
41 located in /usr/share/doc/psd/12.make.
43 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
45 RANDOM THINGS WORTH KNOWING:
47 The files are simply C-style #include files, and pretty much behave like
48 you'd expect. The syntax is slightly different in that a single '.' is
49 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
51 One difference that will save you lots of debugging time is that inclusion
52 of the file is normally done at the *end* of the Makefile. The reason for
53 this is because .mk files often modify variables and behavior based on the
54 values of variables set in the Makefile. To make this work, remember that
55 the FIRST target found is the target that is used, i.e. if the Makefile has:
62 the command "make a" will echo "a". To make things confusing, the SECOND
63 variable assignment is the overriding one, i.e. if the Makefile has:
71 the command "make b" will echo "bar". This is for compatibility with the
72 way the V7 make behaved.
74 It's fairly difficult to make the BSD .mk files work when you're building
75 multiple programs in a single directory. It's a lot easier split up the
76 programs than to deal with the problem. Most of the agony comes from making
77 the "obj" directory stuff work right, not because we switch to a new version
78 of make. So, don't get mad at us, figure out a better way to handle multiple
79 architectures so we can quit using the symbolic link stuff. (Imake doesn't
82 The file .depend in the source directory is expected to contain dependencies
83 for the source files. This file is read automatically by make after reading
86 The variable DESTDIR works as before. It's not set anywhere but will change
87 the tree where the file gets installed.
89 The profiled libraries are no longer built in a different directory than
90 the regular libraries. A new suffix, ".po", is used to denote a profiled
93 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
95 The include file <sys.mk> has the default rules for all makes, in the BSD
96 environment or otherwise. You probably don't want to touch this file.
98 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
100 The include file <bsd.man.mk> handles installing manual pages and their
103 It has three targets:
108 install the manual pages and their links.
110 verify the validity of manual pages.
112 It sets/uses the following variables:
114 MANDIR Base path for manual installation.
122 MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
123 or "/tahoe" for machine specific manual pages.
125 MAN The manual pages to be installed (use a .1 - .9 suffix).
127 MLINKS List of manual page links (using a .1 - .9 suffix). The
128 linked-to file must come first, the linked file second,
129 and there may be multiple pairs. The files are soft-linked.
131 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
134 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
136 The include file <bsd.own.mk> contains the owners, groups, etc. for both
137 manual pages and binaries.
141 It sets/uses the following variables:
149 STRIP The flag passed to the install program to cause the binary
150 to be stripped. This is to be used when building your
151 own install script so that the entire system can be made
152 stripped/not-stripped using a single nob.
154 MANDIR Base path for manual installation.
162 This file is generally useful when building your own Makefiles so that
163 they use the same default owners etc. as the rest of the tree.
165 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
167 The include file <bsd.prog.mk> handles building programs from one or
168 more source files, along with their manual pages. It has a limited number
169 of suffixes, consistent with the current needs of the BSD tree.
171 It has seven targets:
174 build the program and its manual page
176 remove the program, any object files and the files a.out,
177 Errs, errs, mklog, and ${PROG}.core.
179 remove all of the files removed by the target clean, as
180 well as .depend, tags, and any manual pages.
182 make the dependencies for the source files, and store
183 them in the file .depend.
185 install the program and its manual pages; if the Makefile
186 does not itself define the target install, the targets
187 beforeinstall and afterinstall may also be used to cause
188 actions immediately before and after the install target
191 run lint on the source files
193 create a tags file for the source files.
195 It sets/uses the following variables:
203 CLEANFILES Additional files to remove and
204 CLEANDIRS additional directories to remove during clean and cleandir
205 targets. "rm -f" and "rm -rf" used respectively.
207 COPTS Additional flags to the compiler when creating C objects.
209 FILES A list of non-executable files.
210 The installation is controlled by the FILESNAME, FILESOWN,
211 FILESGRP, FILESMODE, FILESDIR variables that can be
212 further specialized by FILES<VAR>_<file>.
214 HIDEGAME If HIDEGAME is defined, the binary is installed in
215 /usr/games/hide, and a symbolic link is created to
218 LDADD Additional loader objects. Usually used for libraries.
219 For example, to load with the compatibility and utility
222 LDFILES=-lutil -lcompat
224 LDFLAGS Additional loader flags.
226 LINKS The list of binary links; should be full pathnames, the
227 linked-to file coming first, followed by the linked
228 file. The files are hard-linked. For example, to link
229 /bin/test and /bin/[, use:
231 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
233 MAN Manual pages (should end in .1 - .9). If no MAN variable
234 is defined, "MAN=${PROG}.1" is assumed.
236 PROG The name of the program to build. If not supplied, nothing
239 PROG_CXX If defined, the name of the program to build. Also
240 causes <bsd.prog.mk> to link the program with the
241 standard C++ library. PROG_CXX overrides the value
242 of PROG if PROG is also set.
244 PROGNAME The name that the above program will be installed as, if
245 different from ${PROG}.
247 SRCS List of source files to build the program. If SRCS is not
248 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
249 defined, ${PROG_CXX}.cc.
251 DPADD Additional dependencies for the program. Usually used for
252 libraries. For example, to depend on the compatibility and
253 utility libraries use:
255 SRCLIB=${LIBCOMPAT} ${LIBUTIL}
257 There is a predefined identifier for each (non-profiled,
258 non-shared) library and object. Library file names are
259 transformed to identifiers by removing the extension and
260 converting to upper case.
262 There are no special identifiers for profiled or shared
263 libraries or objects. The identifiers for the standard
264 libraries are used in DPADD. This works correctly iff all
265 the libraries are built at the same time. Unfortunately,
266 it causes unnecessary relinks to shared libraries when
267 only the static libraries have changed. Dependencies on
268 shared libraries should be only on the library version
271 STRIP The flag passed to the install program to cause the binary
274 SUBDIR A list of subdirectories that should be built as well.
275 Each of the targets will execute the same target in the
278 SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
279 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
280 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
281 further specialized by SCRIPTS<VAR>_<script>.
283 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
284 if it exists, as well as the include file <bsd.man.mk>.
286 Some simple examples:
288 To build foo from foo.c with a manual page foo.1, use:
292 .include <bsd.prog.mk>
294 To build foo from foo.c with a manual page foo.2, add the line:
298 If foo does not have a manual page at all, add the line:
302 If foo has multiple source files, add the line:
304 SRCS= a.c b.c c.c d.c
306 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
308 The include file <bsd.subdir.mk> contains the default targets for building
309 subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
310 cleandir, depend, install, lint, and tags. For all of the directories
311 listed in the variable SUBDIRS, the specified directory will be visited
312 and the target made. There is also a default target which allows the
313 command "make subdir" where subdir is any directory listed in the variable
316 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
318 The include file <bsd.lib.mk> has support for building libraries. It has
319 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
320 install, lint, and tags. It has a limited number of suffixes, consistent
321 with the current needs of the BSD tree.
323 It sets/uses the following variables:
325 LIBDIR Target directory for libraries.
327 LINTLIBDIR Target directory for lint libraries.
329 LIBGRP Library group.
331 LIBOWN Library owner.
333 LIBMODE Library mode.
335 LDADD Additional loader objects.
337 MAN The manual pages to be installed (use a .1 - .9 suffix).
339 SRCS List of source files to build the library. Suffix types
340 .s, .c, and .f are supported. Note, .s files are preferred
341 to .c files of the same name. (This is not the default for
344 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
345 if it exists, as well as the include file <bsd.man.mk>.
347 It has rules for building profiled objects; profiled libraries are
350 Libraries are ranlib'd before installation.