share/mk/bsd.README

   1 #       @(#)bsd.README  8.2 (Berkeley) 4/2/94
   2 # $FreeBSD$
   3
   4 This is the README file for the "include" files for the FreeBSD
   5 source tree.  The files are installed in /usr/share/mk, and are by
   6 convention, named with the suffix ".mk".  These files store several
   7 build options and should be handled with caution.
   8
   9 Note, this file is not intended to replace reading through the .mk
  10 files for anything tricky.
  11
  12 There are two main types of make include files.  One type is the generally
  13 usable make include files, such as bsd.prog.mk and bsd.lib.mk.  The other is
  14 the internal make include files, such as bsd.files.mk and bsd.man.mk, which
  15 can not/should not be used directly but are used by the other make include
  16 files.  In most cases it is only interesting to include bsd.prog.mk or
  17 bsd.lib.mk.
  18
  19 bsd.cpu.mk              - sets CPU/arch-related variables
  20 bsd.dep.mk              - handle Makefile dependencies
  21 bsd.doc.mk              - building troff system documents
  22 bsd.files.mk            - install of general purpose files
  23 bsd.incs.mk             - install of include files
  24 bsd.info.mk             - building GNU Info hypertext system (depreciated)
  25 bsd.init.mk             - initialization for the make include files
  26 bsd.kmod.mk             - building loadable kernel modules
  27 bsd.lib.mk              - support for building libraries
  28 bsd.libnames.mk         - define library names
  29 bsd.links.mk            - install of links (sym/hard)
  30 bsd.man.mk              - install of manual pages and their links
  31 bsd.nls.mk              - build and install of NLS catalogs
  32 bsd.obj.mk              - creating 'obj' directories and cleaning up
  33 bsd.own.mk              - define common variables
  34 bsd.port.mk             - building ports
  35 bsd.port.post.mk        - building ports
  36 bsd.port.pre.mk         - building ports
  37 bsd.port.subdir.mk      - targets for building subdirectories for ports
  38 bsd.prog.mk             - building programs from source files
  39 bsd.progs.mk            - build multiple programs from sources (depreciated)
  40 bsd.snmpmod.mk          - building modules for the SNMP daemon bsnmpd
  41 bsd.subdir.mk           - targets for building subdirectories
  42 bsd.sys.mk              - common settings used for building FreeBSD sources
  43 bsd.test.mk             - building test programs from source files
  44 sys.mk                  - default rules for all makes
  45
  46 This file does not document bsd.port*.mk.  They are documented in ports(7).
  47
  48 See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
  49 Tutorial', located in /usr/share/doc/psd/12.make.
  50
  51 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  52
  53 Random things worth knowing about this document:
  54
  55 If appropriate when documenting the variables the default value is
  56 indicated using square brackets e.g. [gzip].
  57 In some cases the default value depend on other values (e.g. system
  58 architecture).  In these cases the most common value is indicated.
  59
  60 This document contains some simple examples of the usage of the BSD make
  61 include files.  For more examples look at the makefiles in the FreeBSD
  62 source tree.
  63
  64 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  65
  66 RANDOM THINGS WORTH KNOWING:
  67
  68 The files are like C-style #include files, and pretty much behave like
  69 you'd expect.  The syntax is slightly different in that a single '.' is
  70 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
  71
  72 One difference that will save you lots of debugging time is that inclusion
  73 of the file is normally done at the *end* of the Makefile.  The reason for
  74 this is because .mk files often modify variables and behavior based on the
  75 values of variables set in the Makefile.  To make this work, remember that
  76 the FIRST target found is the target that is used, i.e. if the Makefile has:
  77
  78         a:
  79                 echo a
  80         a:
  81                 echo a number two
  82
  83 the command "make a" will echo "a".  To make things confusing, the SECOND
  84 variable assignment is the overriding one, i.e. if the Makefile has:
  85
  86         a=      foo
  87         a=      bar
  88
  89         b:
  90                 echo ${a}
  91
  92 the command "make b" will echo "bar".  This is for compatibility with the
  93 way the V7 make behaved.
  94
  95 It's fairly difficult to make the BSD .mk files work when you're building
  96 multiple programs in a single directory.  It's a lot easier to split up
  97 the programs than to deal with the problem.  Most of the agony comes from
  98 making the "obj" directory stuff work right, not because we switch to a new
  99 version of make.  So, don't get mad at us, figure out a better way to handle
 100 multiple architectures so we can quit using the symbolic link stuff.
 101 (Imake doesn't count.)
 102
 103 The file .depend in the source directory is expected to contain dependencies
 104 for the source files.  This file is read automatically by make after reading
 105 the Makefile.
 106
 107 The variable DESTDIR works as before.  It's not set anywhere but will change
 108 the tree where the file gets installed.
 109
 110 The profiled libraries are no longer built in a different directory than
 111 the regular libraries.  A new suffix, ".po", is used to denote a profiled
 112 object.
 113
 114 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 115
 116 The include file <sys.mk> has the default rules for all makes, in the BSD
 117 environment or otherwise.  You probably don't want to touch this file.
 118
 119 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 120
 121 The include file <bsd.man.mk> handles installing manual pages and their
 122 links.
 123
 124 It has three targets:
 125
 126         all-man:
 127                 build manual pages.
 128         maninstall:
 129                 install the manual pages and their links.
 130         manlint:
 131                 verify the validity of manual pages.
 132
 133 It sets/uses the following variables:
 134
 135 MANDIR          Base path for manual installation.
 136
 137 MANGRP          Manual group.
 138
 139 MANOWN          Manual owner.
 140
 141 MANMODE         Manual mode.
 142
 143 MANSUBDIR       Subdirectory under the manual page section, i.e. "/vax"
 144                 or "/tahoe" for machine specific manual pages.
 145
 146 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 147
 148 MLINKS          List of manual page links (using a .1 - .9 suffix).  The
 149                 linked-to file must come first, the linked file second,
 150                 and there may be multiple pairs.  The files are hard-linked.
 151
 152 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
 153 it exists.
 154
 155 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 156
 157 The include file <bsd.own.mk> contains the owners, groups, etc. for both
 158 manual pages and binaries.
 159
 160 It has no targets.
 161
 162 It sets/uses the following variables:
 163
 164 BINGRP          Binary group.
 165
 166 BINOWN          Binary owner.
 167
 168 BINMODE         Binary mode.
 169
 170 MANDIR          Base path for manual installation.
 171
 172 MANGRP          Manual group.
 173
 174 MANOWN          Manual owner.
 175
 176 MANMODE         Manual mode.
 177
 178 This file is generally useful when building your own Makefiles so that
 179 they use the same default owners etc. as the rest of the tree.
 180
 181 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 182
 183 The include file <bsd.prog.mk> handles building programs from one or
 184 more source files, along with their manual pages.  It has a limited number
 185 of suffixes, consistent with the current needs of the BSD tree.
 186
 187 It has seven targets:
 188
 189         all:
 190                 build the program and its manual page
 191         clean:
 192                 remove the program and any object files.
 193         cleandir:
 194                 remove all of the files removed by the target clean, as
 195                 well as .depend, tags, and any manual pages.
 196         depend:
 197                 make the dependencies for the source files, and store
 198                 them in the file .depend.
 199         install:
 200                 install the program and its manual pages; if the Makefile
 201                 does not itself define the target install, the targets
 202                 beforeinstall and afterinstall may also be used to cause
 203                 actions immediately before and after the install target
 204                 is executed.
 205         lint:
 206                 run lint on the source files
 207         tags:
 208                 create a tags file for the source files.
 209
 210 It sets/uses the following variables:
 211
 212 BINGRP          Binary group.
 213
 214 BINOWN          Binary owner.
 215
 216 BINMODE         Binary mode.
 217
 218 CLEANFILES      Additional files to remove and
 219 CLEANDIRS       additional directories to remove during clean and cleandir
 220                 targets.  "rm -f" and "rm -rf" used respectively.
 221
 222 CFLAGS          Flags to the compiler when creating C objects.
 223
 224 FILES           A list of non-executable files.
 225                 The installation is controlled by the FILESNAME, FILESOWN,
 226                 FILESGRP, FILESMODE, FILESDIR variables that can be
 227                 further specialized by FILES<VAR>_<file>.
 228
 229 LDADD           Additional loader objects.  Usually used for libraries.
 230                 For example, to load with the compatibility and utility
 231                 libraries, use:
 232
 233                         LDADD=-lutil -lcompat
 234
 235 LDFLAGS         Additional loader flags. Passed to the loader via CC,
 236                 since that's used to link programs as well, so loader
 237                 specific flags need to be prefixed with -Wl, to work.
 238
 239 LINKS           The list of binary links; should be full pathnames, the
 240                 linked-to file coming first, followed by the linked
 241                 file.  The files are hard-linked.  For example, to link
 242                 /bin/test and /bin/[, use:
 243
 244                         LINKS=  ${DESTDIR}/bin/test ${DESTDIR}/bin/[
 245
 246 MAN             Manual pages (should end in .1 - .9).  If no MAN variable
 247                 is defined, "MAN=${PROG}.1" is assumed.
 248
 249 PROG            The name of the program to build.  If not supplied, nothing
 250                 is built.
 251
 252 PROG_CXX        If defined, the name of the program to build.  Also
 253                 causes <bsd.prog.mk> to link the program with the
 254                 standard C++ library.  PROG_CXX overrides the value
 255                 of PROG if PROG is also set.
 256
 257 PROGNAME        The name that the above program will be installed as, if
 258                 different from ${PROG}.
 259
 260 SRCS            List of source files to build the program.  If SRCS is not
 261                 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
 262                 defined, ${PROG_CXX}.cc.
 263
 264 DPADD           Additional dependencies for the program.  Usually used for
 265                 libraries.  For example, to depend on the compatibility and
 266                 utility libraries use:
 267
 268                         DPADD=${LIBCOMPAT} ${LIBUTIL}
 269
 270                 There is a predefined identifier for each (non-profiled,
 271                 non-shared) library and object.  Library file names are
 272                 transformed to identifiers by removing the extension and
 273                 converting to upper case.
 274
 275                 There are no special identifiers for profiled or shared
 276                 libraries or objects.  The identifiers for the standard
 277                 libraries are used in DPADD.  This works correctly iff all
 278                 the libraries are built at the same time.  Unfortunately,
 279                 it causes unnecessary relinks to shared libraries when
 280                 only the static libraries have changed.  Dependencies on
 281                 shared libraries should be only on the library version
 282                 numbers.
 283
 284 STRIP           The flag passed to the install program to cause the binary
 285                 to be stripped.  This is to be used when building your
 286                 own install script so that the entire system can be made
 287                 stripped/not-stripped using a single nob.
 288
 289 SUBDIR          A list of subdirectories that should be built as well.
 290                 Each of the targets will execute the same target in the
 291                 subdirectories.
 292
 293 SCRIPTS         A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
 294                 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
 295                 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
 296                 further specialized by SCRIPTS<VAR>_<script>.
 297
 298 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
 299 if it exists, as well as the include file <bsd.man.mk>.
 300
 301 Some simple examples:
 302
 303 To build foo from foo.c with a manual page foo.1, use:
 304
 305         PROG=   foo
 306
 307         .include <bsd.prog.mk>
 308
 309 To build foo from foo.c with a manual page foo.2, add the line:
 310
 311         MAN=    foo.2
 312
 313 If foo does not have a manual page at all, add the line:
 314
 315         MAN=
 316
 317 If foo has multiple source files, add the line:
 318
 319         SRCS=   a.c b.c c.c d.c
 320
 321 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 322
 323 The include file <bsd.subdir.mk> contains the default targets for building
 324 subdirectories.  It has the same seven targets as <bsd.prog.mk>: all, clean,
 325 cleandir, depend, install, lint, and tags.  For all of the directories
 326 listed in the variable SUBDIRS, the specified directory will be visited
 327 and the target made.  There is also a default target which allows the
 328 command "make subdir" where subdir is any directory listed in the variable
 329 SUBDIRS.
 330
 331 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 332
 333 The include file <bsd.lib.mk> has support for building libraries.  It has
 334 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
 335 install, lint, and tags.  It has a limited number of suffixes, consistent
 336 with the current needs of the BSD tree.
 337
 338 It sets/uses the following variables:
 339
 340 LIB             The name of the library to build.
 341
 342 LIB_CXX         The name of the library to build. It also causes
 343                 <bsd.lib.mk> to link the library with the
 344                 standard C++ library.  LIB_CXX overrides the value
 345                 of LIB if LIB is also set.
 346
 347 LIBDIR          Target directory for libraries.
 348
 349 LINTLIBDIR      Target directory for lint libraries.
 350
 351 LIBGRP          Library group.
 352
 353 LIBOWN          Library owner.
 354
 355 LIBMODE         Library mode.
 356
 357 LDADD           Additional loader objects.
 358
 359 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 360
 361 SRCS            List of source files to build the library.  Suffix types
 362                 .s, .c, and .f are supported.  Note, .s files are preferred
 363                 to .c files of the same name.  (This is not the default for
 364                 versions of make.)
 365
 366 SHLIB_LDSCRIPT  Template file to generate shared library linker script.
 367                 Unless used, a simple symlink is created to the real
 368                 shared object.
 369
 370 LIBRARIES_ONLY  Do not build or install files other than the library.
 371
 372 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
 373 if it exists, as well as the include file <bsd.man.mk>.
 374
 375 It has rules for building profiled objects; profiled libraries are
 376 built by default.
 377
 378 Libraries are ranlib'd before installation.
 379
 380 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 381
 382 The include file <bsd.test.mk> handles building one or more test programs
 383 intended to be used in the FreeBSD Test Suite under /usr/tests/.
 384
 385 It has seven targets:
 386
 387         all:
 388                 build the test programs.
 389         clean:
 390                 remove the test programs and any object files.
 391         cleandir:
 392                 remove all of the files removed by the target clean, as
 393                 well as .depend and tags.
 394         depend:
 395                 make the dependencies for the source files, and store
 396                 them in the file .depend.
 397         install:
 398                 install the test programs and their data files; if the
 399                 Makefile does not itself define the target install, the
 400                 targets beforeinstall and afterinstall may also be used
 401                 to cause actions immediately before and after the
 402                 install target is executed.
 403         lint:
 404                 run lint on the source files.
 405         tags:
 406                 create a tags file for the source files.
 407         test:
 408                 runs the test programs from the object directory; if the
 409                 Makefile does not itself define the target test, the
 410                 targets beforetest and aftertest may also be used to
 411                 cause actions immediately before and after the test
 412                 target is executed.
 413
 414 It sets/uses the following variables, among many others:
 415
 416 TESTDIR         Path to the installed tests.  Must be a subdirectory of
 417                 TESTSBASE and the subpath should match the relative
 418                 location of the tests within the src tree.
 419
 420 KYUAFILE        If 'auto' (the default), generate a Kyuafile out of the
 421                 test programs defined in the Makefile.  If 'yes', then a
 422                 manually-crafted Kyuafile must be supplied with the
 423                 sources.  If 'no', no Kyuafile is installed (useful for
 424                 subdirectories providing helper programs or data files
 425                 only).
 426
 427 ATF_TESTS_C     The names of the ATF C test programs to build.
 428
 429 ATF_TESTS_CXX   The names of the ATF C++ test programs to build.
 430
 431 ATF_TESTS_SH    The names of the ATF sh test programs to build.
 432
 433 PLAIN_TESTS_C   The names of the plain (legacy) programs to build.
 434
 435 PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
 436
 437 PLAIN_TESTS_SH  The names of the plain (legacy) test programs to build.
 438
 439 TAP_PERL_INTERPRETER
 440                 Path to the Perl interpreter to be used for
 441                 TAP-compliant test programs that are written in Perl.
 442                 Refer to TAP_TESTS_PERL for details.
 443
 444 TAP_TESTS_C     The names of the TAP-compliant C test programs to build.
 445
 446 TAP_TESTS_CXX   The names of the TAP-compliant C++ test programs to
 447                 build.
 448
 449 TAP_TESTS_PERL  The names of the TAP-compliant Perl test programs to
 450                 build.  The corresponding source files should end with
 451                 the .pl extension; the test program is marked as
 452                 requiring Perl; and TAP_PERL_INTERPRETER is used in the
 453                 built scripts as the interpreter of choice.
 454
 455 TAP_TESTS_SH    The names of the TAP-compliant sh test programs to
 456                 build.
 457
 458 TESTS_SUBDIRS   List of subdirectories containing tests into which to
 459                 recurse.  Differs from SUBDIR in that these directories
 460                 get registered into the automatically-generated
 461                 Kyuafile (if any).
 462
 463 NOT_FOR_TEST_SUITE
 464                 If defined, none of the built test programs get
 465                 installed under /usr/tests/ and no Kyuafile is
 466                 automatically generated.  Should not be used within the
 467                 FreeBSD source tree but is provided for the benefit of
 468                 third-parties.
 469
 470 The actual building of the test programs is performed by <bsd.prog.mk>.
 471 Please see the documentation above for this other file for additional
 472 details on the behavior of <bsd.test.mk>.