bsd.README revision 1.24
1# $NetBSD: bsd.README,v 1.24 1997/03/29 08:02:47 mikel Exp $ 2# @(#)bsd.README 8.2 (Berkeley) 4/2/94 3 4This is the README file for the new make "include" files for the BSD 5source tree. The files are installed in /usr/share/mk, and are, by 6convention, named with the suffix ".mk". 7 8Note, this file is not intended to replace reading through the .mk 9files for anything tricky. 10 11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 12 13RANDOM THINGS WORTH KNOWING: 14 15The files are simply C-style #include files, and pretty much behave like 16you'd expect. The syntax is slightly different in that a single '.' is 17used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 18 19One difference that will save you lots of debugging time is that inclusion 20of the file is normally done at the *end* of the Makefile. The reason for 21this is because .mk files often modify variables and behavior based on the 22values of variables set in the Makefile. To make this work, remember that 23the FIRST target found is the target that is used, i.e. if the Makefile has: 24 25 a: 26 echo a 27 a: 28 echo a number two 29 30the command "make a" will echo "a". To make things confusing, the SECOND 31variable assignment is the overriding one, i.e. if the Makefile has: 32 33 a= foo 34 a= bar 35 36 b: 37 echo ${a} 38 39the command "make b" will echo "bar". This is for compatibility with the 40way the V7 make behaved. 41 42It's fairly difficult to make the BSD .mk files work when you're building 43multiple programs in a single directory. It's a lot easier split up the 44programs than to deal with the problem. Most of the agony comes from making 45the "obj" directory stuff work right, not because we switch to a new version 46of make. So, don't get mad at us, figure out a better way to handle multiple 47architectures so we can quit using the symbolic link stuff. (Imake doesn't 48count.) 49 50The file .depend in the source directory is expected to contain dependencies 51for the source files. This file is read automatically by make after reading 52the Makefile. 53 54The variable DESTDIR works as before. It's not set anywhere but will change 55the tree where the file gets installed. 56 57The profiled libraries are no longer built in a different directory than 58the regular libraries. A new suffix, ".po", is used to denote a profiled 59object, and ".so" denotes a shared (position-independent) object. 60 61There are two variables that control how things are made/installed that 62are not set by default: 63 64BUILD If set 'make install' checks that the targets in the source 65 directories are up-to-date and remakes them if they 66 are out of date, instead of blindly trying to install 67 out of date or non-existant targets. 68 69UPDATE 'make install' only installs targets that are more recently 70 modified in the source directories that their installed 71 counterparts. 72 73=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 74 75The include file <sys.mk> has the default rules for all makes, in the BSD 76environment or otherwise. You probably don't want to touch this file. 77 78=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 79 80The include file <bsd.man.mk> handles installing manual pages and their 81links. 82 83It has a two targets: 84 85 maninstall: 86 Install the manual page sources and their links. 87 catinstall: 88 Install the preformatted manual pages and their links. 89 90It sets/uses the following variables: 91 92MANDIR Base path for manual installation. 93 94MANGRP Manual group. 95 96MANOWN Manual owner. 97 98MANMODE Manual mode. 99 100MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 101 or "/tahoe" for machine specific manual pages. 102 103MAN The manual pages to be installed (use a .1 - .9 suffix). 104 105MLINKS List of manual page links (using a .1 - .9 suffix). The 106 linked-to file must come first, the linked file second, 107 and there may be multiple pairs. The files are soft-linked. 108 109The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 110it exists. 111 112=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 113 114The include file <bsd.own.mk> contains source tree configuration parameters, 115such as the owners, groups, etc. for both manual pages and binaries, and 116a few global "feature configuration" parameters. 117 118It has no targets. 119 120To get system-specific configuration parameters, bsd.own.mk will try to 121include the file specified by the "MAKECONF" variable. If MAKECONF is not 122set, or no such file exists, the system make configuration file, /etc/mk.conf 123is included. These files may define any of the variables described below. 124 125bsd.own.mk sets the following variables, if they are not already defined 126(defaults are in brackets): 127 128 129 130BSDSRCDIR The real path to the system sources, so that 'make obj' 131 will work correctly. [/usr/src] 132 133BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj' 134 will work correctly. [/usr/obj] 135 136BINGRP Binary group. [bin] 137 138BINOWN Binary owner. [bin] 139 140BINMODE Binary mode. [555] 141 142NONBINMODE Mode for non-executable files. [444] 143 144MANDIR Base path for manual installation. [/usr/share/man/cat] 145 146MANGRP Manual group. [bin] 147 148MANOWN Manual owner. [bin] 149 150MANMODE Manual mode. [${NONBINMODE}] 151 152MANINSTALL Manual installation type: maninstall, catinstall, or both 153 154LIBDIR Base path for library installation. [/usr/lib] 155 156LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint] 157 158LIBGRP Library group. [${BINGRP}] 159 160LIBOWN Library owner. [${BINOWN}] 161 162LIBMODE Library mode. [${NONBINMODE}] 163 164DOCDIR Base path for system documentation (e.g. PSD, USD, etc.) 165 installation. [/usr/share/doc] 166 167DOCGRP Documentation group. [bin] 168 169DOCOWN Documentation owner. [bin] 170 171DOCMODE Documentation mode. [${NONBINMODE}] 172 173NLSDIR Base path for National Language Support files installation. 174 [/usr/share/nls] 175 176NLSGRP National Language Support files group. [bin] 177 178NLSOWN National Language Support files owner. [bin] 179 180NLSMODE National Language Support files mode. [${NONBINMODE}] 181 182STRIP The flag passed to the install program to cause the binary 183 to be stripped. This is to be used when building your 184 own install script so that the entire system can be made 185 stripped/not-stripped using a single knob. [-s] 186 187COPY The flag passed to the install program to cause the binary 188 to be copied rather than moved. This is to be used when 189 building our own install script so that the entire system 190 can either be installed with copies, or with moves using 191 a single knob. [-c] 192 193Additionally, the following variables may be set by bsd.own.mk or in a 194make configuration file to modify the behaviour of the system build 195process (default values are in brackets along with comments, if set by 196bsd.own.mk): 197 198EXPORTABLE_SYSTEM 199 Do not build /usr/src/domestic, even if it is present. 200 201SKEY Compile in support for S/key authentication. [yes, set 202 unconditionally] 203 204KERBEROS Compile in support for Kerberos 4 authentication. 205 206KERBEROS5 Compile in support for Kerberos 5 authentication. 207 208MANZ Compress manual pages at installation time. 209 210SYS_INCLUDE Copy or symlink kernel include files into /usr/include. 211 Possible values are "symlinks" or "copies" (which is 212 the same as the variable being unset). 213 214NOPROFILE Do not build profiled versions of system libraries 215 216NOPIC Do not build PIC versions of system libraries, and 217 do not build shared libraries. [set if ${MACHINE_ARCH} 218 is "mips", "vax", "alpha" or "arm32", unset otherwise.] 219 220NOLINT Do not build lint libraries. [set, set unconditionally] 221 222bsd.own.mk is generally useful when building your own Makefiles so that 223they use the same default owners etc. as the rest of the tree. 224 225=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 226 227The include file <bsd.prog.mk> handles building programs from one or 228more source files, along with their manual pages. It has a limited number 229of suffixes, consistent with the current needs of the BSD tree. 230 231It has eight targets: 232 233 all: 234 build the program and its manual page 235 clean: 236 remove the program, any object files and the files a.out, 237 Errs, errs, mklog, and ${PROG}.core. 238 cleandir: 239 remove all of the files removed by the target clean, as 240 well as .depend, tags, and any manual pages. 241 depend: 242 make the dependencies for the source files, and store 243 them in the file .depend. 244 includes: 245 install any header files. 246 install: 247 install the program and its manual pages; if the Makefile 248 does not itself define the target install, the targets 249 beforeinstall and afterinstall may also be used to cause 250 actions immediately before and after the install target 251 is executed. 252 lint: 253 run lint on the source files 254 tags: 255 create a tags file for the source files. 256 257It sets/uses the following variables: 258 259BINGRP Binary group. 260 261BINOWN Binary owner. 262 263BINMODE Binary mode. 264 265CLEANFILES Additional files to remove for the clean and cleandir targets. 266 267COPTS Additional flags to the compiler when creating C objects. 268 269LDADD Additional loader objects. Usually used for libraries. 270 For example, to load with the compatibility and utility 271 libraries, use: 272 273 LDADD+=-lutil -lcompat 274 275LDFLAGS Additional loader flags. 276 277LINKS The list of binary links; should be full pathnames, the 278 linked-to file coming first, followed by the linked 279 file. The files are hard-linked. For example, to link 280 /bin/test and /bin/[, use: 281 282 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 283 284SYMLINKS The list of symbolic links; should be full pathnames. 285 Syntax is identical to LINKS. Note that DESTDIR is not 286 automatically included in the link. 287 288MAN Manual pages (should end in .1 - .9). If no MAN variable is 289 defined, "MAN=${PROG}.1" is assumed. 290 291PROG The name of the program to build. If not supplied, nothing 292 is built. 293 294PROGNAME The name that the above program will be installed as, if 295 different from ${PROG}. 296 297SRCS List of source files to build the program. If PROG is not 298 defined, it's assumed to be ${PROG}.c. 299 300DPADD Additional dependencies for the program. Usually used for 301 libraries. For example, to depend on the compatibility and 302 utility libraries use: 303 304 DPADD+=${LIBCOMPAT} ${LIBUTIL} 305 306 The following libraries are predefined for DPADD: 307 308 LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o 309 LIBC?= ${DESTDIR}/usr/lib/libc.a 310 LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a 311 LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a 312 LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a 313 LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a 314 LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a 315 LIBDES?= ${DESTDIR}/usr/lib/libdes.a 316 LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a 317 LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a 318 LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a 319 LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a 320 LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a 321 LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a 322 LIBL?= ${DESTDIR}/usr/lib/libl.a 323 LIBM?= ${DESTDIR}/usr/lib/libm.a 324 LIBMP?= ${DESTDIR}/usr/lib/libmp.a 325 LIBPC?= ${DESTDIR}/usr/lib/libpc.a 326 LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a 327 LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a 328 LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a 329 LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a 330 LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a 331 LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a 332 LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a 333 LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a 334 LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a 335 LIBY?= ${DESTDIR}/usr/lib/liby.a 336 LIBZ?= ${DESTDIR}/usr/lib/libz.a 337 338 339SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared 340 strings, using xstr(1). Note that this will not work with 341 parallel makes. 342 343STRIP The flag passed to the install program to cause the binary 344 to be stripped. 345 346SUBDIR A list of subdirectories that should be built as well. 347 Each of the targets will execute the same target in the 348 subdirectories. 349 350SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 351 These are installed exactly like programs. 352 353SCRIPTSNAME The name that the above program will be installed as, if 354 different from ${SCRIPTS}. These can be further specialized 355 by setting SCRIPTSNAME_<script>. 356 357FILES A list of files to install. The installation is controlled 358 by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR 359 variables that can be further specialized by FILES<VAR>_<file> 360 361The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 362if it exists, as well as the include file <bsd.man.mk>. 363 364Some simple examples: 365 366To build foo from foo.c with a manual page foo.1, use: 367 368 PROG= foo 369 370 .include <bsd.prog.mk> 371 372To build foo from foo.c with a manual page foo.2, add the line: 373 374 MAN= foo.2 375 376If foo does not have a manual page at all, add the line: 377 378 NOMAN= noman 379 380If foo has multiple source files, add the line: 381 382 SRCS= a.c b.c c.c d.c 383 384=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 385 386The include file <bsd.subdir.mk> contains the default targets for building 387subdirectories. It has the same eight targets as <bsd.prog.mk>: all, 388clean, cleandir, depend, includes, install, lint, and tags. For all of 389the directories listed in the variable SUBDIRS, the specified directory 390will be visited and the target made. There is also a default target which 391allows the command "make subdir" where subdir is any directory listed in 392the variable SUBDIRS. 393 394=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 395 396The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables 397and is included from from bsd.lib.mk and bsd.prog.mk. 398 399=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 400 401The include file <bsd.files.mk> handles the FILES variables and is included 402from bsd.lib.mk and bsd.prog.mk. 403 404=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 405 406The include file <bsd.inc.mk> defines the includes target and uses two 407variables: 408 409INCS The list of include files 410 411INCSDIR The location to install the include files. 412 413=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 414 415The include file <bsd.sys.mk> is used by <bsd.prog.mk> and 416<bsd.lib.mk>. It contains overrides that are used when building 417the NetBSD source tree. For instance, if "PARALLEL" is defined by 418the program/library Makefile, it includes a set of rules for lex and 419yacc that allow multiple lex and yacc targets to be built in parallel. 420 421=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 422 423The include file <bsd.lib.mk> has support for building libraries. It has 424the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend, 425includes, install, lint, and tags. It has a limited number of suffixes, 426consistent with the current needs of the BSD tree. 427 428It sets/uses the following variables: 429 430LIB The name of the library to build. 431 432LIBDIR Target directory for libraries. 433 434LINTLIBDIR Target directory for lint libraries. 435 436LIBGRP Library group. 437 438LIBOWN Library owner. 439 440LIBMODE Library mode. 441 442LDADD Additional loader objects. 443 444MAN The manual pages to be installed (use a .1 - .9 suffix). 445 446SRCS List of source files to build the library. Suffix types 447 .s, .c, and .f are supported. Note, .s files are preferred 448 to .c files of the same name. (This is not the default for 449 versions of make.) 450 451The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 452if it exists, as well as the include file <bsd.man.mk>. 453 454It has rules for building profiled objects; profiled libraries are 455built by default. 456 457Libraries are ranlib'd when made. 458