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.gcc34.mk - handle GCC 3.4 specific CPU flags & variables 21bsd.cpu.gcc41.mk - handle GCC 4.1 specific CPU flags & variables 22bsd.cpu.mk - handle CPU flags & variables 23bsd.dep.mk - handle Makefile dependencies 24bsd.doc.mk - building troff system documents 25bsd.files.mk - install of general purpose files 26bsd.hostlib.mk - 27bsd.hostprog.mk - 28bsd.incs.mk - install of include files 29bsd.info.mk - building GNU Info hypertext system 30bsd.init.mk - initialization for the make include files 31bsd.kmod.mk - building loadable kernel modules 32bsd.lib.mk - support for building libraries 33bsd.libnames.mk - define library names 34bsd.links.mk - install of links (sym/hard) 35bsd.man.mk - install of manual pages and their links 36bsd.nls.mk - build and install of NLS catalogs 37bsd.obj.mk - creating 'obj' directories and cleaning up 38bsd.own.mk - define common variables 39bsd.patch.mk - 40bsd.prog.mk - building programs from source files 41bsd.subdir.mk - targets for building subdirectories 42bsd.sys.mk - common settings used for building FreeBSD sources 43sys.mk - default rules for all makes 44 45 46See also make(1), mkdep(1) and `PMake - A Tutorial', 47located in /usr/src/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 DragonFly 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 split up the 95programs than to deal with the problem. Most of the agony comes from making 96the "obj" directory stuff work right, not because we switch to a new version 97of make. So, don't get mad at us, figure out a better way to handle multiple 98architectures so we can quit using the symbolic link stuff. (Imake doesn't 99count.) 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 168STRIP The flag passed to the install program to cause the binary 169 to be stripped. This is to be used when building your 170 own install script so that the entire system can be made 171 stripped/not-stripped using a single knob. 172 173MANDIR Base path for manual installation. 174 175MANGRP Manual group. 176 177MANOWN Manual owner. 178 179MANMODE Manual mode. 180 181This file is generally useful when building your own Makefiles so that 182they use the same default owners etc. as the rest of the tree. 183 184=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 185 186The include file <bsd.prog.mk> handles building programs from one or 187more source files, along with their manual pages. It has a limited number 188of suffixes, consistent with the current needs of the BSD tree. 189 190It has seven targets: 191 192 all: 193 build the program and its manual page 194 clean: 195 remove the program and any object files. 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 <VAR>_<file>. 231 232HIDEGAME If HIDEGAME is defined, the binary is installed in 233 /usr/games/hide, and a symbolic link is created to 234 /usr/games/dm. 235 236LDADD Additional loader objects. Usually used for libraries. 237 For example, to load with the compatibility and utility 238 libraries, use: 239 240 LDFILES=-lutil -lcompat 241 242LDFLAGS Additional loader flags. 243 244LINKS The list of binary links; should be full pathnames, the 245 linked-to file coming first, followed by the linked 246 file. The files are hard-linked. For example, to link 247 /bin/test and /bin/[, use: 248 249 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 250 251MAN Manual pages (should end in .1 - .9). If no MAN variable 252 is defined, "MAN=${PROG}.1" is assumed. 253 254PROG The name of the program to build. If not supplied, nothing 255 is built. 256 257PROG_CXX If defined, the name of the program to build. Also 258 causes <bsd.prog.mk> to link the program with the 259 standard C++ library. PROG_CXX overrides the value 260 of PROG if PROG is also set. 261 262PROGNAME The name that the above program will be installed as, if 263 different from ${PROG}. 264 265SRCS List of source files to build the program. If SRCS is not 266 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 267 defined, ${PROG_CXX}.cc. 268 269DPADD Additional dependencies for the program. Usually used for 270 libraries. For example, to depend on the compatibility and 271 utility libraries use: 272 273 SRCLIB=${LIBCOMPAT} ${LIBUTIL} 274 275 There is a predefined identifier for each (non-profiled, 276 non-shared) library and object. Library file names are 277 transformed to identifiers by removing the extension and 278 converting to upper case. 279 280 There are no special identifiers for profiled or shared 281 libraries or objects. The identifiers for the standard 282 libraries are used in DPADD. This works correctly iff all 283 the libraries are built at the same time. Unfortunately, 284 it causes unnecessary relinks to shared libraries when 285 only the static libraries have changed. Dependencies on 286 shared libraries should be only on the library version 287 numbers. 288 289STRIP The flag passed to the install program to cause the binary 290 to be stripped. This is to be used when building your 291 own install script so that the entire system can be made 292 stripped/not-stripped using a single knob. 293 294SUBDIR A list of subdirectories that should be built as well. 295 Each of the targets will execute the same target in the 296 subdirectories. 297 298SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 299 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 300 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 301 further specialized by SCRIPTS<VAR>_<script>. 302 303The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 304if it exists, as well as the include file <bsd.man.mk>. 305 306Some simple examples: 307 308To build foo from foo.c with a manual page foo.1, use: 309 310 PROG= foo 311 312 .include <bsd.prog.mk> 313 314To build foo from foo.c with a manual page foo.2, add the line: 315 316 MAN= foo.2 317 318If foo does not have a manual page at all, add the line: 319 320 NOMAN= noman 321 322If foo has multiple source files, add the line: 323 324 SRCS= a.c b.c c.c d.c 325 326=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 327 328The include file <bsd.subdir.mk> contains the default targets for building 329subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 330cleandir, depend, install, lint, and tags. For all of the directories 331listed in the variable SUBDIRS, the specified directory will be visited 332and the target made. There is also a default target which allows the 333command "make subdir" where subdir is any directory listed in the variable 334SUBDIRS. 335 336=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 337 338The include file <bsd.lib.mk> has support for building libraries. It has 339the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 340install, lint, and tags. It has a limited number of suffixes, consistent 341with the current needs of the BSD tree. 342 343It sets/uses the following variables: 344 345LIBDIR Target directory for libraries. 346 347LINTLIBDIR Target directory for lint libraries. 348 349LIBGRP Library group. 350 351LIBOWN Library owner. 352 353LIBMODE Library mode. 354 355LDADD Additional loader objects. 356 357MAN The manual pages to be installed (use a .1 - .9 suffix). 358 359SRCS List of source files to build the library. Suffix types 360 .s, .c, and .f are supported. Note, .s files are preferred 361 to .c files of the same name. (This is not the default for 362 versions of make.) 363 364The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 365if it exists, as well as the include file <bsd.man.mk>. 366 367It has rules for building profiled objects; profiled libraries are 368built by default. 369 370Libraries are ranlib'd before installation. 371