NameDateSize

..15-May-202422

bsd.clang-analyze.mkH A D01-Sep-20111 KiB

bsd.clean.mkH A D22-Nov-20112.6 KiB

bsd.dep.mkH A D10-Sep-20112 KiB

bsd.doc.mkH A D16-Mar-20061.5 KiB

bsd.endian.mkH A D09-Jan-2008796

bsd.files.mkH A D10-Sep-20113.6 KiB

bsd.gcc.mkH A D25-Oct-2008740

bsd.hostlib.mkH A D10-Sep-20111.2 KiB

bsd.hostprog.mkH A D02-Mar-20124.4 KiB

bsd.inc.mkH A D16-Mar-20061.4 KiB

bsd.info.mkH A D10-Sep-20112 KiB

bsd.init.mkH A D27-Jul-2003352

bsd.ioconf.mkH A D25-Mar-20101.1 KiB

bsd.kernobj.mkH A D24-Jan-2010957

bsd.kinc.mkH A D16-Mar-20062.2 KiB

bsd.klinks.mkH A D10-Jul-20112 KiB

bsd.kmodule.mkH A D16-Feb-20123.8 KiB

bsd.lib.mkH A D28-Jan-201222.3 KiB

bsd.links.mkH A D10-Apr-20092.3 KiB

bsd.lua.mkH A D15-Oct-20114.2 KiB

bsd.man.mkH A D10-Sep-20117.3 KiB

bsd.nls.mkH A D10-Sep-20111.3 KiB

bsd.obj.mkH A D24-Jan-20102.6 KiB

bsd.own.mkH A D24-Nov-201232.4 KiB

bsd.prog.mkH A D02-Mar-201212.6 KiB

bsd.READMEH A D17-Sep-201261 KiB

bsd.rpc.mkH A D10-Sep-20111.4 KiB

bsd.shlib.mkH A D29-Aug-2007833

bsd.subdir.mkH A D25-May-20101.3 KiB

bsd.sys.mkH A D30-Jun-20127.5 KiB

bsd.test.mkH A D10-Sep-20114.2 KiB

bsd.x11.mkH A D17-Jan-201212.3 KiB

MakefileH A D07-Oct-2011672

sys.mkH A D17-May-20125.5 KiB

bsd.README

