1# @(#)bsd.README 8.2 (Berkeley) 4/2/94 2# $FreeBSD$ 3 4This is the README file for the "include" files for the FreeBSD 5source tree. The files are installed in /usr/share/mk, and are by 6convention, named with the suffix ".mk". These files store several 7build options and should be handled with caution. 8 9Note, this file is not intended to replace reading through the .mk 10files for anything tricky. 11 12There are two main types of make include files. One type is the generally 13usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is 14the internal make include files, such as bsd.files.mk and bsd.man.mk, which 15can not/should not be used directly but are used by the other make include 16files. In most cases it is only interesting to include bsd.prog.mk or 17bsd.lib.mk. 18 19bsd.cpu.mk - sets CPU/arch-related variables 20bsd.dep.mk - handle Makefile dependencies 21bsd.doc.mk - building troff system documents 22bsd.files.mk - install of general purpose files 23bsd.incs.mk - install of include files 24bsd.info.mk - building GNU Info hypertext system 25bsd.init.mk - initialization for the make include files 26bsd.kmod.mk - building loadable kernel modules 27bsd.lib.mk - support for building libraries 28bsd.libnames.mk - define library names 29bsd.links.mk - install of links (sym/hard) 30bsd.man.mk - install of manual pages and their links 31bsd.nls.mk - build and install of NLS catalogs 32bsd.obj.mk - creating 'obj' directories and cleaning up 33bsd.own.mk - define common variables 34bsd.port.mk - building ports 35bsd.port.post.mk - building ports 36bsd.port.pre.mk - building ports 37bsd.port.subdir.mk - targets for building subdirectories for ports 38bsd.prog.mk - building programs from source files 39bsd.subdir.mk - targets for building subdirectories 40bsd.sys.mk - common settings used for building FreeBSD sources 41sys.mk - default rules for all makes 42 43This file does not document bsd.port*.mk. They are documented in ports(7). 44 45See also make(1), mkdep(1), style.Makefile(5) and `PMake - A 46Tutorial', located in /usr/share/doc/psd/12.make. 47 48=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 49 50Random things worth knowing about this document: 51 52If appropriate when documenting the variables the default value is 53indicated using square brackets e.g. [gzip]. 54In some cases the default value depend on other values (e.g. system 55architecture). In these cases the most common value is indicated. 56 57This document contains some simple examples of the usage of the BSD make 58include files. For more examples look at the makefiles in the FreeBSD 59source tree. 60 61=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 62 63RANDOM THINGS WORTH KNOWING: 64 65The files are like C-style #include files, and pretty much behave like 66you'd expect. The syntax is slightly different in that a single '.' is 67used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 68 69One difference that will save you lots of debugging time is that inclusion 70of the file is normally done at the *end* of the Makefile. The reason for 71this is because .mk files often modify variables and behavior based on the 72values of variables set in the Makefile. To make this work, remember that 73the FIRST target found is the target that is used, i.e. if the Makefile has: 74 75 a: 76 echo a 77 a: 78 echo a number two 79 80the command "make a" will echo "a". To make things confusing, the SECOND 81variable assignment is the overriding one, i.e. if the Makefile has: 82 83 a= foo 84 a= bar 85 86 b: 87 echo ${a} 88 89the command "make b" will echo "bar". This is for compatibility with the 90way the V7 make behaved. 91 92It's fairly difficult to make the BSD .mk files work when you're building 93multiple programs in a single directory. It's a lot easier split up the 94programs than to deal with the problem. Most of the agony comes from making 95the "obj" directory stuff work right, not because we switch to a new version 96of make. So, don't get mad at us, figure out a better way to handle multiple 97architectures so we can quit using the symbolic link stuff. (Imake doesn't 98count.) 99 100The file .depend in the source directory is expected to contain dependencies 101for the source files. This file is read automatically by make after reading 102the Makefile. 103 104The variable DESTDIR works as before. It's not set anywhere but will change 105the tree where the file gets installed. 106 107The profiled libraries are no longer built in a different directory than 108the regular libraries. A new suffix, ".po", is used to denote a profiled 109object. 110 111=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 112 113The include file <sys.mk> has the default rules for all makes, in the BSD 114environment or otherwise. You probably don't want to touch this file. 115 116=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 117 118The include file <bsd.man.mk> handles installing manual pages and their 119links. 120 121It has three targets: 122 123 all-man: 124 build manual pages. 125 maninstall: 126 install the manual pages and their links. 127 manlint: 128 verify the validity of manual pages. 129 130It sets/uses the following variables: 131 132MANDIR Base path for manual installation. 133 134MANGRP Manual group. 135 136MANOWN Manual owner. 137 138MANMODE Manual mode. 139 140MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 141 or "/tahoe" for machine specific manual pages. 142 143MAN The manual pages to be installed (use a .1 - .9 suffix). 144 145MLINKS List of manual page links (using a .1 - .9 suffix). The 146 linked-to file must come first, the linked file second, 147 and there may be multiple pairs. The files are soft-linked. 148 149The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 150it exists. 151 152=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 153 154The include file <bsd.own.mk> contains the owners, groups, etc. for both 155manual pages and binaries. 156 157It has no targets. 158 159It sets/uses the following variables: 160 161BINGRP Binary group. 162 163BINOWN Binary owner. 164 165BINMODE Binary mode. 166 167MANDIR Base path for manual installation. 168 169MANGRP Manual group. 170 171MANOWN Manual owner. 172 173MANMODE Manual mode. 174 175This file is generally useful when building your own Makefiles so that 176they use the same default owners etc. as the rest of the tree. 177 178=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 179 180The include file <bsd.prog.mk> handles building programs from one or 181more source files, along with their manual pages. It has a limited number 182of suffixes, consistent with the current needs of the BSD tree. 183 184It has seven targets: 185 186 all: 187 build the program and its manual page 188 clean: 189 remove the program, any object files and the files a.out, 190 Errs, errs, mklog, and ${PROG}.core. 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 220COPTS Additional 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 LDFILES=-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 SRCLIB=${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 MAN2= foo.2 308 309If foo does not have a manual page at all, add the line: 310 311 NOMAN= noman 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 355The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 356if it exists, as well as the include file <bsd.man.mk>. 357 358It has rules for building profiled objects; profiled libraries are 359built by default. 360 361Libraries are ranlib'd before installation. 362