1# @(#)bsd.README 8.2 (Berkeley) 4/2/94 2# $FreeBSD$ 3 4XXX This document is seriously out of date, it is currenly being revised. 5 6This is the README file for the new make "include" files for the BSD 7source tree. The files are installed in /usr/share/mk, and are, by 8convention, named with the suffix ".mk". 9 10bsd.dep.mk - handle Makefile dependencies 11bsd.doc.mk - building troff system documents 12bsd.info.mk - building GNU Info hypertext system 13bsd.kern.mk - define warning flags for compiling the kernel 14bsd.kmod.mk - building loadable kernel modules 15bsd.lib.mk - support for building libraries 16bsd.libnames.mk - define library names 17bsd.man.mk - installing manual pages and their links 18bsd.obj.mk - creating 'obj' directories and cleaning up 19bsd.own.mk - define common variables 20bsd.port.mk - building ports 21bsd.port.subdir.mk - targets for building subdirectories for ports 22bsd.prog.mk - building programs from source files 23bsd.sgml.mk - building SGML documents 24bsd.subdir.mk - targets for building subdirectories 25 26 27Note, this file is not intended to replace reading through the .mk 28files for anything tricky. 29 30See also make(1), mkdep(1) and `PMake - A Tutorial', 31located in /usr/share/doc/psd/12.make. 32 33=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 34 35RANDOM THINGS WORTH KNOWING: 36 37The files are simply C-style #include files, and pretty much behave like 38you'd expect. The syntax is slightly different in that a single '.' is 39used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 40 41One difference that will save you lots of debugging time is that inclusion 42of the file is normally done at the *end* of the Makefile. The reason for 43this is because .mk files often modify variables and behavior based on the 44values of variables set in the Makefile. To make this work, remember that 45the FIRST target found is the target that is used, i.e. if the Makefile has: 46 47 a: 48 echo a 49 a: 50 echo a number two 51 52the command "make a" will echo "a". To make things confusing, the SECOND 53variable assignment is the overriding one, i.e. if the Makefile has: 54 55 a= foo 56 a= bar 57 58 b: 59 echo ${a} 60 61the command "make b" will echo "bar". This is for compatibility with the 62way the V7 make behaved. 63 64It's fairly difficult to make the BSD .mk files work when you're building 65multiple programs in a single directory. It's a lot easier split up the 66programs than to deal with the problem. Most of the agony comes from making 67the "obj" directory stuff work right, not because we switch to a new version 68of make. So, don't get mad at us, figure out a better way to handle multiple 69architectures so we can quit using the symbolic link stuff. (Imake doesn't 70count.) 71 72The file .depend in the source directory is expected to contain dependencies 73for the source files. This file is read automatically by make after reading 74the Makefile. 75 76The variable DESTDIR works as before. It's not set anywhere but will change 77the tree where the file gets installed. 78 79The profiled libraries are no longer built in a different directory than 80the regular libraries. A new suffix, ".po", is used to denote a profiled 81object. 82 83=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 84 85The include file <sys.mk> has the default rules for all makes, in the BSD 86environment or otherwise. You probably don't want to touch this file. 87 88=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 89 90The include file <bsd.man.mk> handles installing manual pages and their 91links. 92 93It has a single target: 94 95 maninstall: 96 Install the manual pages and their links. 97 98It sets/uses the following variables: 99 100MANDIR Base path for manual installation. 101 102MANGRP Manual group. 103 104MANOWN Manual owner. 105 106MANMODE Manual mode. 107 108MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 109 or "/tahoe" for machine specific manual pages. 110 111MAN1 ... MAN8 The manual pages to be installed (use a .0 suffix). 112 113MLINKS List of manual page links (using a .1 - .8 suffix). The 114 linked-to file must come first, the linked file second, 115 and there may be multiple pairs. The files are soft-linked. 116 117The include file <bsd.man.mk> includes the include file <bsd.inc.mk>. 118 119=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 120 121The include file <bsd.own.mk> contains the owners, groups, etc. for both 122manual pages and binaries. 123 124It has no targets. 125 126It sets/uses the following variables: 127 128BINGRP Binary group. 129 130BINOWN Binary owner. 131 132BINMODE Binary mode. 133 134STRIP The flag passed to the install program to cause the binary 135 to be stripped. This is to be used when building your 136 own install script so that the entire system can be made 137 stripped/not-stripped using a single nob. 138 139MANDIR Base path for manual installation. 140 141MANGRP Manual group. 142 143MANOWN Manual owner. 144 145MANMODE Manual mode. 146 147This file is generally useful when building your own Makefiles so that 148they use the same default owners etc. as the rest of the tree. 149 150=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 151 152The include file <bsd.prog.mk> handles building programs from one or 153more source files, along with their manual pages. It has a limited number 154of suffixes, consistent with the current needs of the BSD tree. 155 156It has seven targets: 157 158 all: 159 build the program and its manual page 160 clean: 161 remove the program, any object files and the files a.out, 162 Errs, errs, mklog, and ${PROG}.core. 163 cleandir: 164 remove all of the files removed by the target clean, as 165 well as .depend, tags, and any manual pages. 166 depend: 167 make the dependencies for the source files, and store 168 them in the file .depend. 169 install: 170 install the program and its manual pages; if the Makefile 171 does not itself define the target install, the targets 172 beforeinstall and afterinstall may also be used to cause 173 actions immediately before and after the install target 174 is executed. 175 lint: 176 run lint on the source files 177 tags: 178 create a tags file for the source files. 179 180It sets/uses the following variables: 181 182BINGRP Binary group. 183 184BINOWN Binary owner. 185 186BINMODE Binary mode. 187 188CLEANFILES Additional files to remove and 189CLEANDIRS additional directories to remove during clean and cleandir 190 targets. "rm -f" and "rm -rf" used respectively. 191 192COPTS Additional flags to the compiler when creating C objects. 193 194HIDEGAME If HIDEGAME is defined, the binary is installed in 195 /usr/games/hide, and a symbolic link is created to 196 /usr/games/dm. 197 198LDADD Additional loader objects. Usually used for libraries. 199 For example, to load with the compatibility and utility 200 libraries, use: 201 202 LDFILES=-lutil -lcompat 203 204LDFLAGS Additional loader flags. 205 206LINKS The list of binary links; should be full pathnames, the 207 linked-to file coming first, followed by the linked 208 file. The files are hard-linked. For example, to link 209 /bin/test and /bin/[, use: 210 211 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 212 213MAN1...MAN8 Manual pages (should end in .0). If no MAN variable is 214 defined, "MAN1=${PROG}.0" is assumed. 215 216PROG The name of the program to build. If not supplied, nothing 217 is built. 218 219SRCS List of source files to build the program. If PROG is not 220 defined, it's assumed to be ${PROG}.c. 221 222DPADD Additional dependencies for the program. Usually used for 223 libraries. For example, to depend on the compatibility and 224 utility libraries use: 225 226 SRCLIB=${LIBCOMPAT} ${LIBUTIL} 227 228 There is a predefined identifier for each (non-profiled, 229 non-shared) library and object. Library file names are 230 transformed to identifiers by removing the extension and 231 converting to upper case. 232 233 There are no special identifiers for profiled or shared 234 libraries or objects. The identifiers for the standard 235 libraries are used in DPADD. This works correctly iff all 236 the libraries are built at the same time. Unfortunately, 237 it causes unnecessary relinks to shared libraries when 238 only the static libraries have changed. Dependencies on 239 shared libraries should be only on the library version 240 numbers. 241 242STRIP The flag passed to the install program to cause the binary 243 to be stripped. 244 245SUBDIR A list of subdirectories that should be built as well. 246 Each of the targets will execute the same target in the 247 subdirectories. 248 249The include file <bsd.prog.mk> includes the include files <bsd.inc.mk> 250and <bsd.man.mk>. 251 252Some simple examples: 253 254To build foo from foo.c with a manual page foo.1, use: 255 256 PROG= foo 257 258 .include <bsd.prog.mk> 259 260To build foo from foo.c with a manual page foo.2, add the line: 261 262 MAN2= foo.0 263 264If foo does not have a manual page at all, add the line: 265 266 NOMAN= noman 267 268If foo has multiple source files, add the line: 269 270 SRCS= a.c b.c c.c d.c 271 272=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 273 274The include file <bsd.subdir.mk> contains the default targets for building 275subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 276cleandir, depend, install, lint, and tags. For all of the directories 277listed in the variable SUBDIRS, the specified directory will be visited 278and the target made. There is also a default target which allows the 279command "make subdir" where subdir is any directory listed in the variable 280SUBDIRS. 281 282=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 283 284The include file <bsd.lib.mk> has support for building libraries. It has 285the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 286install, lint, and tags. It has a limited number of suffixes, consistent 287with the current needs of the BSD tree. 288 289It sets/uses the following variables: 290 291LIBDIR Target directory for libraries. 292 293LINTLIBDIR Target directory for lint libraries. 294 295LIBGRP Library group. 296 297LIBOWN Library owner. 298 299LIBMODE Library mode. 300 301LDADD Additional loader objects. 302 303MAN1 ... MAN8 The manual pages to be installed (use a .0 suffix). 304 305SRCS List of source files to build the library. Suffix types 306 .s, .c, and .f are supported. Note, .s files are preferred 307 to .c files of the same name. (This is not the default for 308 versions of make.) 309 310The include file <bsd.lib.mk> includes the include files <bsd.inc.mk> 311and <bsd.man.mk>. 312 313It has rules for building profiled objects; profiled libraries are 314built by default. 315 316Libraries are ranlib'd before installation. 317