1#	$NetBSD$
2#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
3
4This is the README file for the make "include" files for the NetBSD
5source tree.  The files are installed in /usr/share/mk, and are,
6by convention, 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 to 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 switched 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 ".pico" denotes a shared (position-independent) object.
60
61There are various make variables used during the build.
62
63Many variables support a (case sensitive) value of "no" or "yes",
64and are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
65
66
67The basic rule for the variable naming scheme is as follows:
68
69HOST_xxx	A command that runs on the host machine regardless of
70		whether or not the system is being cross compiled, or
71		flags for such a command.
72
73MKxxx		Can be set to "no" to disable functionality, or
74		"yes" to enable it.
75		Usually defaults to "yes", although some variables
76		default to "no".
77		Due to make(1) implementation issues, if a temporary
78		command-line override of a mk.conf(5) or <bsd.own.mk>
79		setting is required whilst still honoring a particular
80		Makefile's setting of MKxxx, use
81			env MKxxx=value make
82		instead of
83			make MKxxx=value
84
85NOxxx		If defined, disables a feature.
86		Not intended for users.
87		This is to allow Makefiles to disable functionality
88		that they don't support (such as missing man pages).
89		NOxxx variables must be defined before <bsd.own.mk>
90		is included.
91
92TOOL_xxx	A tool that is provided as part of the USETOOLS
93		framework.  When not using the USETOOLS framework,
94		TOOL_xxx variables should refer to tools that are
95		already installed on the host system.
96
97The following variables that control how things are made/installed that
98are not set by default. These should not be set by Makefiles; they're for
99the user to define in MAKECONF (see <bsd.own.mk>, below, or mk.conf(5))
100or on the make(1) command line:
101
102BUILD 		If defined, 'make install' checks that the targets in the
103		source directories are up-to-date and remakes them if they
104                are out of date, instead of blindly trying to install
105                out of date or non-existent targets.
106
107MAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
108		Default: 2
109		Supported values:
110		    0	Minimal output ("quiet")
111		    1	Describe what is occurring
112		    2	Describe what is occurring and echo the actual command
113		    3	Ignore the effect of the "@" prefix in make commands
114		    4	Trace shell commands using the shell's -x flag
115
116MKATF		If "no", don't build libatf-c, libatf-c++ libraries associated
117		with the Automated Testing Framework (ATF).
118		Default: yes
119
120MKBFD		Obsolete, use MKBINUTILS
121
122MKBINUTILS	If "no", don't build binutils (gas, ld, etc and libbfd,
123		libopcodes)
124		Default: yes
125
126MKBSDTAR	If "yes", use the libarchive based cpio and tar instead of
127		the pax frontends.
128		Default: no
129
130MKCATPAGES	If "no", don't build or install the catman pages.
131		Default: no
132
133MKCOMPAT  	If "no", don't build or install the src/compat.
134		Default: yes on amd64/sparc64, no elsewhere.
135
136MKCOMPLEX	If "no", don't build libm support for <complex.h>
137		Default: yes
138
139MKCRYPTO	If "no", no cryptography support will be built into the system,
140		and also acts as "MKKERBEROS=no".
141		Default: yes
142
143MKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
144		Default: no
145
146MKCVS		If "no", don't build or install cvs(1).
147		Default: yes
148
149MKDEBUG		If "no", don't build and install separate debugging symbols
150		into /usr/libdata/debug.
151		Default: no
152
153MKDEBUGLIB	Build *_g.a debugging libraries, which are compiled
154		with -DDEBUG.
155		Default: no
156
157MKDOC		If "no", don't build or install the documentation.
158		Default: yes
159
160MKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
161		don't install certain libraries in /lib, and don't
162		install the shared linker into /libexec.
163		Default: yes
164
165MKEXTSRC        If not "no", 'make build' also descends into either src/extsrc
166		to cross-build programs and libraries externally added by
167		users, and automatically enables creation of those sets.
168		Default: no
169
170MKGCC		If "no", don't build gcc(1) or any of the GCC-related
171		libraries (libgcc, libobjc, libstdc++).
172		Default: yes
173
174MKGCCCMDS	If "no", don't build gcc(1), but do build the GCC-related
175		libraries (libgcc, libobjc, libstdc++).
176		Default: yes
177
178MKGDB		If "no", don't build gdb(1).
179		Default: yes
180
181MKHESIOD	If "no", disables building of Hesiod infrastructure
182		(libraries and support programs).
183		Default: yes
184
185MKHOSTOBJ	If not "no", for programs intended to be run on the compile
186		host, the name, release, and architecture of the host
187		operating system will be suffixed to the name of the object
188		directory created by "make obj".
189		Default: no
190
191MKHTML		If "no", don't build or install the HTML man pages.
192		Default: yes
193
194MKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
195		Has no effect on most platforms.
196		Default: yes
197
198MKSTRIPIDENT	Strip the RCS IDs from program binaries and shared libraries.
199		Default: no
200
201MKINET6		If "no", disables building of INET6 (IPv6) infrastructure
202		(libraries and support programs).  This option must not be
203		set to "no" if MKX11 is not "no".
204		Default: yes
205
206MKINFO		If "no", don't build or install Info documentation from
207		Texinfo source files.
208		Default: yes
209
210MKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
211		Default: yes
212
213MKISCSI		If "no", don't build or install iSCSI library or applications
214		(depends on libpthread.)
215		Default: yes
216
217MKKERBEROS	If "no", disables building of Kerberos v5
218		infrastructure (libraries and support programs).
219		Default: yes
220
221MKLDAP		If "no", disables building of LDAP infrastructure
222		(libraries and support programs).
223		Default: yes
224
225MKLINKLIB	If "no", act as "MKLINT=no MKPICINSTALL=no MKPROFILE=no".
226		Also:
227			- don't install the .a libraries
228			- don't install _pic.a libraries on PIC systems
229			- don't build .a libraries on PIC systems
230			- don't install the .so symlink on ELF systems
231		I.e, only install the shared library (and the .so.major
232		symlink on ELF).
233		Default: yes
234
235MKLINT		If "no", don't build or install the lint libraries.
236		Default: yes
237
238MKLVM		If "no", don't build or install the logical volume manager
239		and device mapper tools and libraries
240		Default: yes
241
242MKMAN		If "no", don't build or install the man or catman pages,
243		and also acts as "MKCATPAGES=no MKHTML=no".
244		Default: yes
245
246MKMANDOC	If "yes", mandoc is built as tool and used to compile
247		catman or html pages.  A directory can be exempted by
248		defining NOMANDOC.  Individual man pages are exempted
249		if NOMANDOC.${target} is set to "yes".
250		Default: yes
251
252MKMANZ		If not "no", compress manual pages at installation time.
253		Default: no
254
255MKMDNS		If "no", disables building of mDNS infrastructure
256		(libraries and support programs).
257		Default: yes
258
259MKNLS		If "no", don't build or install the NLS files and locale
260		definition files.
261		Default: yes
262
263MKNPF		If "no", don't build or install the NPF and its modules.
264		Default: yes
265
266MKOBJ		If "no", don't enable the rule which creates objdirs,
267		and also acts as "MKOBJDIRS=no".
268		Default: yes
269
270MKOBJDIRS	If "no", don't create objdirs during a "make build".
271		Default: no
272
273MKPAM		If "no", disables building of PAM authentication
274		infrastructure (libraries and support programs).
275		Default: yes
276
277MKPCC		If "no", don't build pcc(1) or any of the PCC-related
278		libraries (libpcc, libpccsoftfloat).
279		Default: no
280
281MKPF		If "no", don't build or install the pf programs and LKM.
282		Default: yes
283
284MKPIC		If "no", don't build or install shared libraries, and
285		also acts as "MKPICLIB=no"
286		Default: yes (for MACHINE_ARCHs that support it) 
287
288MKPICINSTALL	If "no", don't install the *_pic.a libraries.
289		Default: yes
290
291MKPICLIB	If "no", don't build *_pic.a libraries, and build the
292		shared object libraries from the .a libraries.
293		A symlink is installed in ${DESTDIR}/usr/lib for the
294		_pic.a library pointing to the .a library.
295		Default: yes
296
297MKPIE		If "no", create regular executables. Otherwise create
298		PIE (Position Independent Executables).
299		Default: no
300
301MKPIGZGZIP	If "no", only install pigz as pigz, not gzip.
302		Default: no
303
304MKPOSTFIX	If "no", don't build or install postfix(1).
305		Default: yes
306
307MKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
308		Default: yes
309
310MKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
311		MKMAN=no MKNLS=no".
312		I.e, don't build catman pages, documentation, Info
313		documentation, man pages, NLS files, ...
314		Default: yes
315
316MKSKEY		If "no", disables building of S/key authentication
317		infrastructure (libraries and support programs).
318		Default: yes
319
320MKSOFTFLOAT	If not "no", build with options to enable the compiler to
321		generate output containing library calls for floating
322		point and possibly soft-float library support.
323		Default: no
324
325MKSTATICLIB	If "no", don't build or install the normal static (*.a)
326		libraries.
327		Default: yes
328
329MKUNPRIVED	If not "no", don't set the owner/group/mode when installing
330		files or directories, and keep a metadata log of what
331		the owner/group/mode should be.  This allows a
332		non-root "make install".
333		Default: no
334
335MKUPDATE 	If not "no", 'make install' only installs targets that are
336		more recently modified in the source directories that their
337		installed counterparts.
338		Default: no
339
340MKX11		If not "no", depending on the value of ${X11FLAVOUR},
341		'make build' also descends into either src/x11 (XFree86) or
342		src/external/mit/xorg (modular Xorg) to cross-build X11 and
343		automatically enables creation of X sets.
344		Default: no
345
346MKX11FONTS	If not "no", if ${X11FLAVOUR} is "Xorg", do not build or
347		install the X fonts.  The xfont set is still created but
348		will be empty.
349		Default: yes
350
351MKYP		If "no", disables building of YP (NIS)
352		infrastructure (libraries and support programs).
353		Default: yes
354
355MKZFS		If "no", do not build and install utilities and libraries 
356		used to manage ZFS file system. Do not build zfs and solaris 
357		compatibility kernel modules.
358		Default: yes on i386/amd64, no elsewhere.
359
360USE_HESIOD	If "no", disables building Hesiod support into
361		various system utilities/libraries that support it.
362		If ${MKHESIOD} is "no", USE_HESIOD will also be
363		forced to "no".
364
365USE_INET6	If "no", disables building INET6 (IPv6) support into
366		various system utilities/libraries that support it.
367		If ${MKINET6} is "no", USE_INET6 will also be
368		forced to "no".
369
370USE_JEMALLOC	If "no", disables building the "jemalloc" allocator
371		designed for improved performance with threaded
372		applications.  The "phkmalloc" allocator as used up
373		before NetBSD-5.0 will be substituted.
374
375USE_KERBEROS	If "no", disables building Kerberos v5
376		support into various system utilities/libraries that
377		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
378		will also be forced to "no".
379
380USE_LDAP	If "no", disables building LDAP support into various
381		system utilities/libraries that support it.
382		If ${MKLDAP} is "no", USE_LDAP will also be forced to "no".
383
384USE_PAM		If "no", disables building PAM authentication support
385		into various system utilities/libraries that support it.
386		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
387
388USE_SKEY	If "no", disables building S/key authentication
389		support into various system utilities/libraries that
390		support it.  If ${MKSKEY} is "no", USE_SKEY will
391		also be forced to "no".
392		Default: no
393
394USE_SSP		If "no", disables GCC stack protection code, which
395		detects stack overflows and aborts the program. The
396		stack protection code imposes a performance penalty
397		of about 5%.
398		Default: "no", unless "USE_FORT" is set to "yes"
399
400USE_FORT 	If "yes" turns on substitute wrappers for commonly used
401		functions that do not do bounds checking regularly, but
402		they could in some cases by using the gcc
403		__builtin_object_size() function to determine the buffer 
404		size where it is known and detect buffer overflows.
405		These substitute functions are in /usr/include/ssp.
406		Default: depends on the part of the source tree
407
408USE_YP		If "no", disables building YP (NIS) support into
409		various system utilities/libraries that support it.
410		If ${MKYP} is "no", USE_YP will also be forced to "no".
411
412USE_PIGZGZIP	If "no", use the host "gzip" program to compress things.
413		Otherwise, build tools/pigz and use nbpigz to compress
414		things.
415		Default: "no".
416
417X11FLAVOUR	Set to "Xorg" or "XFree86", depending on whether to build
418		XFree86 or modular Xorg.  Only matters if MKX11!=no.
419		Default: "Xorg" on amd64, i386, macppc, shark and sparc64,
420		"XFree86" on everything else.
421
422COPTS.lib<lib>
423OBJCOPTS.lib<lib>
424LDADD.lib<lib>
425CPPFLAGS.lib<lib>
426CXXFLAGS.lib<lib>
427COPTS.<prog>
428OBJCCOPTS.<prog>
429LDADD.<prog>
430CPPFLAGS.<prog>
431CXXFLAGS.<prog>	These provide a way to specify additions to the associated
432		variables in a way that applies only to a particular library
433		or program.  <lib> corresponds to the LIB variable set in
434		the library's makefile.  <prog> corresponds to either PROG
435		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
436		set to "-g", "-g" will be added to COPTS only when compiling
437		the crypto library.
438
439The active compiler is selected using the following variables:
440AVAILABLE_COMPILER
441		List of available compiler suites.  Processed in order
442		for selecting the active compiler for each frontend.
443HAVE_PCC	If defined, PCC is present and enabled.
444HAVE_LLVM	If defined, LLVM/Clang is present and enabled.
445UNSUPPORTED_COMPILER.xxx
446		If defined, the support for compiler "xxx" is disabled.
447
448For the frontends (CC, CPP, CXX, FC and OBJC) the following variables exist:
449ACTIVE_CC	Active compile suite for the CC frontend.
450SUPPORTED_CC	Compile suite with support for the CC frontend.
451TOOL_CC.xxx	Path to the CC frontend for compiler "xxx"
452
453=-=-=-=-=   sys.mk   =-=-=-=-=
454
455The include file <sys.mk> has the default rules for all makes, in the BSD
456environment or otherwise.  You probably don't want to touch this file.
457
458=-=-=-=-=   bsd.own.mk   =-=-=-=-=
459
460The include file <bsd.own.mk> contains source tree configuration parameters,
461such as the owners, groups, etc. for both manual pages and binaries, and
462a few global "feature configuration" parameters.
463
464It has no targets.
465
466To get system-specific configuration parameters, <bsd.own.mk> will try to
467include the file specified by the "MAKECONF" variable.  If MAKECONF is not
468set, or no such file exists, the system make configuration file, /etc/mk.conf
469is included.  These files may define any of the variables described below.
470
471<bsd.own.mk> sets the following variables, if they are not already defined
472(defaults are in brackets):
473
474NETBSDSRCDIR	Top of the NetBSD source tree.
475		If _SRC_TOP_ != "", that will be used as the default,
476		otherwise BSDSRCDIR will be used as the default.
477		Various makefiles within the NetBSD source tree will
478		use this to reference the top level of the source tree.
479
480_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
481		based on the presence of tools/ and build.sh.  This variable
482		is "internal" to <bsd.own.mk>, although its value is only
483		determined once and then propagated to all sub-makes.
484
485BSDSRCDIR	The real path to the system sources, so that 'make obj'
486		will work correctly.  [/usr/src]
487
488BSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
489		will work correctly.  [/usr/obj]
490
491BINGRP		Binary group.  [wheel]
492
493BINOWN		Binary owner.  [root]
494
495BINMODE		Binary mode.  [555]
496
497NONBINMODE	Mode for non-executable files.  [444]
498
499MANDIR		Base path for manual installation.  [/usr/share/man/cat]
500
501MANGRP		Manual group.  [wheel]
502
503MANOWN		Manual owner.  [root]
504
505MANMODE		Manual mode.  [${NONBINMODE}]
506
507MANINSTALL	Manual installation type.  Space separated list:
508			catinstall, htmlinstall, maninstall
509		Default value derived from MKCATPAGES and MKHTML.
510
511LDSTATIC	Control program linking; if set blank, link everything
512		dynamically.  If set to "-static", link everything statically.
513		If not set, programs link according to their makefile.
514
515LIBDIR		Base path for library installation.  [/usr/lib]
516
517LINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
518
519LIBGRP		Library group.  [${BINGRP}]
520
521LIBOWN		Library owner.  [${BINOWN}]
522
523LIBMODE		Library mode.  [${NONBINMODE}]
524
525DOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
526	        installation.  [/usr/share/doc]
527
528HTMLDOCDIR	Base path for html system documentation installation.
529		[/usr/share/doc/html]
530
531DOCGRP		Documentation group.  [wheel]
532
533DOCOWN		Documentation owner.  [root]
534
535DOCMODE		Documentation mode.  [${NONBINMODE}]
536
537NLSDIR		Base path for Native Language Support files installation.
538		[/usr/share/nls]
539
540NLSGRP		Native Language Support files group.  [wheel]
541
542NLSOWN		Native Language Support files owner.  [root]
543
544NLSMODE		Native Language Support files mode.  [${NONBINMODE}]
545
546X11SRCDIR	The path to the xsrc tree.  [${NETBSDSRCDIR}/../xsrc,
547		if that exists; otherwise /usr/xsrc]
548
549X11SRCDIR.xc	The path to the (old) X11 xc src tree.  [${X11SRCDIR}/xfree/xc]
550
551X11SRCDIR.local	The path to the local X11 src tree.  [${X11SRCDIR}/local]
552
553X11SRCDIR.lib<package>
554X11SRCDIR.<package>
555		The path to the xorg src tree for the specificed package>.
556		[${X11SRCDIR}/external/mit/xorg/<package>/dist]
557
558X11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6 or
559		[/usr/X11R7]
560
561X11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
562
563X11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
564
565X11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
566
567X11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
568
569X11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
570
571X11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
572
573STRIPFLAG	The flag passed to the install program to cause the binary
574		to be stripped.  This is to be used when building your
575		own install script so that the entire system can be made
576		stripped/not-stripped using a single knob.  []
577
578COPY		The flag passed to the install program to cause the binary
579		to be copied rather than moved.  This is to be used when
580		building our own install script so that the entire system
581		can either be installed with copies, or with moves using
582		a single knob.  [-c]
583
584MAKEDIRTARGET dir target [params]
585		Runs "cd $${dir} && ${MAKE} [params] $${target}",
586		displaying a "pretty" message whilst doing so.
587
588RELEASEMACHINEDIR
589		Subdirectory used below RELEASEDIR when building
590		a release.  [${MACHINE}]
591
592RELEASEMACHINE	Subdirectory or path component used for the following
593		paths:
594			distrib/${RELEASEMACHINE}
595			distrib/notes/${RELEASEMACHINE}
596			etc/etc.${RELEASEMACHINE}
597		Used when building a release.  [${MACHINE}]
598
599Additionally, the following variables may be set by <bsd.own.mk> or in a
600make configuration file to modify the behavior of the system build
601process (default values are in brackets along with comments, if set by
602<bsd.own.mk>):
603
604USETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
605		be used as part of a build in progress.
606		Supported values:
607
608		yes	Use the tools from TOOLDIR.
609			Must be set to this if cross-compiling.
610
611		no	Do not use the tools from TOOLDIR, but refuse to
612			build native compilation tool components that are
613			version-specific for that tool.
614
615		never	Do not use the tools from TOOLDIR, even when
616			building native tool components.  This is similar to
617			the traditional NetBSD build method, but does not
618			verify that the compilation tools in use are
619			up-to-date enough in order to build the tree
620			successfully.  This may cause build or runtime
621			problems when building the whole NetBSD source tree.
622
623		Default: "yes" if building all or part of a whole NetBSD
624		source tree (detected automatically); "no" otherwise
625		(to preserve traditional semantics of the <bsd.*.mk>
626		make(1) include files).
627
628OBJECT_FMT	Object file format.  [set to "ELF" on architectures that
629		use ELF -- currently all architectures].
630
631TOOLCHAIN_MISSING
632		If not "no", this indicates that the platform being built
633		does not have a working in-tree toolchain.  If the
634		${MACHINE_ARCH} in question falls into this category,
635		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
636		Otherwise, the variable is unconditionally assigned the
637		value "no".
638		If not "no", ${MKBINUTILS}, ${MKGCC}, and ${MKGDB} are
639		unconditionally assigned the value "no".
640
641EXTERNAL_TOOLCHAIN
642		This variable is not directly set by <bsd.own.mk>, but
643		including <bsd.own.mk> is the canonical way to gain
644		access to this variable.  The variable should be defined
645		either in the user's environment or in the user's mk.conf
646		file.  If defined, this variable indicates the root of
647		an external toolchain which will be used to build the
648		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
649		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
650		cross-compile framework.
651
652		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
653		assigned the value "no", since the external version of the
654		compiler may not be able to build the library components of
655		the in-tree compiler.
656
657		NOTE: This variable is not yet used in as many places as
658		it should be.  Expect the exact semantics of this variable
659		to change in the short term as parts of the cross-compile
660		framework continue to be cleaned up.
661
662The following variables are defined to commands to perform the
663appropriate operation, with the default in [brackets].  Note that
664the defaults change if USETOOLS == "yes":
665
666TOOL_AMIGAAOUT2BB	aout to Amiga bootblock converter.  [amiga-aout2bb]
667
668TOOL_AMIGAELF2BB	ELF to Amiga bootblock converter.  [amiga-elf2bb]
669
670TOOL_AMIGATXLT		Amige assembly language format translator.  [amiga-txlt]
671
672TOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
673
674TOOL_AWK		Pattern-directed scanning/processing language.  [awk]
675
676TOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
677
678TOOL_CAT		Concatenate and print files.  [cat]
679
680TOOL_CKSUM		Display file checksums.  [cksum]
681
682TOOL_COMPILE_ET		Error table compiler.  [compile_et]
683
684TOOL_CONFIG		Build kernel compilation directories.  [config]
685
686TOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
687
688TOOL_CTAGS		Create a tags file.  [ctags]
689
690TOOL_DB			Manipulate db(3) databases.  [db]
691
692TOOL_DISKLABEL		Read and write disk pack label.  [disklabel]
693
694TOOL_EQN		Format equations for groff.  [eqn]
695
696TOOL_FDISK		MS-DOS partition maintenance program.  [fdisk]
697
698TOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
699
700TOOL_GENASSYM		Generate constants for assembly files.  [genassym]
701
702TOOL_GENCAT		Generate NLS message catalogs.  [gencat]
703
704TOOL_GMAKE		GNU make utility.  [gmake]
705
706TOOL_GREP		Print lines matching a pattern.  [grep]
707
708TOOL_GROFF		Front end for groff document formatting system.  [groff]
709
710TOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
711
712TOOL_HP300MKBOOT	Make bootable image for hp300.  [hp300-mkboot]
713
714TOOL_HP700MKBOOT	Make bootable image for hp700.  [hp700-mkboot]
715
716TOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
717
718TOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
719
720TOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
721
722TOOL_JOIN		Relational database operator.  [join]
723
724TOOL_M4			M4 macro language processor.  [m4]
725
726TOOL_MACPPCFIXCOFF	Fix up xcoff headers for macppc.  [macppc-fixcoff]
727
728TOOL_MAKEFS		Create file system image from directory tree.  [makefs]
729
730TOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
731
732TOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
733
734TOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
735
736TOOL_MENUC		Menu compiler.  [menuc]
737
738TOOL_MIPSELF2ECOFF	Convert ELF-format executable to ECOFF for mips.
739			[mips-elf2ecoff]
740
741TOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
742
743TOOL_MKESDB		Make encoding scheme database.  [mkesdb]
744
745TOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
746
747TOOL_MKMAGIC		Create database for file(1).  [file]
748
749TOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
750
751TOOL_MSGC		Simple message list compiler.  [msgc]
752
753TOOL_MTREE		Map a directory hierarchy.  [mtree]
754
755TOOL_PAX		Manipulate file archives and copy directories.  [pax]
756
757TOOL_PIC		Compile pictures for groff.  [pic]
758
759TOOL_PIGZ		Parallel compressor.  [pigz]
760
761TOOL_POWERPCMKBOOTIMAGE	Make bootable image for powerpc.  [powerpc-mkbootimage]
762
763TOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
764
765TOOL_REFER		Preprocess bibliographic references for groff.  [refer]
766
767TOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
768
769TOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
770
771TOOL_ROFF_HTML		Generate HTML groff output.
772			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
773
774TOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
775
776TOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
777
778TOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
779
780TOOL_SED		Stream editor.  [sed]
781
782TOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
783
784TOOL_SPARKCRC		Generate a crc suitable for use in a sparkive file.
785			[sparkcrc]
786
787TOOL_STAT		Display file status.  [stat]
788
789TOOL_STRFILE		Create a random access file for storing strings.
790			[strfile]
791
792TOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
793
794TOOL_TBL		Format tables for groff.  [tbl]
795
796TOOL_UUDECODE		Uudecode a binary file.  [uudecode]
797
798TOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
799
800TOOL_ZIC		Time zone compiler.  [zic]
801
802<bsd.own.mk> is generally useful when building your own Makefiles so that
803they use the same default owners etc. as the rest of the tree.
804
805
806=-=-=-=-=   bsd.clean.mk   =-=-=-=-=
807
808The include file <bsd.clean.mk> defines the clean and cleandir
809targets.  It uses the following variables:
810
811CLEANFILES	Files to remove for both the clean and cleandir targets.
812
813CLEANDIRFILES	Files to remove for the cleandir target, but not for
814		the clean target.
815
816MKCLEANSRC	Controls whether or not the clean and cleandir targets
817		will delete files from both the object directory,
818		${.OBJDIR}, and the source directory, ${.CURDIR}.
819
820		If MKCLEANSRC is set to "no", then the file names in
821		CLEANFILES or CLEANDIRFILES are interpreted relative
822		to the object directory, ${.OBJDIR}.  This is the
823		traditional behaviour.
824
825		If MKCLEANSRC is set to "yes", then the file deletion
826		is performed relative to both the object directory,
827		${.OBJDIR}, and the source directory, ${.CURDIR}.  (This
828		has no effect if ${.OBJDIR} is the same as ${.CURDIR}.)
829		Deleting files from ${.CURDIR} is intended to remove
830		stray output files that had been left in the source
831		directory by an earlier build that did not use object
832		directories.
833
834		The default is MKCLEANSRC=yes.  If you always build with
835		separate object directories, and you are sure that there
836		are no stray files in the source directories, then you
837		may set MKCLEANSRC=no to save some time.
838
839MKCLEANVERIFY	Controls whether or not the clean and cleandir targets
840		will verify that files have been deleted.
841
842		If MKCLEANVERIFY is set to "no", then the files will
843		be deleted using a "rm -f" command, and its success or
844		failure will be ignored.
845
846		If MKCLEANVERIFY is set to "yes", then the success of
847		the "rm -f" command will be verified using an "ls"
848		command.
849
850		The default is MKCLEANVERIFY=yes.  If you are sure that
851		there will be no problems caused by file permissions,
852		read-only file systems, or the like, then you may set
853		MKCLEANVERIFY=no to save some time.
854
855To use the clean and cleandir targets defined in <bsd.clean.mk>, other
856Makefiles or bsd.*.mk files should append file names to the CLEANFILES
857or CLEANDIRFILES variables.  For example:
858
859	    CLEANFILES+= a.out
860	    CLEANDIRFILES+= .depend
861
862	    .include <bsd.clean.mk>
863
864
865=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
866
867The include file <bsd.dep.mk> contains the default targets for building
868.depend files.  It creates .d files from entries in SRCS and DPSRCS
869that are C, C++, or Objective C source files, and builds .depend from the
870.d files.  All other files in SRCS and all of DPSRCS will be used as
871dependencies for the .d files.  In order for this to function correctly,
872it should be .included after all other .mk files and directives that may
873modify SRCS or DPSRCS.  It uses the following variables:
874
875SRCS		List of source files to build the program.
876
877DPSRCS		List of source files which are needed for generating
878		dependencies, but are not needed in ${SRCS}.
879
880
881=-=-=-=-=   bsd.files.mk   =-=-=-=-=
882
883The include file <bsd.files.mk> handles the FILES variables and is included
884from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
885
886FILES		The list of files to install.
887
888CONFIGFILES	Similar semantics to FILES, except that the files
889		are installed by the `configinstall' target,
890		not the `install' target.
891		The FILES* variables documented below also apply.
892
893FILESOWN	File owner.  [${BINOWN}]
894
895FILESGRP	File group.  [${BINGRP}]
896
897FILESMODE	File mode.  [${NONBINMODE}]
898
899FILESDIR	The location to install the files.
900
901FILESNAME	Optional name to install each file as.
902
903FILESOWN_<fn>	File owner of the specific file <fn>.
904
905FILESGRP_<fn>	File group of the specific file <fn>.
906
907FILESMODE_<fn>	File mode of the specific file <fn>.
908
909FILESDIR_<fn>	The location to install the specific file <fn>.
910
911FILESNAME_<fn>	Optional name to install <fn> as.
912
913FILESBUILD	If this variable is defined, then its value will be
914		used as the default for all FILESBUILD_<fn> variables.
915		Otherwise, the default will be "no".
916
917FILESBUILD_<fn>	A value different from "no" will add the file to the list of
918		targets to be built by `realall'.  Users of that variable
919		should provide a target to build the file.
920
921
922BUILDSYMLINKS	List of two word items:
923			lnsrc lntgt
924		For each lnsrc item, create a symlink named lntgt.
925		The lntgt symlinks are removed by the cleandir target.
926
927UUDECODE_FILES	List of files which are stored as <file>.uue in the source
928		tree. Each one will be decoded with ${TOOL_UUDECODE}.
929		The source files have a `.uue' suffix, the generated files do 
930		not.
931
932UUDECODE_FILES_RENAME_<fn>
933		Rename the output from the decode to the provided name.
934		
935		*NOTE: These files are simply decoded, with no install or other
936		       rule applying implicitly except being added to the clean
937		       target.
938
939=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
940
941The include file <bsd.gcc.mk> computes various parameters related to GCC
942support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
943before <bsd.gcc.mk>.
944
945The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
946of which need to know where to find certain GCC support libraries.
947
948The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
949which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
950the compiler is asked where to find the support libraries, otherwise the
951support libraries are found in ${DESTDIR}/usr/lib.
952
953<bsd.gcc.mk> sets the following variables:
954
955_GCC_CRTBEGIN	The full path name to crtbegin.o.
956
957_GCC_CRTBEGINS	The full path name to crtbeginS.o.
958
959_GCC_CRTEND	The full path name to crtend.o.
960
961_GCC_CRTENDS	The full path name to crtendS.o.
962
963_GCC_LIBGCCDIR	The directory where libgcc.a is located.
964
965
966=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
967
968The include file <bsd.inc.mk> defines the includes target and uses the
969variables:
970
971INCS		The list of include files.
972
973INCSDIR		The location to install the include files.
974
975INCSNAME	Target name of the include file, if only one; same as
976		FILESNAME, but for include files.
977
978INCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
979		are installed in the 'includes' target and not the
980		(much later) 'install' target.
981
982INCSNAME_<file>	The name file <file> should be installed as, if not <file>,
983		same as FILESNAME_<file>, but for include files.
984
985
986=-=-=-=-=   bsd.info.mk   =-=-=-=-=
987
988The include file <bsd.info.mk> is used to generate and install GNU Info
989documentation from respective Texinfo source files.  It defines three
990implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
991following variables:
992
993TEXINFO		List of Texinfo source files.  Info documentation will
994		consist of single files with the extension replaced by
995		.info.
996
997INFOFLAGS	Flags to pass to makeinfo.  []
998
999
1000=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
1001
1002The include file <bsd.kernobj.mk> defines variables related to the
1003location of kernel sources and object directories.
1004
1005KERNSRCDIR	Is the location of the top of the kernel src.
1006		[${_SRC_TOP_}/sys]
1007
1008KERNARCHDIR	Is the location of the machine dependent kernel sources.
1009		[arch/${MACHINE}]
1010
1011KERNCONFDIR	Is where the configuration files for kernels are found.
1012		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
1013
1014KERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
1015		instance will be compiled in ${KERNOBJDIR}/GENERIC.
1016		The default value is
1017		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
1018		if it exists or the target 'obj' is being made.
1019		Otherwise the default is
1020		${KERNSRCDIR}/${KERNARCHDIR}/compile.
1021
1022It is important that Makefiles (such as those under src/distrib) that
1023wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
1024rather than make assumptions about the location of the compiled kernel.
1025
1026
1027=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
1028
1029The include file <bsd.kinc.mk> defines the many targets (includes,
1030subdirectories, etc.), and is used by kernel makefiles to handle
1031include file installation.  It is intended to be included alone, by
1032kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
1033Please see <bsd.kinc.mk> for more details, and keep the documentation
1034in that file up to date.
1035
1036
1037=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
1038
1039The include file <bsd.lib.mk> has support for building libraries.  It has
1040the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
1041includes, install, lint, and tags.  Additionally, it has a checkver target
1042which checks for installed shared object libraries whose version is greater
1043that the version of the source. It has a limited number of suffixes,
1044consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
1045<bsd.shlib.mk> to get shared library parameters.
1046
1047It sets/uses the following variables:
1048
1049LIB		The name of the library to build.
1050
1051LIBDIR		Target directory for libraries.
1052
1053MKARZERO	Normally, ar(1) sets the timestamps, uid, gid and
1054		permissions in files inside its archives to those of
1055		the file it was fed. This leads to non-reproduceable
1056		builds. If MKARZERO is set to "yes" (default is "no")
1057		then the "D" flag is passed to ar, causing the
1058		timestamp, uid and gid to be zeroed and the file
1059		permissions to be set to 644. This allows .a files
1060		from different builds to be bit identical.
1061
1062SHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
1063		is not "no".
1064
1065SHLIB_MAJOR
1066SHLIB_MINOR
1067SHLIB_TEENY	Major, minor, and teeny version numbers of shared library
1068
1069USE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
1070		as the path to install shared libraries to.
1071		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
1072		Default: no
1073
1074LIBISMODULE	If not "no", install as ${LIB}.so (without the "lib" prefix),
1075		and act as "MKDEBUGLIB=no MKLINT=no MKPICINSTALL=no
1076		MKPROFILE=no MKSTATICLIB=no".
1077		Default: no
1078
1079LIBISPRIVATE	If not "no", act as "MKDEBUGLIB=no MKLINT=no MKPIC=no
1080		MKPROFILE=no", and don't install the (.a) library.
1081		This is useful for "build only" helper libraries.
1082		Default: no
1083
1084LIBISCXX	If not "no", Use ${CXX} instead of ${CC} to link
1085		shared libraries.
1086		This is useful for C++ libraries.
1087		Default: no
1088
1089LINTLIBDIR	Target directory for lint libraries.
1090
1091LIBGRP		Library group.
1092
1093LIBOWN		Library owner.
1094
1095LIBMODE		Library mode.
1096
1097LDADD		Additional loader objects.
1098
1099MAN		The manual pages to be installed (use a .1 - .9 suffix).
1100
1101NOCHECKVER_<library>
1102NOCHECKVER	If set, disables checking for installed shared object
1103		libraries with versions greater than the source.  A
1104		particular library name, without the "lib" prefix, may
1105		be appended to the variable name to disable the check for
1106		only that library.
1107
1108SRCS		List of source files to build the library.  Suffix types
1109		.s, .c, and .f are supported.  Note, .s files are preferred
1110		to .c files of the same name.  (This is not the default for
1111		versions of make.)
1112
1113LIBDPLIBS	A list of the tuples:
1114			libname  path-to-srcdir-of-libname
1115
1116		For each tuple;
1117		     *	LIBDO.libname contains the .OBJDIR of the library
1118			`libname', and if it is not set it is determined
1119			from the srcdir and added to MAKEOVERRIDES (the
1120			latter is to allow for build time optimization).
1121		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
1122		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
1123				    ${LIBDO.libname}/liblibname.a   added.
1124
1125		This variable may be used for individual libraries, as
1126		well as in parent directories to cache common libraries 
1127		as a build-time optimization.
1128
1129The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
1130if it exists, as well as the include file <bsd.man.mk>.
1131
1132It has rules for building profiled objects; profiled libraries are
1133built by default.
1134
1135Libraries are ranlib'd when made.
1136
1137
1138=-=-=-=-=   bsd.links.mk   =-=-=-=-=
1139
1140The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
1141and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
1142
1143LINKSOWN, LINKSGRP, and LINKSMODE, are relevant only if a metadata log
1144is used. The defaults may be modified by other bsd.*.mk files which
1145include bsd.links.mk.  In the future, these variables may be replaced
1146by a method for explicitly recording hard links in a metadata log.
1147
1148LINKS		The list of hard links, consisting of pairs of paths:
1149			source-file target-file
1150		${DESTDIR} is prepended to both paths before linking.
1151		For example, to link /bin/test and /bin/[, use:
1152			LINKS=/bin/test /bin/[
1153
1154CONFIGLINKS	Similar semantics to LINKS, except that the links
1155		are installed by the `configinstall' target,
1156		not the `install' target.
1157
1158SYMLINKS	The list of symbolic links, consisting of pairs of paths:
1159			source-file target-file
1160		${DESTDIR} is only prepended to target-file before linking.
1161		For example, to symlink /usr/bin/tar to /bin/tar resulting
1162		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
1163			SYMLINKS=/bin/tar /usr/bin/tar
1164
1165CONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
1166		are installed by the `configinstall' target,
1167		not the `install' target.
1168
1169LINKSOWN	Link owner.  [${BINOWN}]
1170
1171LINKSGRP	Link group.  [${BINGRP}]
1172
1173LINKSMODE	Link mode.  [${NONBINMODE}]
1174
1175LINKSOWN_<fn>	Link owner of the specific file <fn>.
1176
1177LINKSGRP_<fn>	Link group of the specific file <fn>.
1178
1179LINKSMODE_<fn>	Link mode of the specific file <fn>.
1180
1181
1182=-=-=-=-=   bsd.man.mk   =-=-=-=-=
1183
1184The include file <bsd.man.mk> handles installing manual pages and their
1185links.
1186
1187It has a three targets:
1188
1189	catinstall:
1190		Install the preformatted manual pages and their links.
1191	htmlinstall:
1192		Install the HTML manual pages and their links.
1193	maninstall:
1194		Install the manual page sources and their links.
1195
1196It sets/uses the following variables:
1197
1198MANDIR		Base path for manual installation.
1199
1200MANGRP		Manual group.
1201
1202MANOWN		Manual owner.
1203
1204MANMODE		Manual mode.
1205
1206MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
1207		or "/tahoe" for machine specific manual pages.
1208
1209MAN		The manual pages to be installed (use a .1 - .9 suffix).
1210
1211MLINKS		List of manual page links (using a .1 - .9 suffix).  The
1212		linked-to file must come first, the linked file second,
1213		and there may be multiple pairs.
1214
1215The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
1216it exists.
1217
1218
1219=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
1220
1221The include file <bsd.obj.mk> defines targets related to the creation
1222and use of separated object and source directories.
1223
1224If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
1225${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
1226it exists.  Otherwise make(1) looks for the existence of a
1227subdirectory (or a symlink to a directory) of the source directory
1228into which built targets should be placed.  If an environment variable
1229named MAKEOBJDIR is set, make(1) uses its value as the name of the
1230object directory; failing that, make first looks for a subdirectory
1231named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
1232
1233Object directories are not created automatically by make(1) if they
1234don't exist; you need to run a separate "make obj".  (This will happen
1235during a top-level build if "MKOBJDIRS" is set to a value other than
1236"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
1237and this is determined by a simple string prefix comparison -- object
1238directories are created in a separate object directory tree, and a
1239symlink to the object directory in that tree is created in the source
1240directory; otherwise, "make obj" assumes that you're not in the main
1241source tree and that it's not safe to use a separate object tree.
1242
1243Several variables used by <bsd.obj.mk> control exactly what
1244directories and links get created during a "make obj":
1245
1246MAKEOBJDIR	If set, this is the component name of the object
1247		directory.
1248
1249OBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
1250		object directories or links named "obj.${MACHINE}";
1251		otherwise, just creates ones named "obj".
1252
1253USR_OBJMACHINE  If set, and the current directory is a subdirectory of
1254		${BSDSRCDIR}, create object directory in the
1255		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
1256		otherwise, create it in the corresponding subdirectory
1257		of ${BSDOBJDIR}
1258
1259BUILDID		If set, the contents of this variable are appended
1260		to the object directory name.  If OBJMACHINE is also
1261		set, ".${BUILDID}" is added after ".${MACHINE}".
1262
1263
1264=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
1265
1266The include file <bsd.prog.mk> handles building programs from one or
1267more source files, along with their manual pages.  It has a limited number
1268of suffixes, consistent with the current needs of the BSD tree. 
1269<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
1270
1271It has eight targets:
1272
1273	all:
1274		build the program and its manual page.  This also
1275		creates a GDB initialization file (.gdbinit) in
1276		the objdir.  The .gdbinit file sets the shared library
1277		prefix to ${DESTDIR} to facilitate cross-debugging.
1278	clean:
1279		remove the program, any object files and the files a.out,
1280		Errs, errs, mklog, and ${PROG}.core.
1281	cleandir:
1282		remove all of the files removed by the target clean, as
1283		well as .depend, tags, and any manual pages.
1284		`distclean' is a synonym for `cleandir'.
1285	depend:
1286		make the dependencies for the source files, and store
1287		them in the file .depend.
1288	includes:
1289		install any header files.
1290	install:
1291		install the program and its manual pages; if the Makefile
1292		does not itself define the target install, the targets
1293		beforeinstall and afterinstall may also be used to cause
1294		actions immediately before and after the install target
1295		is executed.
1296	lint:
1297		run lint on the source files
1298	tags:
1299		create a tags file for the source files.
1300
1301It sets/uses the following variables:
1302
1303BINGRP		Binary group.
1304
1305BINOWN		Binary owner.
1306
1307BINMODE		Binary mode.
1308
1309CLEANDIRFILES	Additional files to remove for the cleandir target.
1310
1311CLEANFILES	Additional files to remove for the clean and cleandir targets.
1312
1313COPTS		Additional flags to the compiler when creating C objects.
1314
1315COPTS.<fn>	Additional flags to the compiler when creating the
1316		C objects for <fn>.
1317		For <fn>.[ly], "<fn>.c" must be used.
1318
1319CPUFLAGS	Additional flags to the compiler/assembler to select
1320		CPU instruction set options, CPU tuning options, etc.
1321
1322CPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
1323		For <fn>.[ly], "<fn>.c" must be used.
1324
1325CPPFLAGS	Additional flags to the C pre-processor.
1326
1327CPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
1328		For <fn>.[ly], "<fn>.c" must be used.
1329
1330GDBINIT		List of GDB initialization files to add to "source"
1331		directives in the .gdbinit file that is created in the
1332		objdir.
1333
1334LDADD		Additional loader objects.  Usually used for libraries.
1335		For example, to load with the compatibility and utility
1336		libraries, use:
1337
1338			LDADD+=-lutil -lcompat
1339
1340LDFLAGS		Additional linker flags (passed to ${CC} during link).
1341
1342LINKS		See <bsd.links.mk>
1343
1344OBJCOPTS	Additional flags to the compiler when creating ObjC objects.
1345
1346OBJCOPTS.<fn>	Additional flags to the compiler when creating the
1347		ObjC objects for <fn>.
1348		For <fn>.[ly], "<fn>.c" must be used.
1349
1350SYMLINKS	See <bsd.links.mk>
1351
1352MAN		Manual pages (should end in .1 - .9).  If no MAN variable is
1353		defined, "MAN=${PROG}.1" is assumed.
1354
1355PAXCTL_FLAGS	If defined, run paxctl(1) on the program binary after link
1356		time, with the value of this variable as args to paxctl(1).
1357
1358PAXCTL_FLAGS.${PROG} Custom override for PAXCTL_FLAGS.
1359
1360PROG		The name of the program to build.  If not supplied, nothing
1361		is built.
1362
1363PROG_CXX	If defined, the name of the program to build.  Also
1364		causes <bsd.prog.mk> to link the program with the C++
1365		compiler rather than the C compiler.  PROG_CXX overrides
1366		the value of PROG if PROG is also set.
1367
1368PROGNAME	The name that the above program will be installed as, if
1369		different from ${PROG}.
1370
1371SRCS		List of source files to build the program.  If SRCS is not
1372		defined, it's assumed to be ${PROG}.c.
1373
1374DPSRCS		List of source files which are needed for generating
1375		dependencies, but are not needed in ${SRCS}.
1376
1377DPADD		Additional dependencies for the program.  Usually used for
1378		libraries.  For example, to depend on the compatibility and
1379		utility libraries use:
1380
1381			DPADD+=${LIBCOMPAT} ${LIBUTIL}
1382
1383		The following system libraries are predefined for DPADD:
1384
1385		LIBARCHIVE?=	${DESTDIR}/usr/lib/libarchive.a
1386		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
1387		LIBATF_C?=	${DESTDIR}/usr/lib/libatf-c.a
1388		LIBATF_CXX?=	${DESTDIR}/usr/lib/libatf-c++.a
1389		LIBBIND9?=	${DESTDIR}/usr/lib/libbind9.a
1390		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
1391		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
1392		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
1393		LIBC?=		${DESTDIR}/usr/lib/libc.a
1394		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
1395		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
1396		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
1397		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
1398		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
1399		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
1400		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
1401		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
1402		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
1403		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
1404		LIBDNS?=	${DESTDIR}/usr/lib/libdns.a
1405		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
1406		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
1407		LIBEXPAT?=	${DESTDIR}/usr/lib/libexpat.a
1408		LIBFETCH?=	${DESTDIR}/usr/lib/libfetch.a
1409		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
1410		LIBFL?=		${DESTDIR}/usr/lib/libfl.a
1411		LIBG2C?=	${DESTDIR}/usr/lib/libg2c.a
1412		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
1413		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
1414		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
1415		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
1416		LIBHEIMBASE?=	${DESTDIR}/usr/lib/libheimbase.a
1417		LIBHEIMNTLM?=	${DESTDIR}/usr/lib/libheimntlm.a
1418		LIBHX500?=	${DESTDIR}/usr/lib/libhx500.a
1419		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
1420		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
1421		LIBISC?=	${DESTDIR}/usr/lib/libisc.a
1422		LIBISCCC?=	${DESTDIR}/usr/lib/libisccc.a
1423		LIBISCFG?=	${DESTDIR}/usr/lib/libiscfg.a
1424		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
1425		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
1426		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
1427		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
1428		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
1429		LIBL?=		${DESTDIR}/usr/lib/libl.a
1430		LIBLBER?=	${DESTDIR}/usr/lib/liblber.a
1431		LIBLDAP?=	${DESTDIR}/usr/lib/libldap.a
1432		LIBLDAP_R?=	${DESTDIR}/usr/lib/libldap_r.a
1433		LIBLUA?=	${DESTDIR}/usr/lib/liblua.a
1434		LIBLWRES?=	${DESTDIR}/usr/lib/liblwres.a
1435		LIBM?=		${DESTDIR}/usr/lib/libm.a
1436		LIBMAGIC?=	${DESTDIR}/usr/lib/libmagic.a
1437		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
1438		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
1439		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
1440		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
1441		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
1442		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
1443		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
1444		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
1445		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
1446		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
1447		LIBPUFFS?=	${DESTDIR}/usr/lib/libpuffs.a
1448		LIBQUOTA?=	${DESTDIR}/usr/lib/libquota.a
1449		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
1450		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
1451		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
1452		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
1453		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
1454		LIBRT?=		${DESTDIR}/usr/lib/librt.a
1455		LIBRUMP?=	${DESTDIR}/usr/lib/librump.a
1456		LIBRUMPFS_CD9660FS?=${DESTDIR}/usr/lib/librumpfs_cd9660fs.a
1457		LIBRUMPFS_EFS?=	${DESTDIR}/usr/lib/librumpfs_efs.a
1458		LIBRUMPFS_EXT2FS?=${DESTDIR}/usr/lib/librumpfs_ext2fs.a
1459		LIBRUMPFS_FFS?=	${DESTDIR}/usr/lib/librumpfs_ffs.a
1460		LIBRUMPFS_HFS?=	${DESTDIR}/usr/lib/librumpfs_hfs.a
1461		LIBRUMPFS_LFS?=	${DESTDIR}/usr/lib/librumpfs_lfs.a
1462		LIBRUMPFS_MSDOSFS?=${DESTDIR}/usr/lib/librumpfs_msdosfs.a
1463		LIBRUMPFS_NFS?=	${DESTDIR}/usr/lib/librumpfs_nfs.a
1464		LIBRUMPFS_NTFS?=${DESTDIR}/usr/lib/librumpfs_ntfs.a
1465		LIBRUMPFS_SYSPUFFS?=${DESTDIR}/usr/lib/librumpfs_syspuffs.a
1466		LIBRUMPFS_TMPFS?=${DESTDIR}/usr/lib/librumpfs_tmpfs.a
1467		LIBRUMPFS_UDF?=	${DESTDIR}/usr/lib/librumpfs_udf.a
1468		LIBRUMPFS_UFS?=	${DESTDIR}/usr/lib/librumpfs_ufs.a
1469		LIBRUMPUSER?=	${DESTDIR}/usr/lib/librumpuser.a
1470		LIBSASLC?=	${DESTDIR}/usr/lib/libsaslc.a
1471		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
1472		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
1473		LIBSQLITE3?=	${DESTDIR}/usr/lib/libsqlite3.a
1474		LIBSS?=		${DESTDIR}/usr/lib/libss.a
1475		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
1476		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
1477		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
1478		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
1479		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
1480		LIBTERMINFO?=	${DESTDIR}/usr/lib/libterminfo.a
1481		LIBTRE?=	${DESTDIR}/usr/lib/libtre.a
1482		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
1483		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
1484		LIBWIND?=	${DESTDIR}/usr/lib/libwind.a
1485		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
1486		LIBY?=		${DESTDIR}/usr/lib/liby.a
1487		LIBZ?=		${DESTDIR}/usr/lib/libz.a
1488
1489		The following X-Windows libraries are predefined for DPADD:
1490
1491		LIBFS?=		${DESTDIR}/usr/X11R7/lib/libFS.a
1492		LIBGL?=		${DESTDIR}/usr/X11R7/lib/libGL.a
1493		LIBGLU?=	${DESTDIR}/usr/X11R7/lib/libGLU.a
1494		LIBICE?=	${DESTDIR}/usr/X11R7/lib/libICE.a
1495		LIBSM?=		${DESTDIR}/usr/X11R7/lib/libSM.a
1496		LIBX11?=	${DESTDIR}/usr/X11R7/lib/libX11.a
1497		LIBXTRAP?=	${DESTDIR}/usr/X11R7/lib/libXTrap.a
1498		LIBXAU?=	${DESTDIR}/usr/X11R7/lib/libXau.a
1499		LIBXAW?=	${DESTDIR}/usr/X11R7/lib/libXaw.a
1500		LIBXDMCP?=	${DESTDIR}/usr/X11R7/lib/libXdmcp.a
1501		LIBXEXT?=	${DESTDIR}/usr/X11R7/lib/libXext.a
1502		LIBXFONT?=	${DESTDIR}/usr/X11R7/lib/libXfont.a
1503		LIBXFT?=	${DESTDIR}/usr/X11R7/lib/libXft.a
1504		LIBXI?=		${DESTDIR}/usr/X11R7/lib/libXi.a
1505		LIBXINERAMA?=	${DESTDIR}/usr/X11R7/lib/libXinerama.a
1506		LIBXMU?=	${DESTDIR}/usr/X11R7/lib/libXmu.a
1507		LIBXMUU?=	${DESTDIR}/usr/X11R7/lib/libXmuu.a
1508		LIBXPM?=	${DESTDIR}/usr/X11R7/lib/libXpm.a
1509		LIBXRANDR?=	${DESTDIR}/usr/X11R7/lib/libXrandr.a
1510		LIBXRENDER?=	${DESTDIR}/usr/X11R7/lib/libXrender.a
1511		LIBXSS?=	${DESTDIR}/usr/X11R7/lib/libXss.a
1512		LIBXT?=		${DESTDIR}/usr/X11R7/lib/libXt.a
1513		LIBXTST?=	${DESTDIR}/usr/X11R7/lib/libXtst.a
1514		LIBXV?=		${DESTDIR}/usr/X11R7/lib/libXv.a
1515		LIBXXF86DGA?=	${DESTDIR}/usr/X11R7/lib/libXxf86dga.a
1516		LIBXXF86MISC?=	${DESTDIR}/usr/X11R7/lib/libXxf86misc.a
1517		LIBXXF86VM?=	${DESTDIR}/usr/X11R7/lib/libXxf86vm.a
1518		LIBDPS?=	${DESTDIR}/usr/X11R7/lib/libdps.a
1519		LIBFNTSTUBS?=	${DESTDIR}/usr/X11R7/lib/libfntstubs.a
1520		LIBFONTCACHE?=	${DESTDIR}/usr/X11R7/lib/libfontcache.a
1521		LIBFONTCONFIG?=	${DESTDIR}/usr/X11R7/lib/libfontconfig.a
1522		LIBFONTENC?=	${DESTDIR}/usr/X11R7/lib/libfontenc.a
1523		LIBFREETYPE?=	${DESTDIR}/usr/X11R7/lib/libfreetype.a
1524		LIBLBXUTIL?=	${DESTDIR}/usr/X11R7/lib/liblbxutil.a
1525		LIBXKBFILE?=	${DESTDIR}/usr/X11R7/lib/libxkbfile.a
1526
1527SHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
1528		strings, using xstr(1). Note that this will not work with
1529		parallel makes.
1530
1531STRIPFLAG	The flag passed to the install program to cause the binary
1532		to be stripped.
1533
1534SUBDIR		A list of subdirectories that should be built as well.
1535		Each of the targets will execute the same target in the
1536		subdirectories.
1537
1538SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
1539		These are installed exactly like programs.
1540
1541SCRIPTSDIR	The location to install the scripts.  Each script can be
1542		installed to a separate path by setting SCRIPTSDIR_<script>.
1543
1544SCRIPTSNAME	The name that the above program will be installed as, if
1545		different from ${SCRIPTS}. These can be further specialized
1546		by setting SCRIPTSNAME_<script>.
1547
1548FILES		See description of <bsd.files.mk>.
1549
1550SHLINKDIR	Target directory for shared linker.  See description of
1551		<bsd.own.mk> for additional information about this variable.
1552
1553The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
1554if it exists, as well as the include file <bsd.man.mk>.
1555
1556Some simple examples:
1557
1558To build foo from foo.c with a manual page foo.1, use:
1559
1560	PROG=	foo
1561
1562	.include <bsd.prog.mk>
1563
1564To build foo from foo.c with a manual page foo.2, add the line:
1565
1566	MAN=	foo.2
1567
1568If foo does not have a manual page at all, add the line:
1569
1570	MKMAN=	no
1571
1572If foo has multiple source files, add the line:
1573
1574	SRCS=	a.c b.c c.c d.c
1575
1576
1577=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
1578
1579The include file <bsd.rpc.mk> contains a makefile fragment used to
1580construct source files built by rpcgen.
1581
1582The following macros may be defined in makefiles which include
1583<bsd.rpc.mk> in order to control which files get built and how they
1584are to be built:
1585
1586RPC_INCS:	construct .h file from .x file
1587RPC_XDRFILES:	construct _xdr.c from .x file
1588		(for marshalling/unmarshalling data types)
1589RPC_SVCFILES:	construct _svc.c from .x file
1590		(server-side stubs)
1591RPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
1592
1593RPC_XDIR:	Directory containing .x/.h files
1594
1595
1596=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1597
1598The include file <bsd.shlib.mk> computes parameters for shared library
1599installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1600included before <bsd.shlib.mk>.
1601
1602<bsd.own.mk> sets the following variables, if they are not already defined
1603(defaults are in brackets):
1604
1605SHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
1606		instead of ${LIBDIR} as the base path for shared library
1607		installation.  [/lib]
1608
1609SHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
1610		a program.  [/lib for programs in /bin and /sbin, /usr/lib
1611		for all others.]
1612
1613_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1614		otherwise set to ${LIBDIR}
1615
1616SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1617
1618SHLINKDIR	Path to use for shared linker when building a program.
1619		[/libexec for programs in /bin and /sbin, /usr/libexec for
1620		all others.]
1621
1622
1623=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1624
1625The include file <bsd.subdir.mk> contains the default targets for building
1626subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1627clean, cleandir, depend, includes, install, lint, and tags.  It uses the
1628following variables:
1629
1630NOSUBDIR	If this variable is defined, then the SUBDIR variable
1631		will be ignored and subdirectories will not be processed.
1632
1633SUBDIR		For all of the directories listed in ${SUBDIR}, the
1634		specified directory will be visited and the target made.
1635
1636		As a special case, the use of a token .WAIT as an
1637		entry in SUBDIR acts as a synchronization barrier
1638		when multiple make jobs are run; subdirs before the
1639		.WAIT must complete before any subdirs after .WAIT are
1640		started.  See make(1) for some caveats on use of .WAIT
1641		and other special sources.
1642
1643
1644=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1645
1646The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1647<bsd.lib.mk>.  It contains overrides that are used when building
1648the NetBSD source tree.
1649
1650The following variables control how various files are compiled/built.
1651(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1652
1653AR		Create, modify, and extract from archives.  [ar]
1654
1655ARFLAGS		Options to ${AR}.  [rl]
1656
1657AS		Assembler.  [as]
1658
1659AFLAGS		Options to ${CC} when compiling or linking .s or .S
1660		assembly source files.  []
1661
1662BUILDSEED	GCC uses random numbers when compiling C++ code.
1663		If this option is present, seed the random number
1664		generator based on the value, source file names and
1665		the output file name to make builds more deterministic.
1666		Additional information is available in the GCC
1667		documentation of -frandom-seed.
1668
1669CC		C compiler.  [cc]
1670
1671CFLAGS		Options to ${CC}.  [Usually -O or -O2]
1672
1673CPP		C Pre-Processor.  [cpp]
1674
1675CPPFLAGS	Options to ${CPP}.  []
1676
1677CPUFLAGS	Optimization flags for ${CC}.  []
1678
1679CXX		C++ compiler.  [c++]
1680
1681CXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
1682
1683ELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
1684
1685FC		Fortran compiler.  [f77]
1686
1687FFLAGS		Options to {$FC}.  [-O]
1688
1689HOST_SH		Shell.	This must be an absolute path, because it may be
1690		substituted into "#!" lines in scripts.	 [/bin/sh]
1691
1692INSTALL		install(1) command.  [install]
1693
1694LEX		Lexical analyzer.  [lex]
1695
1696LFLAGS		Options to ${LEX}.  []
1697
1698LPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
1699
1700LD		Linker.  [ld]
1701
1702LDFLAGS		Options to ${CC} during the link process.  []
1703
1704LINT		C program verifier.  [lint]
1705
1706LINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
1707
1708LORDER		List dependencies for object files.  [lorder]
1709
1710MAKE		make(1).  [make]
1711
1712MKDEP		Construct Makefile dependency list.  [mkdep]
1713
1714NM		List symbols from object files.  [nm]
1715
1716PC		Pascal compiler.  [pc]  (Not present)
1717
1718PFLAGS		Options to ${PC}.  []
1719
1720OBJC		Objective C compiler.  [${CC}]
1721
1722OBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
1723
1724OBJCOPY		Copy and translate object files.  [objcopy]
1725
1726OBJCOPYLIBFLAGS	Flags to pass to objcopy when library objects are
1727		being built. [${.TARGET} =~ "*.po" ? -X : -x]
1728
1729OBJDUMP		Display information from object files.  [objdump]
1730
1731RANLIB		Generate index to archive.  [ranlib]
1732
1733SIZE		List section sizes and total size.  [size]
1734
1735STRIP		Discard symbols from object files.  [strip]
1736
1737TSORT		Topological sort of a directed graph.  [tsort -q]
1738
1739YACC		LALR(1) parser generator.  [yacc]
1740
1741YFLAGS		Options to ${YACC}.  []
1742
1743YHEADER		If defined, add "-d" to YFLAGS, and add dependencies
1744		from <file>.y to <file>.h and <file>.c, and add
1745		<foo>.h to CLEANFILES.
1746
1747YPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
1748
1749
1750Other variables of note (incomplete list):
1751
1752NOGCCERROR	If defined, prevents passing certain ${CFLAGS} to GCC
1753		that cause warnings to be fatal, such as:
1754			-Werror -Wa,--fatal-warnings
1755		(The latter being for as(1).)
1756
1757NOCLANGERROR	If defined and clang is used as C compiler, -Werror is not
1758		passed to it.
1759
1760WARNS		Crank up GCC warning options; the distinct levels are:
1761			WARNS=1
1762			WARNS=2
1763			WARNS=3
1764			WARNS=4
1765
1766=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
1767
1768The include file <bsd.x11.mk> contains parameters and targets for
1769cross-building X11 from ${X11SRCDIR.xc} / ${X11MITSRCDIR.*}.
1770It should be included after the general Makefile contents but before
1771the include files such as <bsd.prog.mk> and <bsd.lib.mk>.
1772
1773It provides the following targets:
1774	.man.1 .man.3 .man.4 .man.5 .man.7:
1775		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1776		these rules convert from X11's manual page source
1777		into an mdoc.old source file.
1778
1779It sets the following variables:
1780
1781BINDIR			Set to ${X11BINDIR}.
1782			To override, define after including <bsd.x11.mk>
1783
1784LIBDIR			Set to ${X11USRLIBDIR}.
1785			To override, define after including <bsd.x11.mk>
1786
1787MANDIR			Set to ${X11MANDIR}.
1788			To override, define after including <bsd.x11.mk>
1789
1790CPPFLAGS		Appended with definitions to include from
1791			${DESTDIR}${X11INCDIR}
1792
1793LDFLAGS			Appended with definitions to link from
1794			${DESTDIR}${X11USRLIBDIR}
1795
1796X11FLAGS.CONNECTION	Equivalent to X11's CONNECTION_FLAGS.
1797
1798X11FLAGS.EXTENSION	Equivalent to X11's EXT_DEFINES.
1799
1800X11FLAGS.LOADABLE	Equivalent to X11's LOADABLE.
1801
1802X11FLAGS.OS_DEFINES	Equivalent to X11's OS_DEFINES.
1803
1804X11FLAGS.SERVER		Equivalent to X11's ServerDefines.
1805
1806X11FLAGS.THREADLIB	Equivalent to X11's THREADS_DEFINES for libraries.
1807
1808X11FLAGS.THREADS	Equivalent to X11's THREADS_DEFINES.
1809
1810X11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
1811
1812X11FLAGS.DIX		Equivalent to X11's DIX_DEFINES.
1813
1814X11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
1815
1816It uses the following variables:
1817
1818APPDEFS			List of app-default files to install.
1819
1820CPPSCRIPTS		List of files/scripts to run through cpp(1)
1821			and then ${X11TOOL_UNXCOMM}.  The source files
1822			have a `.cpp' suffix, the generated files do not.
1823
1824CPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
1825
1826CPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
1827
1828
1829=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1830