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 $ 3# $DragonFly: src/share/mk/bsd.README,v 1.8 2008/03/02 19:56:53 swildner Exp $ 4 5This is the README file for the "include" files for the DragonFly 6source tree. The files are installed in /usr/share/mk, and are, by 7convention, named with the suffix ".mk". These files store several 8build options and should be handled with caution. 9 10Note, this file is not intended to replace reading through the .mk 11files for anything tricky. 12 13There are two main types of make include files. One type is the generally 14usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is 15the internal make include files, such as bsd.files.mk and bsd.man.mk, which 16can not/should not be used directly but are used by the other make include 17files. In most cases it is only interesting to include bsd.prog.mk or 18bsd.lib.mk. 19 20bsd.cpu.gcc41.mk - handle GCC 4.1 specific CPU flags & variables 21bsd.cpu.mk - handle CPU flags & variables 22bsd.dep.mk - handle Makefile dependencies 23bsd.doc.mk - building troff system documents 24bsd.files.mk - install of general purpose files 25bsd.hostlib.mk - 26bsd.hostprog.mk - 27bsd.incs.mk - install of include files 28bsd.info.mk - building GNU Info hypertext system 29bsd.init.mk - initialization for the make include files 30bsd.kmod.mk - building loadable kernel modules 31bsd.lib.mk - support for building libraries 32bsd.libnames.mk - define library names 33bsd.links.mk - install of links (sym/hard) 34bsd.man.mk - install of manual pages and their links 35bsd.nls.mk - build and install of NLS catalogs 36bsd.obj.mk - creating 'obj' directories and cleaning up 37bsd.own.mk - define common variables 38bsd.patch.mk - 39bsd.prog.mk - building programs from source files 40bsd.subdir.mk - targets for building subdirectories 41bsd.sys.mk - common settings used for building FreeBSD sources 42sys.mk - default rules for all makes 43 44 45See also make(1), mkdep(1) and `PMake - A Tutorial', 46located in /usr/src/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 DragonFly 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 knob. 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 and any object files. 195 cleandir: 196 remove all of the files removed by the target clean, as 197 well as .depend, tags, and any manual pages. 198 depend: 199 make the dependencies for the source files, and store 200 them in the file .depend. 201 install: 202 install the program and its manual pages; if the Makefile 203 does not itself define the target install, the targets 204 beforeinstall and afterinstall may also be used to cause 205 actions immediately before and after the install target 206 is executed. 207 lint: 208 run lint on the source files 209 tags: 210 create a tags file for the source files. 211 212It sets/uses the following variables: 213 214BINGRP Binary group. 215 216BINOWN Binary owner. 217 218BINMODE Binary mode. 219 220CLEANFILES Additional files to remove and 221CLEANDIRS additional directories to remove during clean and cleandir 222 targets. "rm -f" and "rm -rf" used respectively. 223 224COPTS Additional flags to the compiler when creating C objects. 225 226FILES A list of non-executable files. 227 The installation is controlled by the FILESNAME, FILESOWN, 228 FILESGRP, FILESMODE, FILESDIR variables that can be 229 further specialized by <VAR>_<file>. 230 231HIDEGAME If HIDEGAME is defined, the binary is installed in 232 /usr/games/hide, and a symbolic link is created to 233 /usr/games/dm. 234 235LDADD Additional loader objects. Usually used for libraries. 236 For example, to load with the compatibility and utility 237 libraries, use: 238 239 LDFILES=-lutil -lcompat 240 241LDFLAGS Additional loader flags. 242 243LINKS The list of binary links; should be full pathnames, the 244 linked-to file coming first, followed by the linked 245 file. The files are hard-linked. For example, to link 246 /bin/test and /bin/[, use: 247 248 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 249 250MAN Manual pages (should end in .1 - .9). If no MAN variable 251 is defined, "MAN=${PROG}.1" is assumed. 252 253PROG The name of the program to build. If not supplied, nothing 254 is built. 255 256PROG_CXX If defined, the name of the program to build. Also 257 causes <bsd.prog.mk> to link the program with the 258 standard C++ library. PROG_CXX overrides the value 259 of PROG if PROG is also set. 260 261PROGNAME The name that the above program will be installed as, if 262 different from ${PROG}. 263 264SRCS List of source files to build the program. If SRCS is not 265 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 266 defined, ${PROG_CXX}.cc. 267 268DPADD Additional dependencies for the program. Usually used for 269 libraries. For example, to depend on the compatibility and 270 utility libraries use: 271 272 SRCLIB=${LIBCOMPAT} ${LIBUTIL} 273 274 There is a predefined identifier for each (non-profiled, 275 non-shared) library and object. Library file names are 276 transformed to identifiers by removing the extension and 277 converting to upper case. 278 279 There are no special identifiers for profiled or shared 280 libraries or objects. The identifiers for the standard 281 libraries are used in DPADD. This works correctly iff all 282 the libraries are built at the same time. Unfortunately, 283 it causes unnecessary relinks to shared libraries when 284 only the static libraries have changed. Dependencies on 285 shared libraries should be only on the library version 286 numbers. 287 288STRIP The flag passed to the install program to cause the binary 289 to be stripped. This is to be used when building your 290 own install script so that the entire system can be made 291 stripped/not-stripped using a single knob. 292 293SUBDIR A list of subdirectories that should be built as well. 294 Each of the targets will execute the same target in the 295 subdirectories. 296 297SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 298 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 299 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 300 further specialized by SCRIPTS<VAR>_<script>. 301 302The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 303if it exists, as well as the include file <bsd.man.mk>. 304 305Some simple examples: 306 307To build foo from foo.c with a manual page foo.1, use: 308 309 PROG= foo 310 311 .include <bsd.prog.mk> 312 313To build foo from foo.c with a manual page foo.2, add the line: 314 315 MAN= foo.2 316 317If foo does not have a manual page at all, add the line: 318 319 NOMAN= noman 320 321If foo has multiple source files, add the line: 322 323 SRCS= a.c b.c c.c d.c 324 325=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 326 327The include file <bsd.subdir.mk> contains the default targets for building 328subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 329cleandir, depend, install, lint, and tags. For all of the directories 330listed in the variable SUBDIRS, the specified directory will be visited 331and the target made. There is also a default target which allows the 332command "make subdir" where subdir is any directory listed in the variable 333SUBDIRS. 334 335=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 336 337The include file <bsd.lib.mk> has support for building libraries. It has 338the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 339install, lint, and tags. It has a limited number of suffixes, consistent 340with the current needs of the BSD tree. 341 342It sets/uses the following variables: 343 344LIBDIR Target directory for libraries. 345 346LINTLIBDIR Target directory for lint libraries. 347 348LIBGRP Library group. 349 350LIBOWN Library owner. 351 352LIBMODE Library mode. 353 354LDADD Additional loader objects. 355 356MAN The manual pages to be installed (use a .1 - .9 suffix). 357 358SRCS List of source files to build the library. Suffix types 359 .s, .c, and .f are supported. Note, .s files are preferred 360 to .c files of the same name. (This is not the default for 361 versions of make.) 362 363The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 364if it exists, as well as the include file <bsd.man.mk>. 365 366It has rules for building profiled objects; profiled libraries are 367built by default. 368 369Libraries are ranlib'd before installation. 370