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 167STRIP The flag passed to the install program to cause the binary 168 to be stripped. This is to be used when building your 169 own install script so that the entire system can be made 170 stripped/not-stripped using a single nob. 171 172MANDIR Base path for manual installation. 173 174MANGRP Manual group. 175 176MANOWN Manual owner. 177 178MANMODE Manual mode. 179 180This file is generally useful when building your own Makefiles so that 181they use the same default owners etc. as the rest of the tree. 182 183=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 184 185The include file <bsd.prog.mk> handles building programs from one or 186more source files, along with their manual pages. It has a limited number 187of suffixes, consistent with the current needs of the BSD tree. 188 189It has seven targets: 190 191 all: 192 build the program and its manual page 193 clean: 194 remove the program, any object files and the files a.out, 195 Errs, errs, mklog, and ${PROG}.core. 196 cleandir: 197 remove all of the files removed by the target clean, as 198 well as .depend, tags, and any manual pages. 199 depend: 200 make the dependencies for the source files, and store 201 them in the file .depend. 202 install: 203 install the program and its manual pages; if the Makefile 204 does not itself define the target install, the targets 205 beforeinstall and afterinstall may also be used to cause 206 actions immediately before and after the install target 207 is executed. 208 lint: 209 run lint on the source files 210 tags: 211 create a tags file for the source files. 212 213It sets/uses the following variables: 214 215BINGRP Binary group. 216 217BINOWN Binary owner. 218 219BINMODE Binary mode. 220 221CLEANFILES Additional files to remove and 222CLEANDIRS additional directories to remove during clean and cleandir 223 targets. "rm -f" and "rm -rf" used respectively. 224 225COPTS Additional flags to the compiler when creating C objects. 226 227FILES A list of non-executable files. 228 The installation is controlled by the FILESNAME, FILESOWN, 229 FILESGRP, FILESMODE, FILESDIR variables that can be 230 further specialized by FILES<VAR>_<file>. 231 232LDADD Additional loader objects. Usually used for libraries. 233 For example, to load with the compatibility and utility 234 libraries, use: 235 236 LDFILES=-lutil -lcompat 237 238LDFLAGS Additional loader flags. 239 240LINKS The list of binary links; should be full pathnames, the 241 linked-to file coming first, followed by the linked 242 file. The files are hard-linked. For example, to link 243 /bin/test and /bin/[, use: 244 245 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 246 247MAN Manual pages (should end in .1 - .9). If no MAN variable 248 is defined, "MAN=${PROG}.1" is assumed. 249 250PROG The name of the program to build. If not supplied, nothing 251 is built. 252 253PROG_CXX If defined, the name of the program to build. Also 254 causes <bsd.prog.mk> to link the program with the 255 standard C++ library. PROG_CXX overrides the value 256 of PROG if PROG is also set. 257 258PROGNAME The name that the above program will be installed as, if 259 different from ${PROG}. 260 261SRCS List of source files to build the program. If SRCS is not 262 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 263 defined, ${PROG_CXX}.cc. 264 265DPADD Additional dependencies for the program. Usually used for 266 libraries. For example, to depend on the compatibility and 267 utility libraries use: 268 269 SRCLIB=${LIBCOMPAT} ${LIBUTIL} 270 271 There is a predefined identifier for each (non-profiled, 272 non-shared) library and object. Library file names are 273 transformed to identifiers by removing the extension and 274 converting to upper case. 275 276 There are no special identifiers for profiled or shared 277 libraries or objects. The identifiers for the standard 278 libraries are used in DPADD. This works correctly iff all 279 the libraries are built at the same time. Unfortunately, 280 it causes unnecessary relinks to shared libraries when 281 only the static libraries have changed. Dependencies on 282 shared libraries should be only on the library version 283 numbers. 284 285STRIP The flag passed to the install program to cause the binary 286 to be stripped. 287 288SUBDIR A list of subdirectories that should be built as well. 289 Each of the targets will execute the same target in the 290 subdirectories. 291 292SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 293 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 294 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 295 further specialized by SCRIPTS<VAR>_<script>. 296 297The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 298if it exists, as well as the include file <bsd.man.mk>. 299 300Some simple examples: 301 302To build foo from foo.c with a manual page foo.1, use: 303 304 PROG= foo 305 306 .include <bsd.prog.mk> 307 308To build foo from foo.c with a manual page foo.2, add the line: 309 310 MAN2= foo.2 311 312If foo does not have a manual page at all, add the line: 313 314 NOMAN= noman 315 316If foo has multiple source files, add the line: 317 318 SRCS= a.c b.c c.c d.c 319 320=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 321 322The include file <bsd.subdir.mk> contains the default targets for building 323subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 324cleandir, depend, install, lint, and tags. For all of the directories 325listed in the variable SUBDIRS, the specified directory will be visited 326and the target made. There is also a default target which allows the 327command "make subdir" where subdir is any directory listed in the variable 328SUBDIRS. 329 330=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 331 332The include file <bsd.lib.mk> has support for building libraries. It has 333the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 334install, lint, and tags. It has a limited number of suffixes, consistent 335with the current needs of the BSD tree. 336 337It sets/uses the following variables: 338 339LIBDIR Target directory for libraries. 340 341LINTLIBDIR Target directory for lint libraries. 342 343LIBGRP Library group. 344 345LIBOWN Library owner. 346 347LIBMODE Library mode. 348 349LDADD Additional loader objects. 350 351MAN The manual pages to be installed (use a .1 - .9 suffix). 352 353SRCS List of source files to build the library. Suffix types 354 .s, .c, and .f are supported. Note, .s files are preferred 355 to .c files of the same name. (This is not the default for 356 versions of make.) 357 358The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 359if it exists, as well as the include file <bsd.man.mk>. 360 361It has rules for building profiled objects; profiled libraries are 362built by default. 363 364Libraries are ranlib'd before installation. 365