42sys.mk - default rules for all makes
43
44This file does not document bsd.port*.mk. They are documented in ports(7).
45
46See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
47Tutorial', located in /usr/share/doc/psd/12.make.
48
49=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
50
51Random things worth knowing about this document:
52
53If appropriate when documenting the variables the default value is
54indicated using square brackets e.g. [gzip].
55In some cases the default value depend on other values (e.g. system
56architecture). In these cases the most common value is indicated.
57
58This document contains some simple examples of the usage of the BSD make
59include files. For more examples look at the makefiles in the FreeBSD
60source tree.
61
62=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
63
64RANDOM THINGS WORTH KNOWING:
65
66The files are like C-style #include files, and pretty much behave like
67you'd expect. The syntax is slightly different in that a single '.' is
68used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
69
70One difference that will save you lots of debugging time is that inclusion
71of the file is normally done at the *end* of the Makefile. The reason for
72this is because .mk files often modify variables and behavior based on the
73values of variables set in the Makefile. To make this work, remember that
74the FIRST target found is the target that is used, i.e. if the Makefile has:
75
76 a:
77 echo a
78 a:
79 echo a number two
80
81the command "make a" will echo "a". To make things confusing, the SECOND
82variable assignment is the overriding one, i.e. if the Makefile has:
83
84 a= foo
85 a= bar
86
87 b:
88 echo ${a}
89
90the command "make b" will echo "bar". This is for compatibility with the
91way the V7 make behaved.
92
93It's fairly difficult to make the BSD .mk files work when you're building
94multiple programs in a single directory. It's a lot easier to split up
95the programs than to deal with the problem. Most of the agony comes from
96making the "obj" directory stuff work right, not because we switch to a new
97version of make. So, don't get mad at us, figure out a better way to handle
98multiple architectures so we can quit using the symbolic link stuff.
99(Imake doesn't count.)
100
101The file .depend in the source directory is expected to contain dependencies
102for the source files. This file is read automatically by make after reading
103the Makefile.
104
105The variable DESTDIR works as before. It's not set anywhere but will change
106the tree where the file gets installed.
107
108The profiled libraries are no longer built in a different directory than
109the regular libraries. A new suffix, ".po", is used to denote a profiled
110object.
111
112=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
113
114The include file <sys.mk> has the default rules for all makes, in the BSD
115environment or otherwise. You probably don't want to touch this file.
116
117=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
118
119The include file <bsd.man.mk> handles installing manual pages and their
120links.
121
122It has three targets:
123
124 all-man:
125 build manual pages.
126 maninstall:
127 install the manual pages and their links.
128 manlint:
129 verify the validity of manual pages.
130
131It sets/uses the following variables:
132
133MANDIR Base path for manual installation.
134
135MANGRP Manual group.
136
137MANOWN Manual owner.
138
139MANMODE Manual mode.
140
141MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
142 or "/tahoe" for machine specific manual pages.
143
144MAN The manual pages to be installed (use a .1 - .9 suffix).
145
146MLINKS List of manual page links (using a .1 - .9 suffix). The
147 linked-to file must come first, the linked file second,
148 and there may be multiple pairs. The files are soft-linked.
149
150The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
151it exists.
152
153=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
154
155The include file <bsd.own.mk> contains the owners, groups, etc. for both
156manual pages and binaries.
157
158It has no targets.
159
160It sets/uses the following variables:
161
162BINGRP Binary group.
163
164BINOWN Binary owner.
165
166BINMODE Binary mode.
167
168MANDIR Base path for manual installation.
169
170MANGRP Manual group.
171
172MANOWN Manual owner.
173
174MANMODE Manual mode.
175
176This file is generally useful when building your own Makefiles so that
177they use the same default owners etc. as the rest of the tree.
178
179=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
180
181The include file <bsd.prog.mk> handles building programs from one or
182more source files, along with their manual pages. It has a limited number
183of suffixes, consistent with the current needs of the BSD tree.
184
185It has seven targets:
186
187 all:
188 build the program and its manual page
189 clean:
190 remove the program and any object files.
191 cleandir:
192 remove all of the files removed by the target clean, as
193 well as .depend, tags, and any manual pages.
194 depend:
195 make the dependencies for the source files, and store
196 them in the file .depend.
197 install:
198 install the program and its manual pages; if the Makefile
199 does not itself define the target install, the targets
200 beforeinstall and afterinstall may also be used to cause
201 actions immediately before and after the install target
202 is executed.
203 lint:
204 run lint on the source files
205 tags:
206 create a tags file for the source files.
207
208It sets/uses the following variables:
209
210BINGRP Binary group.
211
212BINOWN Binary owner.
213
214BINMODE Binary mode.
215
216CLEANFILES Additional files to remove and
217CLEANDIRS additional directories to remove during clean and cleandir
218 targets. "rm -f" and "rm -rf" used respectively.
219
220CFLAGS Flags to the compiler when creating C objects.
221
222FILES A list of non-executable files.
223 The installation is controlled by the FILESNAME, FILESOWN,
224 FILESGRP, FILESMODE, FILESDIR variables that can be
225 further specialized by FILES<VAR>_<file>.
226
227LDADD Additional loader objects. Usually used for libraries.
228 For example, to load with the compatibility and utility
229 libraries, use:
230
231 LDADD=-lutil -lcompat
232
233LDFLAGS Additional loader flags.
234
235LINKS The list of binary links; should be full pathnames, the
236 linked-to file coming first, followed by the linked
237 file. The files are hard-linked. For example, to link
238 /bin/test and /bin/[, use:
239
240 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
241
242MAN Manual pages (should end in .1 - .9). If no MAN variable
243 is defined, "MAN=${PROG}.1" is assumed.
244
245PROG The name of the program to build. If not supplied, nothing
246 is built.
247
248PROG_CXX If defined, the name of the program to build. Also
249 causes <bsd.prog.mk> to link the program with the
250 standard C++ library. PROG_CXX overrides the value
251 of PROG if PROG is also set.
252
253PROGNAME The name that the above program will be installed as, if
254 different from ${PROG}.
255
256SRCS List of source files to build the program. If SRCS is not
257 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
258 defined, ${PROG_CXX}.cc.
259
260DPADD Additional dependencies for the program. Usually used for
261 libraries. For example, to depend on the compatibility and
262 utility libraries use:
263
264 DPADD=${LIBCOMPAT} ${LIBUTIL}
265
266 There is a predefined identifier for each (non-profiled,
267 non-shared) library and object. Library file names are
268 transformed to identifiers by removing the extension and
269 converting to upper case.
270
271 There are no special identifiers for profiled or shared
272 libraries or objects. The identifiers for the standard
273 libraries are used in DPADD. This works correctly iff all
274 the libraries are built at the same time. Unfortunately,
275 it causes unnecessary relinks to shared libraries when
276 only the static libraries have changed. Dependencies on
277 shared libraries should be only on the library version
278 numbers.
279
280STRIP The flag passed to the install program to cause the binary
281 to be stripped. This is to be used when building your
282 own install script so that the entire system can be made
283 stripped/not-stripped using a single nob.
284
285SUBDIR A list of subdirectories that should be built as well.
286 Each of the targets will execute the same target in the
287 subdirectories.
288
289SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
290 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
291 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
292 further specialized by SCRIPTS<VAR>_<script>.
293
294The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
295if it exists, as well as the include file <bsd.man.mk>.
296
297Some simple examples:
298
299To build foo from foo.c with a manual page foo.1, use:
300
301 PROG= foo
302
303 .include <bsd.prog.mk>
304
305To build foo from foo.c with a manual page foo.2, add the line:
306
307 MAN= foo.2
308
309If foo does not have a manual page at all, add the line:
310
311 NO_MAN=
312
313If foo has multiple source files, add the line:
314
315 SRCS= a.c b.c c.c d.c
316
317=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
318
319The include file <bsd.subdir.mk> contains the default targets for building
320subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
321cleandir, depend, install, lint, and tags. For all of the directories
322listed in the variable SUBDIRS, the specified directory will be visited
323and the target made. There is also a default target which allows the
324command "make subdir" where subdir is any directory listed in the variable
325SUBDIRS.
326
327=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
328
329The include file <bsd.lib.mk> has support for building libraries. It has
330the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
331install, lint, and tags. It has a limited number of suffixes, consistent
332with the current needs of the BSD tree.
333
334It sets/uses the following variables:
335
336LIBDIR Target directory for libraries.
337
338LINTLIBDIR Target directory for lint libraries.
339
340LIBGRP Library group.
341
342LIBOWN Library owner.
343
344LIBMODE Library mode.
345
346LDADD Additional loader objects.
347
348MAN The manual pages to be installed (use a .1 - .9 suffix).
349
350SRCS List of source files to build the library. Suffix types
351 .s, .c, and .f are supported. Note, .s files are preferred
352 to .c files of the same name. (This is not the default for
353 versions of make.)
354
355SHLIB_LDSCRIPT Template file to generate shared library linker script.
356 Unless used, a simple symlink is created to the real
357 shared object.
358
359LIBRARIES_ONLY Do not build or install files other than the library.
360
361The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
362if it exists, as well as the include file <bsd.man.mk>.
363
364It has rules for building profiled objects; profiled libraries are
365built by default.
366
367Libraries are ranlib'd before installation.
| 43sys.mk - default rules for all makes
44
45This file does not document bsd.port*.mk. They are documented in ports(7).
46
47See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
48Tutorial', located in /usr/share/doc/psd/12.make.
49
50=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
51
52Random things worth knowing about this document:
53
54If appropriate when documenting the variables the default value is
55indicated using square brackets e.g. [gzip].
56In some cases the default value depend on other values (e.g. system
57architecture). In these cases the most common value is indicated.
58
59This document contains some simple examples of the usage of the BSD make
60include files. For more examples look at the makefiles in the FreeBSD
61source tree.
62
63=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
64
65RANDOM THINGS WORTH KNOWING:
66
67The files are like C-style #include files, and pretty much behave like
68you'd expect. The syntax is slightly different in that a single '.' is
69used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
70
71One difference that will save you lots of debugging time is that inclusion
72of the file is normally done at the *end* of the Makefile. The reason for
73this is because .mk files often modify variables and behavior based on the
74values of variables set in the Makefile. To make this work, remember that
75the FIRST target found is the target that is used, i.e. if the Makefile has:
76
77 a:
78 echo a
79 a:
80 echo a number two
81
82the command "make a" will echo "a". To make things confusing, the SECOND
83variable assignment is the overriding one, i.e. if the Makefile has:
84
85 a= foo
86 a= bar
87
88 b:
89 echo ${a}
90
91the command "make b" will echo "bar". This is for compatibility with the
92way the V7 make behaved.
93
94It's fairly difficult to make the BSD .mk files work when you're building
95multiple programs in a single directory. It's a lot easier to split up
96the programs than to deal with the problem. Most of the agony comes from
97making the "obj" directory stuff work right, not because we switch to a new
98version of make. So, don't get mad at us, figure out a better way to handle
99multiple architectures so we can quit using the symbolic link stuff.
100(Imake doesn't count.)
101
102The file .depend in the source directory is expected to contain dependencies
103for the source files. This file is read automatically by make after reading
104the Makefile.
105
106The variable DESTDIR works as before. It's not set anywhere but will change
107the tree where the file gets installed.
108
109The profiled libraries are no longer built in a different directory than
110the regular libraries. A new suffix, ".po", is used to denote a profiled
111object.
112
113=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
114
115The include file <sys.mk> has the default rules for all makes, in the BSD
116environment or otherwise. You probably don't want to touch this file.
117
118=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
119
120The include file <bsd.man.mk> handles installing manual pages and their
121links.
122
123It has three targets:
124
125 all-man:
126 build manual pages.
127 maninstall:
128 install the manual pages and their links.
129 manlint:
130 verify the validity of manual pages.
131
132It sets/uses the following variables:
133
134MANDIR Base path for manual installation.
135
136MANGRP Manual group.
137
138MANOWN Manual owner.
139
140MANMODE Manual mode.
141
142MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
143 or "/tahoe" for machine specific manual pages.
144
145MAN The manual pages to be installed (use a .1 - .9 suffix).
146
147MLINKS 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.
150
151The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
152it exists.
153
154=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
155
156The include file <bsd.own.mk> contains the owners, groups, etc. for both
157manual pages and binaries.
158
159It has no targets.
160
161It sets/uses the following variables:
162
163BINGRP Binary group.
164
165BINOWN Binary owner.
166
167BINMODE Binary mode.
168
169MANDIR Base path for manual installation.
170
171MANGRP Manual group.
172
173MANOWN Manual owner.
174
175MANMODE Manual mode.
176
177This file is generally useful when building your own Makefiles so that
178they use the same default owners etc. as the rest of the tree.
179
180=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
181
182The include file <bsd.prog.mk> handles building programs from one or
183more source files, along with their manual pages. It has a limited number
184of suffixes, consistent with the current needs of the BSD tree.
185
186It has seven targets:
187
188 all:
189 build the program and its manual page
190 clean:
191 remove the program and any object files.
192 cleandir:
193 remove all of the files removed by the target clean, as
194 well as .depend, tags, and any manual pages.
195 depend:
196 make the dependencies for the source files, and store
197 them in the file .depend.
198 install:
199 install the program and its manual pages; if the Makefile
200 does not itself define the target install, the targets
201 beforeinstall and afterinstall may also be used to cause
202 actions immediately before and after the install target
203 is executed.
204 lint:
205 run lint on the source files
206 tags:
207 create a tags file for the source files.
208
209It sets/uses the following variables:
210
211BINGRP Binary group.
212
213BINOWN Binary owner.
214
215BINMODE Binary mode.
216
217CLEANFILES Additional files to remove and
218CLEANDIRS additional directories to remove during clean and cleandir
219 targets. "rm -f" and "rm -rf" used respectively.
220
221CFLAGS Flags to the compiler when creating C objects.
222
223FILES A list of non-executable files.
224 The installation is controlled by the FILESNAME, FILESOWN,
225 FILESGRP, FILESMODE, FILESDIR variables that can be
226 further specialized by FILES<VAR>_<file>.
227
228LDADD Additional loader objects. Usually used for libraries.
229 For example, to load with the compatibility and utility
230 libraries, use:
231
232 LDADD=-lutil -lcompat
233
234LDFLAGS Additional loader flags.
235
236LINKS The list of binary links; should be full pathnames, the
237 linked-to file coming first, followed by the linked
238 file. The files are hard-linked. For example, to link
239 /bin/test and /bin/[, use:
240
241 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
242
243MAN Manual pages (should end in .1 - .9). If no MAN variable
244 is defined, "MAN=${PROG}.1" is assumed.
245
246PROG The name of the program to build. If not supplied, nothing
247 is built.
248
249PROG_CXX If defined, the name of the program to build. Also
250 causes <bsd.prog.mk> to link the program with the
251 standard C++ library. PROG_CXX overrides the value
252 of PROG if PROG is also set.
253
254PROGNAME The name that the above program will be installed as, if
255 different from ${PROG}.
256
257SRCS List of source files to build the program. If SRCS is not
258 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
259 defined, ${PROG_CXX}.cc.
260
261DPADD Additional dependencies for the program. Usually used for
262 libraries. For example, to depend on the compatibility and
263 utility libraries use:
264
265 DPADD=${LIBCOMPAT} ${LIBUTIL}
266
267 There is a predefined identifier for each (non-profiled,
268 non-shared) library and object. Library file names are
269 transformed to identifiers by removing the extension and
270 converting to upper case.
271
272 There are no special identifiers for profiled or shared
273 libraries or objects. The identifiers for the standard
274 libraries are used in DPADD. This works correctly iff all
275 the libraries are built at the same time. Unfortunately,
276 it causes unnecessary relinks to shared libraries when
277 only the static libraries have changed. Dependencies on
278 shared libraries should be only on the library version
279 numbers.
280
281STRIP The flag passed to the install program to cause the binary
282 to be stripped. This is to be used when building your
283 own install script so that the entire system can be made
284 stripped/not-stripped using a single nob.
285
286SUBDIR A list of subdirectories that should be built as well.
287 Each of the targets will execute the same target in the
288 subdirectories.
289
290SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
291 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
292 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
293 further specialized by SCRIPTS<VAR>_<script>.
294
295The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
296if it exists, as well as the include file <bsd.man.mk>.
297
298Some simple examples:
299
300To build foo from foo.c with a manual page foo.1, use:
301
302 PROG= foo
303
304 .include <bsd.prog.mk>
305
306To build foo from foo.c with a manual page foo.2, add the line:
307
308 MAN= foo.2
309
310If foo does not have a manual page at all, add the line:
311
312 NO_MAN=
313
314If foo has multiple source files, add the line:
315
316 SRCS= a.c b.c c.c d.c
317
318=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
319
320The include file <bsd.subdir.mk> contains the default targets for building
321subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
322cleandir, depend, install, lint, and tags. For all of the directories
323listed in the variable SUBDIRS, the specified directory will be visited
324and the target made. There is also a default target which allows the
325command "make subdir" where subdir is any directory listed in the variable
326SUBDIRS.
327
328=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
329
330The include file <bsd.lib.mk> has support for building libraries. It has
331the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
332install, lint, and tags. It has a limited number of suffixes, consistent
333with the current needs of the BSD tree.
334
335It sets/uses the following variables:
336
337LIBDIR Target directory for libraries.
338
339LINTLIBDIR Target directory for lint libraries.
340
341LIBGRP Library group.
342
343LIBOWN Library owner.
344
345LIBMODE Library mode.
346
347LDADD Additional loader objects.
348
349MAN The manual pages to be installed (use a .1 - .9 suffix).
350
351SRCS List of source files to build the library. Suffix types
352 .s, .c, and .f are supported. Note, .s files are preferred
353 to .c files of the same name. (This is not the default for
354 versions of make.)
355
356SHLIB_LDSCRIPT Template file to generate shared library linker script.
357 Unless used, a simple symlink is created to the real
358 shared object.
359
360LIBRARIES_ONLY Do not build or install files other than the library.
361
362The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
363if it exists, as well as the include file <bsd.man.mk>.
364
365It has rules for building profiled objects; profiled libraries are
366built by default.
367
368Libraries are ranlib'd before installation.
|