bsd.README revision 1.149
1#	$NetBSD: bsd.README,v 1.149 2004/03/18 03:26:55 jmc Exp $
2#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
3
4This is the README file for the new make "include" files for the BSD
5source tree.  The files are installed in /usr/share/mk, and are, by
6convention, named with the suffix ".mk".
7
8Note, this file is not intended to replace reading through the .mk
9files for anything tricky.
10
11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
12
13RANDOM THINGS WORTH KNOWING:
14
15The files are simply C-style #include files, and pretty much behave like
16you'd expect.  The syntax is slightly different in that a single '.' is
17used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
18
19One difference that will save you lots of debugging time is that inclusion
20of the file is normally done at the *end* of the Makefile.  The reason for
21this is because .mk files often modify variables and behavior based on the
22values of variables set in the Makefile.  To make this work, remember that
23the FIRST target found is the target that is used, i.e. if the Makefile has:
24
25	a:
26		echo a
27	a:
28		echo a number two
29
30the command "make a" will echo "a".  To make things confusing, the SECOND
31variable assignment is the overriding one, i.e. if the Makefile has:
32
33	a=	foo
34	a=	bar
35
36	b:
37		echo ${a}
38
39the command "make b" will echo "bar".  This is for compatibility with the
40way the V7 make behaved.
41
42It's fairly difficult to make the BSD .mk files work when you're building
43multiple programs in a single directory.  It's a lot easier 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 ".so" 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
69MKxxx		Can be set to "no" to disable functionality, or
70		"yes" to enable it.
71		Usually defaults to "yes", although some variables
72		default to "no".
73		Due to make(1) implementation issues, if a temporary
74		command-line override of a mk.conf or <bsd.own.mk>
75		setting is required whilst still honouring a particular
76		Makefile's setting of MKxxx, use
77			env MKxxx=value make
78		instead of
79			make MKxxx=value
80
81NOxxx		If defined, disables a feature.
82		Not intended for users.
83		This is to allow Makefiles to disable functionality
84		that they don't support (such as missing man pages).
85		NOxxx variables must be defined before <bsd.own.mk>
86		is included.
87
88The following variables that control how things are made/installed that
89are not set by default. These should not be set by Makefiles; they're for
90the user to define in MAKECONF (see <bsd.own.mk>, below) or on the make(1)
91command line:
92
93BUILD 		If defined, 'make install' checks that the targets in the
94		source directories are up-to-date and remakes them if they
95                are out of date, instead of blindly trying to install
96                out of date or non-existent targets.
97
98MAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
99		Default: 2
100		Supported values:
101		    0	Minimal output ("quiet")
102		    1	Describe what is occurring
103		    2	Describe what is occurring and echo the actual command
104
105
106MKBFD		If "no", don't build libbfd, libiberty, or any of the things
107		that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage).
108		Default: yes
109
110MKCATPAGES	If "no", don't build or install the catman pages.
111		Default: yes
112
113MKCRYPTO	If "no", no cryptography support will be built into the system,
114		and also acts as "MKKERBEROS=no MKKERBEROS4=no".
115		Default: yes
116
117MKCRYPTO_IDEA	If not "no", IDEA support will be built into libcrypto_idea.a.
118		Default: no
119
120MKCRYPTO_MDC2	If not "no", MDC2 support will be built into libcrypto_mdc2.a
121		Default: no
122
123MKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
124		Default: no
125
126MKCVS		If "no", don't build or install cvs(1).
127		Default: yes
128
129MKDOC		If "no", don't build or install the documentation.
130		Default: yes
131
132MKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
133		don't install certain libraries in /lib, and don't
134		install the shared linker into /libexec.
135		Default: yes
136
137MKGCC		If "no", don't build gcc(1) or any of the gcc-related
138		libraries (libg2c, libgcc, libobjc, libstdc++).
139		Default: yes
140
141MKGCCCMDS	If "no", don't build gcc(1).
142		Default: yes
143
144MKGDB		If "no", don't build gdb(1).
145		Default: yes
146
147MKHESIOD	If "no", disables building of Hesiod infrastructure
148		(libraries and support programs).
149		Default: yes
150
151MKHOSTOBJ	If not "no", for programs intended to be run on the compile
152		host, the name, release, and architecture of the host
153		operating system will be suffixed to the name of the object
154		directory created by "make obj".
155		Default: no
156
157MKHTML		If "no", don't build or install the html man pages.
158		Default: yes
159
160MKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
161		Has no effect on most platforms.
162		Default: yes
163
164MKINFO		If "no", don't build or install Info documentation from
165		Texinfo source files.
166		Default: yes
167
168MKKERBEROS4	If "no", disables building of Kerberos v4
169		infrastructure (libraries and support programs).
170		Default: yes
171
172MKKERBEROS	If "no", disables building of Kerberos v5
173		infrastructure (libraries and support programs).
174		Default: yes
175
176MKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
177		Also:
178			- don't install the .a libraries
179			- don't install _pic.a libraries on PIC systems
180			- don't build .a libraries on PIC systems
181			- don't install the .so symlink on ELF systems
182		I.e, only install the shared library (and the .so.major
183		symlink on ELF).
184		Default: yes
185
186MKLINT		If "no", don't build or install the lint libraries.
187		Default: yes
188
189MKMAN		If "no", don't build or install the man or catman pages,
190		and also acts as "MKCATPAGES=no MKHTML=no".
191		Default: yes
192
193MKMANZ		If not "no", compress manual pages at installation time.
194		Default: no
195
196MKNLS		If "no", don't build or install the NLS files and locale
197		definition files.
198		Default: yes
199
200MKOBJ		If "no", don't enable the rule which creates objdirs,
201		and also acts as "MKOBJDIRS=no".
202		Default: yes
203
204MKOBJDIRS	If "no", don't create objdirs during a "make build".
205		Default: no
206
207MKPIC		If "no", don't build or install shared libraries, and
208		also acts as "MKPICLIB=no"
209		Default: yes (for MACHINE_ARCHs that support it) 
210
211MKPICINSTALL	If "no", don't install the *_pic.a libraries.
212		Default: yes
213
214MKPICLIB	If "no", don't build *_pic.a libraries, and build the
215		shared object libraries from the .a libraries.
216		A symlink is installed in ${DESTDIR}/usr/lib for the
217		_pic.a library pointing to the .a library.
218		Default: yes
219
220MKPOSTFIX	If "no", don't build or install postfix(1).
221		Default: yes
222
223MKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
224		Default: yes
225
226MKSENDMAIL	If "no", don't build or install sendmail(8).
227		Default: yes
228
229MKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
230		MKMAN=no MKNLS=no".
231		I.e, don't build catman pages, documentation, Info
232		documentation, man pages, NLS files, ...
233		Default: yes
234
235MKSKEY		If "no", disables building of S/key authentication
236		infrastructure (libraries and support programs).
237		Default: yes
238
239MKSOFTFLOAT	If not "no", build with options to enable the compiler to
240		generate output containing library calls for floating
241		point and possibly soft-float library support.
242		Default: no
243
244MKSTATICLIB	If "no", don't build or install the normal static (*.a)
245		libraries.
246		Default: yes
247
248MKUNPRIVED	If not "no", don't set the owner/group/mode when installing
249		files or directories, and keep a metadata log of what
250		the owner/group/mode should be.  This allows a
251		non-root "make install".
252		Default: no
253
254MKUPDATE 	If not "no", 'make install' only installs targets that are
255		more recently modified in the source directories that their
256		installed counterparts.
257		Default: no
258
259MKUUCP		If "no", don't build or install uucp(1).
260		Default: yes
261
262MKX11		If not "no", 'make build' also descends into src/x11
263		to cross build X11R6 and automatically enables creation
264		of X sets.
265		Default: no
266
267MKYP		If "no", disables building of YP (NIS)
268		infrastructure (libraries and support programs).
269		Default: yes
270
271USE_HESIOD	If "no", disables building Hesiod support into
272		various system utilities/libraries that support it.
273		If ${MKHESIOD} is "no", USE_HESIOD will also be
274		forced to "no".
275
276USE_KERBEROS4	If "no", disables building Kerberos v4
277		support into various system utilities/libraries that
278		support it.  If ${MKKERBEROS4} is "no", USE_KERBEROS4
279		will also be forced to "no".
280
281USE_KERBEROS	If "no", disables building Kerberos v4 or v5)
282		support into various system utilities/libraries that
283		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
284		will also be forced to "no".
285
286USE_SKEY	If "no", disables building S/key authentication
287		support into various system utilities/libraries that
288		support it.  If ${MKSKEY} is "no", USE_SKEY will
289		also be forced to "no".
290
291USE_YP		If "no", disables building YP (NIS) support into
292		various system utilities/libraries that support it.
293		If ${MKYP} is "no", USE_YP will also be forced to "no".
294
295COPTS.lib<lib>
296LDADD.lib<lib>
297CPPFLAGS.lib<lib>
298CXXFLAGS.lib<lib>
299COPTS.<prog>
300LDADD.<prog>
301CPPFLAGS.<prog>
302CXXFLAGS.<prog>	These provide a way to specify additions to the associated
303		variables in a way that applies only to a particular library
304		or program.  <lib> corresponds to the LIB variable set in
305		the library's makefile.  <prog> corresponds to either PROG
306		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
307		set to "-g", "-g" will be added to COPTS only when compiling
308		the crypto library.
309
310=-=-=-=-=   sys.mk   =-=-=-=-=
311
312The include file <sys.mk> has the default rules for all makes, in the BSD
313environment or otherwise.  You probably don't want to touch this file.
314
315=-=-=-=-=   bsd.own.mk   =-=-=-=-=
316
317The include file <bsd.own.mk> contains source tree configuration parameters,
318such as the owners, groups, etc. for both manual pages and binaries, and
319a few global "feature configuration" parameters.
320
321It has no targets.
322
323To get system-specific configuration parameters, <bsd.own.mk> will try to
324include the file specified by the "MAKECONF" variable.  If MAKECONF is not
325set, or no such file exists, the system make configuration file, /etc/mk.conf
326is included.  These files may define any of the variables described below.
327
328<bsd.own.mk> sets the following variables, if they are not already defined
329(defaults are in brackets):
330
331NETBSDSRCDIR	Top of the NetBSD source tree.
332		If _SRC_TOP_ != "", that will be used as the default,
333		otherwise BSDSRCDIR will be used as the default.
334		Various makefiles within the NetBSD source tree will
335		use this to reference the top level of the source tree.
336
337_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
338		based on the presence of tools/ and build.sh.  This variable
339		is "internal" to <bsd.own.mk>, although its value is only
340		determined once and then propagated to all sub-makes.
341
342BSDSRCDIR	The real path to the system sources, so that 'make obj'
343		will work correctly.  [/usr/src]
344
345BSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
346		will work correctly.  [/usr/obj]
347
348BINGRP		Binary group.  [wheel]
349
350BINOWN		Binary owner.  [root]
351
352BINMODE		Binary mode.  [555]
353
354NONBINMODE	Mode for non-executable files.  [444]
355
356MANDIR		Base path for manual installation.  [/usr/share/man/cat]
357
358MANGRP		Manual group.  [wheel]
359
360MANOWN		Manual owner.  [root]
361
362MANMODE		Manual mode.  [${NONBINMODE}]
363
364MANINSTALL	Manual installation type: maninstall, catinstall, or both
365
366LDSTATIC	Control program linking; if set blank, link everything
367		dynamically.  If set to "-static", link everything statically.
368		If not set, programs link according to their makefile.
369
370LIBDIR		Base path for library installation.  [/usr/lib]
371
372LINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
373
374LIBGRP		Library group.  [${BINGRP}]
375
376LIBOWN		Library owner.  [${BINOWN}]
377
378LIBMODE		Library mode.  [${NONBINMODE}]
379
380DOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
381	        installation.  [/usr/share/doc]
382
383HTMLDOCDIR	Base path for html system documentation installation.
384		[/usr/share/doc/html]
385
386DOCGRP		Documentation group.  [wheel]
387
388DOCOWN		Documentation owner.  [root]
389
390DOCMODE		Documentation mode.  [${NONBINMODE}]
391
392NLSDIR		Base path for Native Language Support files installation.
393		[/usr/share/nls]
394
395NLSGRP		Native Language Support files group.  [wheel]
396
397NLSOWN		Native Language Support files owner.  [root]
398
399NLSMODE		Native Language Support files mode.  [${NONBINMODE}]
400
401X11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
402
403X11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
404
405X11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
406
407X11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
408
409X11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
410
411X11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
412
413X11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
414
415X11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
416
417X11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
418
419X11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
420
421STRIPFLAG	The flag passed to the install program to cause the binary
422		to be stripped.  This is to be used when building your
423		own install script so that the entire system can be made
424		stripped/not-stripped using a single knob.  []
425
426COPY		The flag passed to the install program to cause the binary
427		to be copied rather than moved.  This is to be used when
428		building our own install script so that the entire system
429		can either be installed with copies, or with moves using
430		a single knob.  [-c]
431
432Additionally, the following variables may be set by <bsd.own.mk> or in a
433make configuration file to modify the behaviour of the system build
434process (default values are in brackets along with comments, if set by
435<bsd.own.mk>):
436
437USETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
438		be used as part of a build in progress.
439		Supported values:
440
441		yes	Use the tools from TOOLDIR.
442			Must be set to this if cross-compiling.
443
444		no	Do not use the tools from TOOLDIR, but refuse to
445			build native compilation tool components that are
446			version-specific for that tool.
447
448		never	Do not use the tools from TOOLDIR, even when
449			building native tool components.  This is similar to
450			the traditional NetBSD build method, but does not
451			verify that the compilation tools in use are
452			up-to-date enough in order to build the tree
453			successfully.  This may cause build or runtime
454			problems when building the whole NetBSD source tree.
455
456		Default: "yes" if building all or part of a whole NetBSD
457		source tree (detected automatically); "no" otherwise
458		(to preserve traditional semantics of the <bsd.*.mk>
459		make(1) include files).
460
461OBJECT_FMT	Object file format.  [set to "ELF" on architectures that
462		use ELF -- currently if ${MACHINE_ARCH} is "alpha",
463		"mipsel", "mipseb", "powerpc", "sparc", "sparc64",
464		"i386" and some m68k machines, or set to "a.out" on
465		other architectures].
466
467TOOLCHAIN_MISSING
468		If not "no", this indicates that the platform being built
469		does not have a working in-tree toolchain.  If the
470		${MACHINE_ARCH} in question falls into this category,
471		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
472		Otherwise, the variable is unconditionally assigned the
473		value "no".
474		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
475		unconditionally assigned the value "no".
476
477EXTERNAL_TOOLCHAIN
478		This variable is not directly set by <bsd.own.mk>, but
479		including <bsd.own.mk> is the canonical way to gain
480		access to this variable.  The variable should be defined
481		either in the user's environment or in the user's mk.conf
482		file.  If defined, this variable indicates the root of
483		an external toolchain which will be used to build the
484		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
485		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
486		cross-compile framework.
487
488		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
489		assigned the value "no", since the external version of the
490		compiler may not be able to build the library components of
491		the in-tree compiler.
492
493		NOTE: This variable is not yet used in as many places as
494		it should be.  Expect the exact semantics of this variable
495		to change in the short term as parts of the cross-compile
496		framework continue to be cleaned up.
497
498<bsd.own.mk> is generally useful when building your own Makefiles so that
499they use the same default owners etc. as the rest of the tree.
500
501
502=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
503
504The include file <bsd.dep.mk> contains the default targets for building
505.depend files.  It creates .d files from entries in SRCS and DPSRCS
506that are C, C++, or Objective C source files, and builds .depend from the
507.d files.  All other files in SRCS and all of DPSRCS will be used as
508dependencies for the .d files.  In order for this to function correctly,
509it should be .included after all other .mk files and directives that may
510modify SRCS or DPSRCS.  It uses the following variables:
511
512SRCS		List of source files to build the program.
513
514DPSRCS		List of source files which are needed for generating
515		dependencies, but are not needed in ${SRCS}.
516
517
518=-=-=-=-=   bsd.files.mk   =-=-=-=-=
519
520The include file <bsd.files.mk> handles the FILES variables and is included
521from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
522
523FILES		The list of files to install.
524
525FILESOWN	File owner.  [${BINOWN}]
526
527FILESGRP	File group.  [${BINGRP}]
528
529FILESMODE	File mode.  [${BINMODE}]
530
531FILESDIR	The location to install the files.
532
533FILESNAME	Optional name to install each file as.
534
535FILESDIR.<fn>	The location to install the specific file <fn>.
536
537FILESNAME.<fn>	Optional name to install <fn> as.
538
539BUILDSYMLINKS	List of two word items:
540			lnsrc lntgt
541		For each lnsrc item, create a symlink named lntgt.
542		The lntgt symlinks are removed by the cleandir target.
543
544UUDECODE_FILES	List of files which are stored as <file>.uue in the source
545		tree. Each one will be decoded with ${TOOL_UUDECODE}.
546		The source files have a `.uue' suffix, the generated files do 
547		not.
548
549UUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
550		
551		*NOTE: These files are simply decoded, with no install or other
552		       rule applying implicitly except being added to the clean
553		       target.
554
555=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
556
557The include file <bsd.gcc.mk> computes various parameters related to GCC
558support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
559before <bsd.gcc.mk>.
560
561The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
562of which need to know where to find certain GCC support libraries.
563
564The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
565which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
566the compiler is asked where to find the support libraries, otherwise the
567support libraries are found in ${DESTDIR}/usr/lib.
568
569<bsd.gcc.mk> sets the following variables:
570
571_GCC_CRTBEGIN	The full path name to crtbegin.o.
572
573_GCC_CRTBEGINS	The full path name to crtbeginS.o.
574
575_GCC_CRTEND	The full path name to crtend.o.
576
577_GCC_CRTENDS	The full path name to crtendS.o.
578
579_GCC_LIBGCCDIR	The directory where libgcc.a is located.
580
581
582=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
583
584The include file <bsd.inc.mk> defines the includes target and uses the
585variables:
586
587INCS		The list of include files.
588
589INCSDIR		The location to install the include files.
590
591INCSNAME	Target name of the include file, if only one; same as
592		FILESNAME, but for include files.
593
594INCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
595		are installed in the 'includes' target and not the
596		(much later) 'install' target.
597
598INCSNAME_<file>	The name file <file> should be installed as, if not <file>,
599		same as FILESNAME_<file>, but for include files.
600
601
602=-=-=-=-=   bsd.info.mk   =-=-=-=-=
603
604The include file <bsd.info.mk> is used to generate and install GNU Info
605documentation from respective Texinfo source files.  It defines three
606implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
607following variables:
608
609TEXINFO		List of Texinfo source files.  Info documentation will
610		consist of single files with the extension replaced by
611		.info.
612
613INFOFLAGS	Flags to pass to makeinfo.  []
614
615
616=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
617
618The include file <bsd.kernobj.mk> defines variables related to the
619location of kernel sources and object directories.
620
621KERNSRCDIR	Is the location of the top of the kernel src.
622		[${_SRC_TOP_}/sys]
623
624KERNARCHDIR	Is the location of the machine dependent kernel sources.
625		[arch/${MACHINE}]
626
627KERNCONFDIR	Is where the configuration files for kernels are found.
628		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
629
630KERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
631		instance will be compiled in ${KERNOBJDIR}/GENERIC.
632		The default value is
633		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
634		if it exists or the target 'obj' is being made.
635		Otherwise the default is
636		${KERNSRCDIR}/${KERNARCHDIR}/compile.
637
638It is important that Makefiles (such as those under src/distrib) that
639wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
640rather than make assumptions about the location of the compiled kernel.
641
642
643=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
644
645The include file <bsd.kinc.mk> defines the many targets (includes,
646subdirectories, etc.), and is used by kernel makefiles to handle
647include file installation.  It is intended to be included alone, by
648kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
649Please see <bsd.kinc.mk> for more details, and keep the documentation
650in that file up to date.
651
652
653=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
654
655The include file <bsd.lib.mk> has support for building libraries.  It has
656the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
657includes, install, lint, and tags.  Additionally, it has a checkver target
658which checks for installed shared object libraries whose version is greater
659that the version of the source. It has a limited number of suffixes,
660consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
661<bsd.shlib.mk> to get shared library parameters.
662
663It sets/uses the following variables:
664
665LIB		The name of the library to build.
666
667LIBDIR		Target directory for libraries.
668
669SHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
670		is not "no".
671
672USE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
673		as the path to install shared libraries to.
674		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
675		Default: no
676
677LINTLIBDIR	Target directory for lint libraries.
678
679LIBGRP		Library group.
680
681LIBOWN		Library owner.
682
683LIBMODE		Library mode.
684
685LDADD		Additional loader objects.
686
687MAN		The manual pages to be installed (use a .1 - .9 suffix).
688
689NOCHECKVER_<library>
690NOCHECKVER	If set, disables checking for installed shared object
691		libraries with versions greater than the source.  A
692		particular library name, without the "lib" prefix, may
693		be appended to the variable name to disable the check for
694		only that library.
695
696SRCS		List of source files to build the library.  Suffix types
697		.s, .c, and .f are supported.  Note, .s files are preferred
698		to .c files of the same name.  (This is not the default for
699		versions of make.)
700
701The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
702if it exists, as well as the include file <bsd.man.mk>.
703
704It has rules for building profiled objects; profiled libraries are
705built by default.
706
707Libraries are ranlib'd when made.
708
709
710=-=-=-=-=   bsd.links.mk   =-=-=-=-=
711
712The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
713and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
714
715LINKS		The list of hard links, consisting of pairs of paths:
716			source-file target-file
717		${DESTDIR} is prepended to both paths before linking.
718		For example, to link /bin/test and /bin/[, use:
719			LINKS=/bin/test /bin/[
720
721SYMLINKS	The list of symbolic links, consisting of pairs of paths:
722			source-file target-file
723		${DESTDIR} is only prepended to target-file before linking.
724		For example, to symlink /usr/bin/tar to /bin/tar resulting
725		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
726			SYMLINKS=/bin/tar /usr/bin/tar
727
728
729=-=-=-=-=   bsd.man.mk   =-=-=-=-=
730
731The include file <bsd.man.mk> handles installing manual pages and their
732links.
733
734It has a two targets:
735
736	maninstall:
737		Install the manual page sources and their links.
738	catinstall:
739		Install the preformatted manual pages and their links.
740
741It sets/uses the following variables:
742
743MANDIR		Base path for manual installation.
744
745MANGRP		Manual group.
746
747MANOWN		Manual owner.
748
749MANMODE		Manual mode.
750
751MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
752		or "/tahoe" for machine specific manual pages.
753
754MAN		The manual pages to be installed (use a .1 - .9 suffix).
755
756MLINKS		List of manual page links (using a .1 - .9 suffix).  The
757		linked-to file must come first, the linked file second,
758		and there may be multiple pairs.  The files are soft-linked.
759
760The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
761it exists.
762
763
764=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
765
766The include file <bsd.obj.mk> defines targets related to the creation
767and use of separated object and source directories.
768
769If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
770${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
771it exists.  Otherwise make(1) looks for the existence of a
772subdirectory (or a symlink to a directory) of the source directory
773into which built targets should be placed.  If an environment variable
774named MAKEOBJDIR is set, make(1) uses its value as the name of the
775object directory; failing that, make first looks for a subdirectory
776named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
777
778Object directories are not created automatically by make(1) if they
779don't exist; you need to run a separate "make obj".  (This will happen
780during a top-level build if "MKOBJDIRS" is set to a value other than
781"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
782and this is determined by a simple string prefix comparison -- object
783directories are created in a separate object directory tree, and a
784symlink to the object directory in that tree is created in the source
785directory; otherwise, "make obj" assumes that you're not in the main
786source tree and that it's not safe to use a separate object tree.
787
788Several variables used by <bsd.obj.mk> control exactly what
789directories and links get created during a "make obj":
790
791MAKEOBJDIR	If set, this is the component name of the object
792		directory.
793
794OBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
795		object directories or links named "obj.${MACHINE}";
796		otherwise, just creates ones named "obj".
797
798USR_OBJMACHINE  If set, and the current directory is a subdirectory of
799		${BSDSRCDIR}, create object directory in the
800		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
801		otherwise, create it in the corresponding subdirectory
802		of ${BSDOBJDIR}
803
804BUILDID		If set, the contents of this variable are appended
805		to the object directory name.  If OBJMACHINE is also
806		set, ".${BUILDID}" is added after ".${MACHINE}".
807
808
809=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
810
811The include file <bsd.prog.mk> handles building programs from one or
812more source files, along with their manual pages.  It has a limited number
813of suffixes, consistent with the current needs of the BSD tree. 
814<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
815
816It has eight targets:
817
818	all:
819		build the program and its manual page.  This also
820		creates a GDB initialization file (.gdbinit) in
821		the objdir.  The .gdbinit file sets the shared library
822		prefix to ${DESTDIR} to facilitate cross-debugging.
823	clean:
824		remove the program, any object files and the files a.out,
825		Errs, errs, mklog, and ${PROG}.core.
826	cleandir:
827		remove all of the files removed by the target clean, as
828		well as .depend, tags, and any manual pages.
829		`distclean' is a synonym for `cleandir'.
830	depend:
831		make the dependencies for the source files, and store
832		them in the file .depend.
833	includes:
834		install any header files.
835	install:
836		install the program and its manual pages; if the Makefile
837		does not itself define the target install, the targets
838		beforeinstall and afterinstall may also be used to cause
839		actions immediately before and after the install target
840		is executed.
841	lint:
842		run lint on the source files
843	tags:
844		create a tags file for the source files.
845
846It sets/uses the following variables:
847
848BINGRP		Binary group.
849
850BINOWN		Binary owner.
851
852BINMODE		Binary mode.
853
854CLEANFILES	Additional files to remove for the clean and cleandir targets.
855
856COPTS		Additional flags to the compiler when creating C objects.
857
858COPTS.<fn>	Additional flags to the compiler when creating the
859		C objects for <fn>.
860		For <fn>.[ly], "<fn>.c" must be used.
861
862CPUFLAGS	Additional flags to the compiler/assembler to select
863		CPU instruction set options, CPU tuning options, etc.
864
865CPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
866		For <fn>.[ly], "<fn>.c" must be used.
867
868CPPFLAGS	Additional flags to the C pre-processor.
869
870CPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
871		For <fn>.[ly], "<fn>.c" must be used.
872
873GDBINIT		List of GDB initialization files to add to "source"
874		directives in the .gdbinit file that is created in the
875		objdir.
876
877LDADD		Additional loader objects.  Usually used for libraries.
878		For example, to load with the compatibility and utility
879		libraries, use:
880
881			LDADD+=-lutil -lcompat
882
883LDFLAGS		Additional loader flags.
884
885LINKS		See <bsd.links.mk>
886
887SYMLINKS	See <bsd.links.mk>
888
889MAN		Manual pages (should end in .1 - .9).  If no MAN variable is
890		defined, "MAN=${PROG}.1" is assumed.
891
892PROG		The name of the program to build.  If not supplied, nothing
893		is built.
894
895PROG_CXX	If defined, the name of the program to build.  Also
896		causes <bsd.prog.mk> to link the program with the C++
897		compiler rather than the C compiler.  PROG_CXX overrides
898		the value of PROG if PROG is also set.
899
900PROGNAME	The name that the above program will be installed as, if
901		different from ${PROG}.
902
903SRCS		List of source files to build the program.  If SRCS is not
904		defined, it's assumed to be ${PROG}.c.
905
906DPSRCS		List of source files which are needed for generating
907		dependencies, but are not needed in ${SRCS}.
908
909DPADD		Additional dependencies for the program.  Usually used for
910		libraries.  For example, to depend on the compatibility and
911		utility libraries use:
912
913			DPADD+=${LIBCOMPAT} ${LIBUTIL}
914
915		The following libraries are predefined for DPADD:
916
917		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
918		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
919		LIBC?=		${DESTDIR}/usr/lib/libc.a
920		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
921		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
922		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
923		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
924		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
925		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
926		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
927		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
928		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
929		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
930		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
931		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
932		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
933		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
934		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
935		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
936		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
937		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
938		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
939		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
940		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
941		LIBKADM?=	${DESTDIR}/usr/lib/libkadm.a
942		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
943		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
944		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
945		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
946		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
947		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
948		LIBKSTREAM?=	${DESTDIR}/usr/lib/libkstream.a
949		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
950		LIBL?=		${DESTDIR}/usr/lib/libl.a
951		LIBM?=		${DESTDIR}/usr/lib/libm.a
952		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
953		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
954		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
955		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
956		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
957		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
958		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
959		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
960		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
961		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
962		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
963		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
964		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
965		LIBRT?=		${DESTDIR}/usr/lib/librt.a
966		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
967		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
968		LIBSS?=		${DESTDIR}/usr/lib/libss.a
969		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
970		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
971		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
972		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
973		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
974		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
975		LIBY?=		${DESTDIR}/usr/lib/liby.a
976		LIBZ?=		${DESTDIR}/usr/lib/libz.a
977
978SHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
979		strings, using xstr(1). Note that this will not work with
980		parallel makes.
981
982STRIPFLAG	The flag passed to the install program to cause the binary
983		to be stripped.
984
985SUBDIR		A list of subdirectories that should be built as well.
986		Each of the targets will execute the same target in the
987		subdirectories.
988
989SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
990		These are installed exactly like programs.
991
992SCRIPTSNAME	The name that the above program will be installed as, if
993		different from ${SCRIPTS}. These can be further specialized
994		by setting SCRIPTSNAME_<script>.
995
996FILES		See description of <bsd.files.mk>.
997
998SHLINKDIR	Target directory for shared linker.  See description of
999		<bsd.own.mk> for additional information about this variable.
1000
1001USE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
1002		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
1003		Default: yes
1004
1005The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
1006if it exists, as well as the include file <bsd.man.mk>.
1007
1008Some simple examples:
1009
1010To build foo from foo.c with a manual page foo.1, use:
1011
1012	PROG=	foo
1013
1014	.include <bsd.prog.mk>
1015
1016To build foo from foo.c with a manual page foo.2, add the line:
1017
1018	MAN=	foo.2
1019
1020If foo does not have a manual page at all, add the line:
1021
1022	MKMAN=	no
1023
1024If foo has multiple source files, add the line:
1025
1026	SRCS=	a.c b.c c.c d.c
1027
1028
1029=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
1030
1031The include file <bsd.rpc.mk> contains a makefile fragment used to
1032construct source files built by rpcgen.
1033
1034The following macros may be defined in makefiles which include
1035<bsd.rpc.mk> in order to control which files get built and how they
1036are to be built:
1037
1038RPC_INCS:	construct .h file from .x file
1039RPC_XDRFILES:	construct _xdr.c from .x file
1040		(for marshalling/unmarshalling data types)
1041RPC_SVCFILES:	construct _svc.c from .x file
1042		(server-side stubs)
1043RPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
1044
1045RPC_XDIR:	Directory containing .x/.h files
1046
1047
1048=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1049
1050The include file <bsd.shlib.mk> computes parameters for shared library
1051installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1052included before <bsd.shlib.mk>.
1053
1054<bsd.own.mk> sets the following variables, if they are not already defined
1055(defaults are in brackets):
1056
1057SHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
1058		instead of ${LIBDIR} as the base path for shared library
1059		installation.  [/lib]
1060
1061SHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
1062		a program.  [/lib for programs in /bin and /sbin, /usr/lib
1063		for all others.]
1064
1065_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1066		otherwise set to ${LIBDIR}
1067
1068SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1069
1070SHLINKDIR	Path to use for shared linker when building a program.
1071		[/libexec for programs in /bin and /sbin, /usr/libexec for
1072		all others.]
1073
1074
1075=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1076
1077The include file <bsd.subdir.mk> contains the default targets for building
1078subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1079clean, cleandir, depend, includes, install, lint, and tags.  For all of
1080the directories listed in ${SUBDIR}, the specified directory will be
1081visited and the target made.  There is also a default target which allows
1082the command "make subdir" where subdir is any directory listed in ${SUBDIR}.
1083
1084As a special case, the use of a token .WAIT as an entry in SUBDIR acts
1085as a synchronization barrier when multiple make jobs are run; subdirs
1086before the .WAIT must complete before any subdirs after .WAIT are
1087started.  See make(1) for some caveats on use of .WAIT and other
1088special sources.
1089
1090
1091=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1092
1093The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1094<bsd.lib.mk>.  It contains overrides that are used when building
1095the NetBSD source tree.
1096
1097The following variables control how various files are compiled/built.
1098(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1099
1100AR		Create, modify, and extract from archives.  [ar]
1101
1102ARFLAGS		Options to ${AR}.  [rl]
1103
1104CC		C compiler.  [cc]
1105
1106CFLAGS		Options to ${CC}.  [Usually -O or -O2]
1107
1108CPP		C Pre-Processor.  [cpp]
1109
1110CPPFLAGS	Options to ${CPP}.  []
1111
1112CPUFLAGS	Optimization flags for ${CC}
1113
1114CXX		C++ compiler.  [c++]
1115
1116CXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
1117
1118ELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
1119
1120FC		Fortran compiler.  [f77]
1121
1122FFLAGS		Options to {$FC}.  [-O]
1123
1124INSTALL		install(1) command.  [install]
1125
1126LEX		Lexical analyzer.  [lex]
1127
1128LFLAGS		Options to ${LEX}.  []
1129
1130LPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
1131
1132LD		Linker.  [ld]
1133
1134LDFLAGS		Options to ${LD}.  []
1135
1136LINT		C program verifier.  [lint]
1137
1138LINTFLAGS	Options to ${LINT}.  [-chapbxzF]
1139
1140LORDER		List dependencies for object files.  [lorder]
1141
1142MAKE		make(1).  [make]
1143
1144MKDEP		Construct Makefile dependency list.  [mkdep]
1145
1146NM		List symbols from object files.  [nm]
1147
1148PC		Pascal compiler.  [pc]  (Not present)
1149
1150PFLAGS		Options to ${PC}.  []
1151
1152OBJC		Objective C compiler.  [${CC}]
1153
1154OBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
1155
1156OBJCOPY		Copy and translate object files.  [objcopy]
1157
1158RANLIB		Generate index to archive.  [ranlib]
1159
1160SHELL		Shell.  [sh]
1161
1162SIZE		List section sizes and total size.  [size]
1163
1164STRIP		Discard symbols from object files.  [strip]
1165
1166TSORT		Topological sort of a directed graph.  [tsort -q]
1167
1168YACC		LALR(1) parser generator.  [yacc]
1169
1170YFLAGS		Options to ${YACC}.  []
1171
1172YHEADER		If defined, add "-d" to YFLAGS, and add dependencies
1173		from <file>.y to <file>.h and <file>.c, and add
1174		<foo>.h to CLEANFILES.
1175
1176YPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
1177
1178
1179The following variables are defined to commands to perform the
1180appropriate operation, with the default in [brackets].
1181(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
1182
1183TOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
1184
1185TOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
1186
1187TOOL_CAT		Concatenate and print files.  [cat]
1188
1189TOOL_CKSUM		Display file checksums.  [cksum]
1190
1191TOOL_COMPILE_ET		Error table compiler.  [compile_et]
1192
1193TOOL_CONFIG		Build kernel compilation directories.  [config]
1194
1195TOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
1196
1197TOOL_CTAGS		Create a tags file.  [ctags]
1198
1199TOOL_DB			Manipulate db(3) databases.  [db]
1200
1201TOOL_EQN		Format equations for groff.  [eqn]
1202
1203TOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
1204
1205TOOL_GENCAT		Generate NLS message catalogs.  [gencat]
1206
1207TOOL_GROFF		Front end for groff document formatting system.  [groff]
1208
1209TOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
1210
1211TOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
1212
1213TOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
1214
1215TOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
1216
1217TOOL_M4			M4 macro language processor.  [m4]
1218
1219TOOL_MAKEFS		Create file system image from directory tree.  [makefs]
1220
1221TOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
1222
1223TOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
1224
1225TOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
1226
1227TOOL_MENUC		Menu compiler.  [menuc]
1228
1229TOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
1230
1231TOOL_MKESDB		Make encoding scheme database.  [mkesdb]
1232
1233TOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
1234
1235TOOL_MKMAGIC		Create database for file(1).  [file]
1236
1237TOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
1238
1239TOOL_MSGC		Simple message list compiler.  [msgc]
1240
1241TOOL_MTREE		Map a directory hierarchy.  [mtree]
1242
1243TOOL_PAX		Manipulate file archives and copy directories.  [pax]
1244
1245TOOL_PIC		Compile pictures for groff.  [pic]
1246
1247TOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
1248
1249TOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
1250
1251TOOL_REFER		Preprocess bibliographic references for groff.  [refer]
1252
1253TOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
1254
1255TOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
1256
1257TOOL_ROFF_HTML		Generate HTML groff output.
1258			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
1259
1260TOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
1261
1262TOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
1263
1264TOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
1265
1266TOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
1267
1268TOOL_STAT		Display file status.  [stat]
1269
1270TOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
1271
1272TOOL_TBL		Format tables for groff.  [tbl]
1273
1274TOOL_UUDECODE		Uudecode a binary file.  [uudecode]
1275
1276TOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
1277
1278TOOL_ZIC		Time zone compiler.  [zic]
1279
1280
1281Other variables of note (incomplete list):
1282
1283WARNS		Crank up gcc warning options; the distinct levels are:
1284			WARNS=1
1285			WARNS=2
1286			WARNS=3
1287
1288FORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
1289WFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
1290		WFORMAT belongs in individual makefiles and/or
1291		Makefile.inc files.  (set WFORMAT=1 in individual
1292		makefiles if a program is not security critical and is
1293		doing bizarre things with format strings which would
1294		be even uglier if rewritten) FORMAT_AUDIT should go in
1295		mk.conf if you're doing format-string auditing.
1296		FORMAT_AUDIT may go away in time.
1297
1298
1299=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
1300
1301The include file <bsd.x11.mk> contains parameters and targets for
1302cross-building X11R6 from ${X11SRCDIR.xc}.
1303It should be included after the general Makefile contents but before
1304the include files such as <bsd.prog.mk> and <bsd.lib.mk>.
1305
1306It provides the following targets:
1307	.man.1 .man.3 .man.4 .man.5 .man.7:
1308		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1309		these rules convert from X11R6's manual page source
1310		into an mdoc.old source file.
1311	cleanx11man:
1312		Clean up the mdoc.old files generated by the above.
1313
1314It sets the following variables:
1315
1316BINDIR			Set to ${X11BINDIR}.
1317			To override, define after including <bsd.x11.mk>
1318
1319LIBDIR			Set to ${X11USRLIBDIR}.
1320			To override, define after including <bsd.x11.mk>
1321
1322MANDIR			Set to ${X11MANDIR}.
1323			To override, define after including <bsd.x11.mk>
1324
1325CPPFLAGS		Appended with definitions to include from
1326			${DESTDIR}${X11INCDIR}
1327
1328LDFLAGS			Appended with definitions to link from
1329			${DESTDIR}${X11USRLIBDIR}
1330
1331X11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
1332
1333X11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
1334
1335X11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
1336
1337X11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
1338
1339X11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
1340
1341X11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
1342
1343X11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
1344
1345X11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
1346
1347X11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
1348
1349It uses the following variables:
1350
1351APPDEFS			List of app-default files to install.
1352
1353CPPSCRIPTS		List of files/scripts to run through cpp(1)
1354			and then ${X11TOOL_UNXCOMM}.  The source files
1355			have a `.cpp' suffix, the generated files do not.
1356
1357CPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
1358
1359CPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
1360
1361
1362=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1363