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
  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.snmpmod.mk          - building modules for the SNMP daemon bsnmpd
  40 bsd.subdir.mk           - targets for building subdirectories
  41 bsd.sys.mk              - common settings used for building FreeBSD sources
  42 sys.mk                  - default rules for all makes
  43
  44 This file does not document bsd.port*.mk.  They are documented in ports(7).
  45
  46 See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
  47 Tutorial', located in /usr/share/doc/psd/12.make.
  48
  49 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  50
  51 Random things worth knowing about this document:
  52
  53 If appropriate when documenting the variables the default value is
  54 indicated using square brackets e.g. [gzip].
  55 In some cases the default value depend on other values (e.g. system
  56 architecture).  In these cases the most common value is indicated.
  57
  58 This document contains some simple examples of the usage of the BSD make
  59 include files.  For more examples look at the makefiles in the FreeBSD
  60 source tree.
  61
  62 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  63
  64 RANDOM THINGS WORTH KNOWING:
  65
  66 The files are like C-style #include files, and pretty much behave like
  67 you'd expect.  The syntax is slightly different in that a single '.' is
  68 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
  69
  70 One difference that will save you lots of debugging time is that inclusion
  71 of the file is normally done at the *end* of the Makefile.  The reason for
  72 this is because .mk files often modify variables and behavior based on the
  73 values of variables set in the Makefile.  To make this work, remember that
  74 the 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
  81 the command "make a" will echo "a".  To make things confusing, the SECOND
  82 variable 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
  90 the command "make b" will echo "bar".  This is for compatibility with the
  91 way the V7 make behaved.
  92
  93 It's fairly difficult to make the BSD .mk files work when you're building
  94 multiple programs in a single directory.  It's a lot easier to split up
  95 the programs than to deal with the problem.  Most of the agony comes from
  96 making the "obj" directory stuff work right, not because we switch to a new
  97 version of make.  So, don't get mad at us, figure out a better way to handle
  98 multiple architectures so we can quit using the symbolic link stuff.
  99 (Imake doesn't count.)
 100
 101 The file .depend in the source directory is expected to contain dependencies
 102 for the source files.  This file is read automatically by make after reading
 103 the Makefile.
 104
 105 The variable DESTDIR works as before.  It's not set anywhere but will change
 106 the tree where the file gets installed.
 107
 108 The profiled libraries are no longer built in a different directory than
 109 the regular libraries.  A new suffix, ".po", is used to denote a profiled
 110 object.
 111
 112 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 113
 114 The include file <sys.mk> has the default rules for all makes, in the BSD
 115 environment or otherwise.  You probably don't want to touch this file.
 116
 117 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 118
 119 The include file <bsd.man.mk> handles installing manual pages and their
 120 links.
 121
 122 It 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
 131 It sets/uses the following variables:
 132
 133 MANDIR          Base path for manual installation.
 134
 135 MANGRP          Manual group.
 136
 137 MANOWN          Manual owner.
 138
 139 MANMODE         Manual mode.
 140
 141 MANSUBDIR       Subdirectory under the manual page section, i.e. "/vax"
 142                 or "/tahoe" for machine specific manual pages.
 143
 144 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 145
 146 MLINKS          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
 150 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
 151 it exists.
 152
 153 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 154
 155 The include file <bsd.own.mk> contains the owners, groups, etc. for both
 156 manual pages and binaries.
 157
 158 It has no targets.
 159
 160 It sets/uses the following variables:
 161
 162 BINGRP          Binary group.
 163
 164 BINOWN          Binary owner.
 165
 166 BINMODE         Binary mode.
 167
 168 MANDIR          Base path for manual installation.
 169
 170 MANGRP          Manual group.
 171
 172 MANOWN          Manual owner.
 173
 174 MANMODE         Manual mode.
 175
 176 This file is generally useful when building your own Makefiles so that
 177 they use the same default owners etc. as the rest of the tree.
 178
 179 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 180
 181 The include file <bsd.prog.mk> handles building programs from one or
 182 more source files, along with their manual pages.  It has a limited number
 183 of suffixes, consistent with the current needs of the BSD tree.
 184
 185 It has seven targets:
 186
 187         all:
 188                 build the program and its manual page
 189         clean:
 190                 remove the program and any object files.
 191         cleandir:
 192                 remove all of the files removed by the target clean, as
 193                 well as .depend, tags, and any manual pages.
 194         depend:
 195                 make the dependencies for the source files, and store
 196                 them in the file .depend.
 197         install:
 198                 install the program and its manual pages; if the Makefile
 199                 does not itself define the target install, the targets
 200                 beforeinstall and afterinstall may also be used to cause
 201                 actions immediately before and after the install target
 202                 is executed.
 203         lint:
 204                 run lint on the source files
 205         tags:
 206                 create a tags file for the source files.
 207
 208 It sets/uses the following variables:
 209
 210 BINGRP          Binary group.
 211
 212 BINOWN          Binary owner.
 213
 214 BINMODE         Binary mode.
 215
 216 CLEANFILES      Additional files to remove and
 217 CLEANDIRS       additional directories to remove during clean and cleandir
 218                 targets.  "rm -f" and "rm -rf" used respectively.
 219
 220 CFLAGS          Flags to the compiler when creating C objects.
 221
 222 FILES           A list of non-executable files.
 223                 The installation is controlled by the FILESNAME, FILESOWN,
 224                 FILESGRP, FILESMODE, FILESDIR variables that can be
 225                 further specialized by FILES<VAR>_<file>.
 226
 227 LDADD           Additional loader objects.  Usually used for libraries.
 228                 For example, to load with the compatibility and utility
 229                 libraries, use:
 230
 231                         LDADD=-lutil -lcompat
 232
 233 LDFLAGS         Additional loader flags.
 234
 235 LINKS           The list of binary links; should be full pathnames, the
 236                 linked-to file coming first, followed by the linked
 237                 file.  The files are hard-linked.  For example, to link
 238                 /bin/test and /bin/[, use:
 239
 240                         LINKS=  ${DESTDIR}/bin/test ${DESTDIR}/bin/[
 241
 242 MAN             Manual pages (should end in .1 - .9).  If no MAN variable
 243                 is defined, "MAN=${PROG}.1" is assumed.
 244
 245 PROG            The name of the program to build.  If not supplied, nothing
 246                 is built.
 247
 248 PROG_CXX        If defined, the name of the program to build.  Also
 249                 causes <bsd.prog.mk> to link the program with the
 250                 standard C++ library.  PROG_CXX overrides the value
 251                 of PROG if PROG is also set.
 252
 253 PROGNAME        The name that the above program will be installed as, if
 254                 different from ${PROG}.
 255
 256 SRCS            List of source files to build the program.  If SRCS is not
 257                 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
 258                 defined, ${PROG_CXX}.cc.
 259
 260 DPADD           Additional dependencies for the program.  Usually used for
 261                 libraries.  For example, to depend on the compatibility and
 262                 utility libraries use:
 263
 264                         DPADD=${LIBCOMPAT} ${LIBUTIL}
 265
 266                 There is a predefined identifier for each (non-profiled,
 267                 non-shared) library and object.  Library file names are
 268                 transformed to identifiers by removing the extension and
 269                 converting to upper case.
 270
 271                 There are no special identifiers for profiled or shared
 272                 libraries or objects.  The identifiers for the standard
 273                 libraries are used in DPADD.  This works correctly iff all
 274                 the libraries are built at the same time.  Unfortunately,
 275                 it causes unnecessary relinks to shared libraries when
 276                 only the static libraries have changed.  Dependencies on
 277                 shared libraries should be only on the library version
 278                 numbers.
 279
 280 STRIP           The flag passed to the install program to cause the binary
 281                 to be stripped.  This is to be used when building your
 282                 own install script so that the entire system can be made
 283                 stripped/not-stripped using a single nob.
 284
 285 SUBDIR          A list of subdirectories that should be built as well.
 286                 Each of the targets will execute the same target in the
 287                 subdirectories.
 288
 289 SCRIPTS         A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
 290                 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
 291                 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
 292                 further specialized by SCRIPTS<VAR>_<script>.
 293
 294 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
 295 if it exists, as well as the include file <bsd.man.mk>.
 296
 297 Some simple examples:
 298
 299 To build foo from foo.c with a manual page foo.1, use:
 300
 301         PROG=   foo
 302
 303         .include <bsd.prog.mk>
 304
 305 To build foo from foo.c with a manual page foo.2, add the line:
 306
 307         MAN=    foo.2
 308
 309 If foo does not have a manual page at all, add the line:
 310
 311         NO_MAN=
 312
 313 If foo has multiple source files, add the line:
 314
 315         SRCS=   a.c b.c c.c d.c
 316
 317 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 318
 319 The include file <bsd.subdir.mk> contains the default targets for building
 320 subdirectories.  It has the same seven targets as <bsd.prog.mk>: all, clean,
 321 cleandir, depend, install, lint, and tags.  For all of the directories
 322 listed in the variable SUBDIRS, the specified directory will be visited
 323 and the target made.  There is also a default target which allows the
 324 command "make subdir" where subdir is any directory listed in the variable
 325 SUBDIRS.
 326
 327 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 328
 329 The include file <bsd.lib.mk> has support for building libraries.  It has
 330 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
 331 install, lint, and tags.  It has a limited number of suffixes, consistent
 332 with the current needs of the BSD tree.
 333
 334 It sets/uses the following variables:
 335
 336 LIBDIR          Target directory for libraries.
 337
 338 LINTLIBDIR      Target directory for lint libraries.
 339
 340 LIBGRP          Library group.
 341
 342 LIBOWN          Library owner.
 343
 344 LIBMODE         Library mode.
 345
 346 LDADD           Additional loader objects.
 347
 348 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 349
 350 SRCS            List of source files to build the library.  Suffix types
 351                 .s, .c, and .f are supported.  Note, .s files are preferred
 352                 to .c files of the same name.  (This is not the default for
 353                 versions of make.)
 354
 355 SHLIB_LDSCRIPT  Template file to generate shared library linker script.
 356                 Unless used, a simple symlink is created to the real
 357                 shared object.
 358
 359 LIBRARIES_ONLY  Do not build or install files other than the library.
 360
 361 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
 362 if it exists, as well as the include file <bsd.man.mk>.
 363
 364 It has rules for building profiled objects; profiled libraries are
 365 built by default.
 366
 367 Libraries are ranlib'd before installation.